# ApifyDatasetClient<!-- -->

An Apify platform implementation of the dataset client.

### Hierarchy

* [DatasetClientPpeMixin](https://docs.apify.com/sdk/python/reference/class/DatasetClientPpeMixin.md)
  * *ApifyDatasetClient*

## Index[](#Index)

### Methods

* [\_\_init\_\_](https://docs.apify.com/sdk/python/reference/class/ApifyDatasetClient.md#__init__)
* [drop](https://docs.apify.com/sdk/python/reference/class/ApifyDatasetClient.md#drop)
* [get_data](https://docs.apify.com/sdk/python/reference/class/ApifyDatasetClient.md#get_data)
* [get_metadata](https://docs.apify.com/sdk/python/reference/class/ApifyDatasetClient.md#get_metadata)
* [iterate_items](https://docs.apify.com/sdk/python/reference/class/ApifyDatasetClient.md#iterate_items)
* [open](https://docs.apify.com/sdk/python/reference/class/ApifyDatasetClient.md#open)
* [purge](https://docs.apify.com/sdk/python/reference/class/ApifyDatasetClient.md#purge)
* [push_data](https://docs.apify.com/sdk/python/reference/class/ApifyDatasetClient.md#push_data)

## Methods<!-- -->[](#Methods)

### [](#__init__)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_dataset_client.py#L42)\_\_init\_\_

* **\_\_init\_\_**(\*, api_client): None

- Overrides [DatasetClientPpeMixin.\_\_init\_\_](https://docs.apify.com/sdk/python/reference/class/DatasetClientPpeMixin.md#__init__)

  Initialize a new instance.

  Preferably use the `ApifyDatasetClient.open` class method to create a new instance.

  ***

  #### Parameters

  * ##### keyword-onlyapi_client: DatasetClientAsync

  #### Returns None

### [](#drop)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_dataset_client.py#L130)drop

* async **drop**(): None

- #### Returns None

### [](#get_data)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_dataset_client.py#L152)get_data

* async **get_data**(\*, offset, limit, clean, desc, fields, omit, unwind, skip_empty, skip_hidden, flatten, view): DatasetItemsListPage

- #### Parameters

  * ##### optionalkeyword-onlyoffset: int = <!-- -->0
  * ##### optionalkeyword-onlylimit: int | None = <!-- -->999_999_999_999
  * ##### optionalkeyword-onlyclean: bool = <!-- -->False
  * ##### optionalkeyword-onlydesc: bool = <!-- -->False
  * ##### optionalkeyword-onlyfields: list\[str] | None = <!-- -->None
  * ##### optionalkeyword-onlyomit: list\[str] | None = <!-- -->None
  * ##### optionalkeyword-onlyunwind: list\[str] | None = <!-- -->None
  * ##### optionalkeyword-onlyskip_empty: bool = <!-- -->False
  * ##### optionalkeyword-onlyskip_hidden: bool = <!-- -->False
  * ##### optionalkeyword-onlyflatten: list\[str] | None = <!-- -->None
  * ##### optionalkeyword-onlyview: str | None = <!-- -->None

  #### Returns DatasetItemsListPage

### [](#get_metadata)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_dataset_client.py#L58)get_metadata

* async **get_metadata**(): DatasetMetadata

- #### Returns DatasetMetadata

### [](#iterate_items)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_dataset_client.py#L183)iterate_items

* async **iterate_items**(\*, offset, limit, clean, desc, fields, omit, unwind, skip_empty, skip_hidden): AsyncIterator\[dict]

- #### Parameters

  * ##### optionalkeyword-onlyoffset: int = <!-- -->0
  * ##### optionalkeyword-onlylimit: int | None = <!-- -->None
  * ##### optionalkeyword-onlyclean: bool = <!-- -->False
  * ##### optionalkeyword-onlydesc: bool = <!-- -->False
  * ##### optionalkeyword-onlyfields: list\[str] | None = <!-- -->None
  * ##### optionalkeyword-onlyomit: list\[str] | None = <!-- -->None
  * ##### optionalkeyword-onlyunwind: list\[str] | None = <!-- -->None
  * ##### optionalkeyword-onlyskip_empty: bool = <!-- -->False
  * ##### optionalkeyword-onlyskip_hidden: bool = <!-- -->False

  #### Returns AsyncIterator\[dict]

### [](#open)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_dataset_client.py#L74)open

* async **open**(\*, id, name, alias, configuration): [ApifyDatasetClient](https://docs.apify.com/sdk/python/reference/class/ApifyDatasetClient.md)

- Open an Apify dataset client.

  This method creates and initializes a new instance of the Apify dataset client. It handles authentication, storage lookup/creation, and metadata retrieval.

  ***

  #### Parameters

  * ##### keyword-onlyid: str | None

    The ID of the dataset to open. If provided, searches for existing dataset by ID. Mutually exclusive with name and alias.

  * ##### keyword-onlyname: str | None

    The name of the dataset to open (global scope, persists across runs). Mutually exclusive with id and alias.

  * ##### keyword-onlyalias: str | None

    The alias of the dataset to open (run scope, creates unnamed storage). Mutually exclusive with id and name.

  * ##### keyword-onlyconfiguration: [Configuration](https://docs.apify.com/sdk/python/reference/class/Configuration.md)

    The configuration object containing API credentials and settings. Must include a valid `token` and `api_base_url`. May also contain a `default_dataset_id` for fallback when neither `id`, `name`, nor `alias` is provided.

  #### Returns [ApifyDatasetClient](https://docs.apify.com/sdk/python/reference/class/ApifyDatasetClient.md)

  An instance for the opened or created storage client.

### [](#purge)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_dataset_client.py#L123)purge

* async **purge**(): None

- #### Returns None

### [](#push_data)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_dataset_client.py#L134)push_data

* async **push_data**(data): None

- #### Parameters

  * ##### data: Sequence\[Mapping\[str, JsonSerializable]] | Mapping\[str, JsonSerializable]

  #### Returns None
