eegdash.http_api_client

HTTP API client for EEGDash REST API.

Functions

get_client([api_url, database, auth_token])

Get an API client instance.

Classes

EEGDashAPIClient([api_url, database, auth_token])

HTTP client for EEGDash API.

class eegdash.http_api_client.EEGDashAPIClient(api_url: str | None = None, database: str = 'eegdash', auth_token: str | None = None)

Bases: object

HTTP client for EEGDash API.

Parameters:

• api_url (str, optional) – Base API URL. Default: https://data.eegdash.org

• database (str, default "eegdash") – Database name (“eegdash”, “eegdash_staging”, or “eegdash_v1”).

• auth_token (str, optional) – Auth token for admin write operations.

find(query: dict[str, Any] | None = None, limit: int | None = None, skip: int | None = None, **kwargs) → list[dict[str, Any]]

Query records. Auto-paginates if no limit specified.

A dataset filter naming an OpenNeuro id that returns nothing is retried once against its NEMAR twin, so code written against a ds id keeps working after that id is retired in favour of the NEMAR re-host. Ids that still resolve are never rewritten.

find_one(query: dict[str, Any] | None = None, **kwargs) → dict[str, Any] | None

Find a single record.

get_dataset(dataset_id: str) → dict[str, Any] | None

Fetch a dataset document by ID.

A retired OpenNeuro id falls back to its NEMAR twin (see _nemar_twin()) so existing references keep resolving.

find_datasets(query: dict[str, Any] | None = None, limit: int = 1000) → list[dict[str, Any]]

Find datasets matching query.

A dataset_id filter that returns nothing is retried against its NEMAR twin, mirroring find().

count_documents(query: dict[str, Any] | None = None, **kwargs) → int

Count documents matching query.

A zero count for an OpenNeuro dataset id is retried against its NEMAR twin, mirroring find().

insert_one(record: dict[str, Any]) → str

Insert single record (requires auth).

insert_many(records: list[dict[str, Any]]) → int

Insert multiple records (requires auth).

update_many(query: dict[str, Any], update: dict[str, Any]) → tuple[int, int]

Update records matching query (requires auth).

Parameters:

• query (dict) – Filter query to match records.

• update (dict) – Fields to set (wrapped in $set automatically).

Return type:

tuple of (matched_count, modified_count)

update_dataset(dataset_id: str, update: dict[str, Any]) → int

Update dataset metadata (requires auth).

Parameters:

• dataset_id (str) – The dataset identifier.

• update (dict) – Fields to update (will be wrapped in $set automatically).

Returns:

Modified count (1 or 0).

Return type:

int

upsert_many(records: list[dict[str, Any]]) → dict[str, int]

Upsert multiple records (requires auth).

New endpoint that uses bulk upsert based on dataset+bidspath.

eegdash.http_api_client.get_client(api_url: str | None = None, database: str = 'eegdash', auth_token: str | None = None) → EEGDashAPIClient

Get an API client instance.