Skip to main content

Apify API client for Python

Project description

Apify API client for Python

The Apify API Client for Python is the official library to access the Apify API from your Python applications. It provides useful features like automatic retries and convenience functions to improve your experience with the Apify API.

If you want to develop Apify Actors in Python, check out the Apify SDK for Python instead.

Installation

Requires Python 3.8+

You can install the package from its PyPI listing. To do that, simply run pip install apify-client in your terminal.

Usage

For usage instructions, check the documentation on Apify Docs.

Quick Start

from apify_client import ApifyClient

apify_client = ApifyClient('MY-APIFY-TOKEN')

# Start an Actor and wait for it to finish
actor_call = apify_client.actor('john-doe/my-cool-actor').call()

# Fetch results from the Actor's default dataset
dataset_items = apify_client.dataset(actor_call['defaultDatasetId']).list_items().items

Features

Besides greatly simplifying the process of querying the Apify API, the client provides other useful features.

Automatic parsing and error handling

Based on the endpoint, the client automatically extracts the relevant data and returns it in the expected format. Date strings are automatically converted to datetime.datetime objects. For exceptions, we throw an ApifyApiError, which wraps the plain JSON errors returned by API and enriches them with other context for easier debugging.

Retries with exponential backoff

Network communication sometimes fails. The client will automatically retry requests that failed due to a network error, an internal error of the Apify API (HTTP 500+) or rate limit error (HTTP 429). By default, it will retry up to 8 times. First retry will be attempted after ~500ms, second after ~1000ms and so on. You can configure those parameters using the max_retries and min_delay_between_retries_millis options of the ApifyClient constructor.

Support for asynchronous usage

Starting with version 1.0.0, the package offers an asynchronous version of the client, ApifyClientAsync, which allows you to work with the Apify API in an asynchronous way, using the standard async/await syntax.

Convenience functions and options

Some actions can't be performed by the API itself, such as indefinite waiting for an Actor run to finish (because of network timeouts). The client provides convenient call() and wait_for_finish() functions that do that. Key-value store records can be retrieved as objects, buffers or streams via the respective options, dataset items can be fetched as individual objects or serialized data and we plan to add better stream support and async iterators.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apify_client-1.12.0.tar.gz (346.9 kB view details)

Uploaded Source

Built Distribution

apify_client-1.12.0-py3-none-any.whl (82.8 kB view details)

Uploaded Python 3

File details

Details for the file apify_client-1.12.0.tar.gz.

File metadata

  • Download URL: apify_client-1.12.0.tar.gz
  • Upload date:
  • Size: 346.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for apify_client-1.12.0.tar.gz
Algorithm Hash digest
SHA256 6b711be930d746a828a456b809abe882cf9e851e9571e5d8307591726e753ea7
MD5 bdbe437ce94052837acad97e02867a89
BLAKE2b-256 739493bc6eca322e642a9f879b0c77005a83ea3977389f6462e1a6a784574d0a

See more details on using hashes here.

Provenance

The following attestation bundles were made for apify_client-1.12.0.tar.gz:

Publisher: release.yaml on apify/apify-client-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file apify_client-1.12.0-py3-none-any.whl.

File metadata

  • Download URL: apify_client-1.12.0-py3-none-any.whl
  • Upload date:
  • Size: 82.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for apify_client-1.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be24c4a069af4d9b362452ae4d973142187633bbb296f0f6a85021cb4b0bb611
MD5 16de3f77fc107f77c5b5fa80a055e181
BLAKE2b-256 e793f1e509e4b1c090fdd2f507caf3e1455067f4ca6d4cbbaf32fbf4b7a2139f

See more details on using hashes here.

Provenance

The following attestation bundles were made for apify_client-1.12.0-py3-none-any.whl:

Publisher: release.yaml on apify/apify-client-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page