ApifyClient

The Apify API client.

Hierarchy

• _BaseApifyClient
  • ApifyClient

Index

Methods

• __init__
• actor
• actors
• build
• builds
• dataset
• datasets
• key_value_store
• key_value_stores
• log
• request_queue
• request_queues
• run
• runs
• schedule
• schedules
• store
• task
• tasks
• user
• webhook
• webhook_dispatch
• webhook_dispatches
• webhooks

Properties

• http_client

Methods

__init__

• __init__(token, *, api_url, api_public_url, max_retries, min_delay_between_retries_millis, timeout_secs): None

• Overrides _BaseApifyClient.__init__

  Initialize a new instance.

  ---

  Parameters

  • optionaltoken: str | None = None

    The Apify API token.

  • optionalkeyword-onlyapi_url: str | None = None

    The URL of the Apify API server to which to connect. Defaults to https://api.apify.com. It can be an internal URL that is not globally accessible, in such case api_public_url should be set as well.

  • optionalkeyword-onlyapi_public_url: str | None = None

    The globally accessible URL of the Apify API server. It should be set only if the api_url is an internal URL that is not globally accessible.

  • optionalkeyword-onlymax_retries: int | None = 8

    How many times to retry a failed request at most.

  • optionalkeyword-onlymin_delay_between_retries_millis: int | None = 500

    How long will the client wait between retrying requests (increases exponentially from this value).

  • optionalkeyword-onlytimeout_secs: int | None = DEFAULT_TIMEOUT

    The socket timeout of the HTTP requests sent to the Apify API.

  Returns None

actor

• actor(actor_id): ActorClient

• Retrieve the sub-client for manipulating a single Actor.

  ---

  Parameters

  • actor_id: str

    ID of the Actor to be manipulated.

  Returns ActorClient

actors

• actors(): ActorCollectionClient

• Retrieve the sub-client for manipulating Actors.

  ---

  Returns ActorCollectionClient

build

• build(build_id): BuildClient

• Retrieve the sub-client for manipulating a single Actor build.

  ---

  Parameters

  • build_id: str

    ID of the Actor build to be manipulated.

  Returns BuildClient

builds

• builds(): BuildCollectionClient

• Retrieve the sub-client for querying multiple builds of a user.

  ---

  Returns BuildCollectionClient

dataset

• dataset(dataset_id): DatasetClient

• Retrieve the sub-client for manipulating a single dataset.

  ---

  Parameters

  • dataset_id: str

    ID of the dataset to be manipulated.

  Returns DatasetClient

datasets

• datasets(): DatasetCollectionClient

• Retrieve the sub-client for manipulating datasets.

  ---

  Returns DatasetCollectionClient

key_value_store

• key_value_store(key_value_store_id): KeyValueStoreClient

• Retrieve the sub-client for manipulating a single key-value store.

  ---

  Parameters

  • key_value_store_id: str

    ID of the key-value store to be manipulated.

  Returns KeyValueStoreClient

key_value_stores

• key_value_stores(): KeyValueStoreCollectionClient

• Retrieve the sub-client for manipulating key-value stores.

  ---

  Returns KeyValueStoreCollectionClient

log

• log(build_or_run_id): LogClient

• Retrieve the sub-client for retrieving logs.

  ---

  Parameters

  • build_or_run_id: str

    ID of the Actor build or run for which to access the log.

  Returns LogClient

request_queue

• request_queue(request_queue_id, *, client_key): RequestQueueClient

• Retrieve the sub-client for manipulating a single request queue.

  ---

  Parameters

  • request_queue_id: str

    ID of the request queue to be manipulated.

  • optionalkeyword-onlyclient_key: str | None = None

    A unique identifier of the client accessing the request queue.

  Returns RequestQueueClient

request_queues

• request_queues(): RequestQueueCollectionClient

• Retrieve the sub-client for manipulating request queues.

  ---

  Returns RequestQueueCollectionClient

run

• run(run_id): RunClient

• Retrieve the sub-client for manipulating a single Actor run.

  ---

  Parameters

  • run_id: str

    ID of the Actor run to be manipulated.

  Returns RunClient

runs

• runs(): RunCollectionClient

• Retrieve the sub-client for querying multiple Actor runs of a user.

  ---

  Returns RunCollectionClient

schedule

• schedule(schedule_id): ScheduleClient

• Retrieve the sub-client for manipulating a single schedule.

  ---

  Parameters

  • schedule_id: str

    ID of the schedule to be manipulated.

  Returns ScheduleClient

schedules

• schedules(): ScheduleCollectionClient

• Retrieve the sub-client for manipulating schedules.

  ---

  Returns ScheduleCollectionClient

store

• store(): StoreCollectionClient

• Retrieve the sub-client for Apify store.

  ---

  Returns StoreCollectionClient

task

• task(task_id): TaskClient

• Retrieve the sub-client for manipulating a single task.

  ---

  Parameters

  • task_id: str

    ID of the task to be manipulated.

  Returns TaskClient

tasks

• tasks(): TaskCollectionClient

• Retrieve the sub-client for manipulating tasks.

  ---

  Returns TaskCollectionClient

user

• user(user_id): UserClient

• Retrieve the sub-client for querying users.

  ---

  Parameters

  • optionaluser_id: str | None = None

    ID of user to be queried. If None, queries the user belonging to the token supplied to the client.

  Returns UserClient

webhook

• webhook(webhook_id): WebhookClient

• Retrieve the sub-client for manipulating a single webhook.

  ---

  Parameters

  • webhook_id: str

    ID of the webhook to be manipulated.

  Returns WebhookClient

webhook_dispatch

• webhook_dispatch(webhook_dispatch_id): WebhookDispatchClient

• Retrieve the sub-client for accessing a single webhook dispatch.

  ---

  Parameters

  • webhook_dispatch_id: str

    ID of the webhook dispatch to access.

  Returns WebhookDispatchClient

webhook_dispatches

• webhook_dispatches(): WebhookDispatchCollectionClient

• Retrieve the sub-client for querying multiple webhook dispatches of a user.

  ---

  Returns WebhookDispatchCollectionClient

webhooks

• webhooks(): WebhookCollectionClient

• Retrieve the sub-client for querying multiple webhooks of a user.

  ---

  Returns WebhookCollectionClient

Properties

http_client

http_client: HTTPClient | HTTPClientAsync

Overrides _BaseApifyClient.http_client