Version: 2.9Constructors
- new ApifyClient(options): ApifyClient
Parameters
options: ApifyClientOptions = {}
Returns ApifyClient
Methods
Parameters
Returns ActorClient
- actors(): ActorCollectionClient
Returns ActorCollectionClient
Parameters
Returns BuildClient
- builds(): BuildCollectionClient
Returns BuildCollectionClient
- dataset<Data>(id): DatasetClient<Data>
Type parameters
- Data: Record<string | number, any> = Record<string | number, unknown>
Parameters
Returns DatasetClient<Data>
- datasets(): DatasetCollectionClient
Returns DatasetCollectionClient
- keyValueStore(id): KeyValueStoreClient
Parameters
Returns KeyValueStoreClient
- keyValueStores(): KeyValueStoreCollectionClient
Returns KeyValueStoreCollectionClient
- log(buildOrRunId): LogClient
Parameters
Returns LogClient
- requestQueue(id, options): RequestQueueClient
Parameters
id: string
options: RequestQueueUserOptions = {}
Returns RequestQueueClient
- requestQueues(): RequestQueueCollectionClient
Returns RequestQueueCollectionClient
Parameters
Returns RunClient
- runs(): RunCollectionClient
Returns RunCollectionClient
- schedule(id): ScheduleClient
Parameters
Returns ScheduleClient
- schedules(): ScheduleCollectionClient
Returns ScheduleCollectionClient
- setStatusMessage(message, options): Promise<void>
Parameters
message: string
options: SetStatusMessageOptionsoptional
Returns Promise<void>
- store(): StoreCollectionClient
Returns StoreCollectionClient
Parameters
Returns TaskClient
- tasks(): TaskCollectionClient
Returns TaskCollectionClient
Parameters
id: string = ME_USER_NAME_PLACEHOLDER
Returns UserClient
- webhook(id): WebhookClient
Parameters
Returns WebhookClient
- webhookDispatch(id): WebhookDispatchClient
Parameters
Returns WebhookDispatchClient
- webhookDispatches(): WebhookDispatchCollectionClient
Returns WebhookDispatchCollectionClient
- webhooks(): WebhookCollectionClient
Returns WebhookCollectionClient
ApifyClient is the official library to access Apify API from your JavaScript applications. It runs both in Node.js and browser.