Skip to main content

ApifyClientAsync

The asynchronous version of the Apify API client.

Index

Constructors

__init__

  • __init__(token, *, api_url, max_retries, min_delay_between_retries_millis, timeout_secs): None
  • A default constructor.


    Parameters

    • token: str | None = None
    • keyword-onlyapi_url: str | None = None
    • keyword-onlymax_retries: int | None = 8
    • keyword-onlymin_delay_between_retries_millis: int | None = 500
    • keyword-onlytimeout_secs: int | None = 360

    Returns None

Methods

actor

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


    Parameters

    • actor_id: str

    Returns ActorClientAsync

actors

build

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


    Parameters

    • build_id: str

    Returns BuildClientAsync

builds

dataset

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


    Parameters

    • dataset_id: str

    Returns DatasetClientAsync

datasets

key_value_store

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


    Parameters

    • key_value_store_id: str

    Returns KeyValueStoreClientAsync

key_value_stores

log

  • Retrieve the sub-client for retrieving logs.


    Parameters

    • build_or_run_id: str

    Returns LogClientAsync

request_queue

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


    Parameters

    • request_queue_id: str
    • keyword-onlyclient_key: str | None = None

    Returns RequestQueueClientAsync

request_queues

run

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


    Parameters

    • run_id: str

    Returns RunClientAsync

runs

schedule

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


    Parameters

    • schedule_id: str

    Returns ScheduleClientAsync

schedules

store

task

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


    Parameters

    • task_id: str

    Returns TaskClientAsync

tasks

user

  • Retrieve the sub-client for querying users.


    Parameters

    • user_id: str | None = None

    Returns UserClientAsync

webhook

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


    Parameters

    • webhook_id: str

    Returns WebhookClientAsync

webhook_dispatch

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


    Parameters

    • webhook_dispatch_id: str

    Returns WebhookDispatchClientAsync

webhook_dispatches

webhooks