DatasetClient
Index
Methods
delete
Delete the dataset.
https://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset
Returns None
download_items
Get the items in the dataset as raw bytes.
Deprecated: this function is a deprecated alias of
get_items_as_bytes. It will be removed in a future version.https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items
Parameters
optionalkeyword-onlyitem_format: str = 'json'
Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss. The default value is json.
optionalkeyword-onlyoffset: int | None = None
Number of items that should be skipped at the start. The default value is 0.
optionalkeyword-onlylimit: int | None = None
Maximum number of items to return. By default there is no limit.
optionalkeyword-onlydesc: bool | None = None
By default, results are returned in the same order as they were stored. To reverse the order, set this parameter to True.
optionalkeyword-onlyclean: bool | None = None
If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters. Note that since some objects might be skipped from the output, that the result might contain less items than the limit value.
optionalkeyword-onlybom: bool | None = None
All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want to override this default behavior, specify bom=True query parameter to include the BOM or bom=False to skip it.
optionalkeyword-onlydelimiter: str | None = None
A delimiter character for CSV files. The default delimiter is a simple comma (,).
optionalkeyword-onlyfields: list[str] | None = None
A list of fields which should be picked from the items, only these fields will remain in the resulting record objects. Note that the fields in the outputted items are sorted the same way as they are specified in the fields parameter. You can use this feature to effectively fix the output format.
optionalkeyword-onlyomit: list[str] | None = None
A list of fields which should be omitted from the items.
optionalkeyword-onlyunwind: (str | list[str]) | None = None
A list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. If the field is an array then every element of the array will become a separate record and merged with parent object. If the unwound field is an object then it is merged with the parent object. If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object, then the item gets preserved as it is. Note that the unwound items ignore the desc parameter.
optionalkeyword-onlyskip_empty: bool | None = None
If True, then empty items are skipped from the output. Note that if used, the results might contain less items than the limit value.
optionalkeyword-onlyskip_header_row: bool | None = None
If True, then header row in the csv format is skipped.
optionalkeyword-onlyskip_hidden: bool | None = None
If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.
optionalkeyword-onlyxml_root: str | None = None
Overrides default root element name of xml output. By default the root element is items.
optionalkeyword-onlyxml_row: str | None = None
Overrides default element name that wraps each page or page function result object in xml output. By default the element name is item.
optionalkeyword-onlyflatten: list[str] | None = None
A list of fields that should be flattened.
Returns bytes
get
Retrieve the dataset.
https://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset
Returns dict | None
get_items_as_bytes
Get the items in the dataset as raw bytes.
https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items
Parameters
optionalkeyword-onlyitem_format: str = 'json'
Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss. The default value is json.
optionalkeyword-onlyoffset: int | None = None
Number of items that should be skipped at the start. The default value is 0.
optionalkeyword-onlylimit: int | None = None
Maximum number of items to return. By default there is no limit.
optionalkeyword-onlydesc: bool | None = None
By default, results are returned in the same order as they were stored. To reverse the order, set this parameter to True.
optionalkeyword-onlyclean: bool | None = None
If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters. Note that since some objects might be skipped from the output, that the result might contain less items than the limit value.
optionalkeyword-onlybom: bool | None = None
All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want to override this default behavior, specify bom=True query parameter to include the BOM or bom=False to skip it.
optionalkeyword-onlydelimiter: str | None = None
A delimiter character for CSV files. The default delimiter is a simple comma (,).
optionalkeyword-onlyfields: list[str] | None = None
A list of fields which should be picked from the items, only these fields will remain in the resulting record objects. Note that the fields in the outputted items are sorted the same way as they are specified in the fields parameter. You can use this feature to effectively fix the output format. You can use this feature to effectively fix the output format.
optionalkeyword-onlyomit: list[str] | None = None
A list of fields which should be omitted from the items.
optionalkeyword-onlyunwind: (str | list[str]) | None = None
A list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. If the field is an array then every element of the array will become a separate record and merged with parent object. If the unwound field is an object then it is merged with the parent object. If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object, then the item gets preserved as it is. Note that the unwound items ignore the desc parameter.
optionalkeyword-onlyskip_empty: bool | None = None
If True, then empty items are skipped from the output. Note that if used, the results might contain less items than the limit value.
optionalkeyword-onlyskip_header_row: bool | None = None
If True, then header row in the csv format is skipped.
optionalkeyword-onlyskip_hidden: bool | None = None
If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.
optionalkeyword-onlyxml_root: str | None = None
Overrides default root element name of xml output. By default the root element is items.
optionalkeyword-onlyxml_row: str | None = None
Overrides default element name that wraps each page or page function result object in xml output. By default the element name is item.
optionalkeyword-onlyflatten: list[str] | None = None
A list of fields that should be flattened.
Returns bytes
get_statistics
Get the dataset statistics.
https://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get
Returns dict | None
iterate_items
Iterate over the items in the dataset.
https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items
Parameters
optionalkeyword-onlyoffset: int = 0
Number of items that should be skipped at the start. The default value is 0.
optionalkeyword-onlylimit: int | None = None
Maximum number of items to return. By default there is no limit.
optionalkeyword-onlyclean: bool | None = None
If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters. Note that since some objects might be skipped from the output, that the result might contain less items than the limit value.
optionalkeyword-onlydesc: bool | None = None
By default, results are returned in the same order as they were stored. To reverse the order, set this parameter to True.
optionalkeyword-onlyfields: list[str] | None = None
A list of fields which should be picked from the items, only these fields will remain in the resulting record objects. Note that the fields in the outputted items are sorted the same way as they are specified in the fields parameter. You can use this feature to effectively fix the output format.
optionalkeyword-onlyomit: list[str] | None = None
A list of fields which should be omitted from the items.
optionalkeyword-onlyunwind: (str | list[str]) | None = None
A list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. If the field is an array then every element of the array will become a separate record and merged with parent object. If the unwound field is an object then it is merged with the parent object. If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object, then the item gets preserved as it is. Note that the unwound items ignore the desc parameter.
optionalkeyword-onlyskip_empty: bool | None = None
If True, then empty items are skipped from the output. Note that if used, the results might contain less items than the limit value.
optionalkeyword-onlyskip_hidden: bool | None = None
If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.
Returns Iterator[dict]
list_items
List the items of the dataset.
https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items
Parameters
optionalkeyword-onlyoffset: int | None = None
Number of items that should be skipped at the start. The default value is 0.
optionalkeyword-onlylimit: int | None = None
Maximum number of items to return. By default there is no limit.
optionalkeyword-onlyclean: bool | None = None
If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters. Note that since some objects might be skipped from the output, that the result might contain less items than the limit value.
optionalkeyword-onlydesc: bool | None = None
By default, results are returned in the same order as they were stored. To reverse the order, set this parameter to True.
optionalkeyword-onlyfields: list[str] | None = None
A list of fields which should be picked from the items, only these fields will remain in the resulting record objects. Note that the fields in the outputted items are sorted the same way as they are specified in the fields parameter. You can use this feature to effectively fix the output format.
optionalkeyword-onlyomit: list[str] | None = None
A list of fields which should be omitted from the items.
optionalkeyword-onlyunwind: (str | list[str]) | None = None
A list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. If the field is an array then every element of the array will become a separate record and merged with parent object. If the unwound field is an object then it is merged with the parent object. If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object, then the item gets preserved as it is. Note that the unwound items ignore the desc parameter.
optionalkeyword-onlyskip_empty: bool | None = None
If True, then empty items are skipped from the output. Note that if used, the results might contain less items than the limit value.
optionalkeyword-onlyskip_hidden: bool | None = None
If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.
optionalkeyword-onlyflatten: list[str] | None = None
A list of fields that should be flattened.
optionalkeyword-onlyview: str | None = None
Name of the dataset view to be used.
Returns ListPage
push_items
Push items to the dataset.
https://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items
Parameters
items: JSONSerializable
The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list of strings or dictionaries.
Returns None
stream_items
Retrieve the items in the dataset as a stream.
https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items
Parameters
optionalkeyword-onlyitem_format: str = 'json'
Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss. The default value is json.
optionalkeyword-onlyoffset: int | None = None
Number of items that should be skipped at the start. The default value is 0.
optionalkeyword-onlylimit: int | None = None
Maximum number of items to return. By default there is no limit.
optionalkeyword-onlydesc: bool | None = None
By default, results are returned in the same order as they were stored. To reverse the order, set this parameter to True.
optionalkeyword-onlyclean: bool | None = None
If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters. Note that since some objects might be skipped from the output, that the result might contain less items than the limit value.
optionalkeyword-onlybom: bool | None = None
All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want to override this default behavior, specify bom=True query parameter to include the BOM or bom=False to skip it.
optionalkeyword-onlydelimiter: str | None = None
A delimiter character for CSV files. The default delimiter is a simple comma (,).
optionalkeyword-onlyfields: list[str] | None = None
A list of fields which should be picked from the items, only these fields will remain in the resulting record objects. Note that the fields in the outputted items are sorted the same way as they are specified in the fields parameter. You can use this feature to effectively fix the output format. You can use this feature to effectively fix the output format.
optionalkeyword-onlyomit: list[str] | None = None
A list of fields which should be omitted from the items.
optionalkeyword-onlyunwind: (str | list[str]) | None = None
A list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. If the field is an array then every element of the array will become a separate record and merged with parent object. If the unwound field is an object then it is merged with the parent object. If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object, then the item gets preserved as it is. Note that the unwound items ignore the desc parameter.
optionalkeyword-onlyskip_empty: bool | None = None
If True, then empty items are skipped from the output. Note that if used, the results might contain less items than the limit value.
optionalkeyword-onlyskip_header_row: bool | None = None
If True, then header row in the csv format is skipped.
optionalkeyword-onlyskip_hidden: bool | None = None
If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.
optionalkeyword-onlyxml_root: str | None = None
Overrides default root element name of xml output. By default the root element is items.
optionalkeyword-onlyxml_row: str | None = None
Overrides default element name that wraps each page or page function result object in xml output. By default the element name is item.
Returns Iterator[httpx.Response]
update
Update the dataset with specified fields.
https://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset
Parameters
optionalkeyword-onlyname: str | None = None
The new name for the dataset.
Returns dict
Sub-client for manipulating a single dataset.