Skip to main content

Module clients

Module clients 

Source
Expand description

Resource clients.

Each submodule provides a strongly-typed client for one Apify API resource. Clients are obtained from ApifyClient accessor methods rather than constructed directly, so their constructors are crate-private.

Modules§

actor
Client for a single Actor (/v2/actors/{actorId}).
actor_collection
Client for the Actor collection endpoint (/v2/actors).
actor_env_var
Client for a single Actor-version environment variable.
actor_env_var_collection
Client for an Actor version’s environment variable collection.
actor_version
Client for a single Actor version (/v2/actors/{actorId}/versions/{versionNumber}).
actor_version_collection
Client for an Actor’s version collection (/v2/actors/{actorId}/versions).
build
Client for a single Actor build (/v2/actor-builds/{buildId}).
build_collection
Client for an Actor-build collection (/v2/actor-builds, /v2/actors/{id}/builds).
dataset
Client for a single dataset (/v2/datasets/{datasetId} and run-nested variants).
dataset_collection
Client for the dataset collection (/v2/datasets).
key_value_store
Client for a single key-value store (/v2/key-value-stores/{storeId} and variants).
key_value_store_collection
Client for the key-value store collection (/v2/key-value-stores).
log
Client for accessing a run’s or build’s log.
request_queue
Client for a single request queue (/v2/request-queues/{queueId} and variants).
request_queue_collection
Client for the request queue collection (/v2/request-queues).
run
Client for a single Actor run (/v2/actor-runs/{runId} and nested routes).
run_collection
Client for an Actor-run collection (/v2/actor-runs, /v2/actors/{id}/runs, etc.).
schedule
Client for a single schedule (/v2/schedules/{scheduleId}).
schedule_collection
Client for the schedule collection (/v2/schedules).
store_collection
Client for browsing the Apify Store (/v2/store).
task
Client for a single Actor task (/v2/actor-tasks/{actorTaskId}).
task_collection
Client for the Actor task collection (/v2/actor-tasks).
user
Client for a user (/v2/users/{userId} or /v2/users/me).
webhook
Client for a single webhook (/v2/webhooks/{webhookId}).
webhook_collection
Client for the webhook collection (/v2/webhooks, /v2/actors/{id}/webhooks, etc.).
webhook_dispatch
Client for a single webhook dispatch (/v2/webhook-dispatches/{dispatchId}).
webhook_dispatch_collection
Client for the webhook dispatch collection (/v2/webhook-dispatches).