ApifyClient

ApifyClient is the official library to access Apify API from your JavaScript applications. It runs both in Node.js and browser.

Index

Constructors

• constructor

Properties

• baseUrl
• httpClient
• logger
• stats
• token

Methods

• actor
• actors
• build
• builds
• dataset
• datasets
• keyValueStore
• keyValueStores
• log
• requestQueue
• requestQueues
• run
• runs
• schedule
• schedules
• setStatusMessage
• store
• task
• tasks
• user
• webhook
• webhookDispatch
• webhookDispatches
• webhooks

Constructors

constructor

• new ApifyClient(options?: ApifyClientOptions): ApifyClient

• Parameters

  • options: ApifyClientOptions = {}

  Returns ApifyClient

Properties

baseUrl

baseUrl: string

httpClient

httpClient: HttpClient

logger

logger: Log

stats

stats: Statistics

optionaltoken

token?: string

Methods

actor

• actor(id: string): ActorClient

• https://docs.apify.com/api/v2#/reference/actors/actor-object

  ---

  Parameters

  • id: string

  Returns ActorClient

actors

• actors(): ActorCollectionClient

• https://docs.apify.com/api/v2#/reference/actors/actor-collection

  ---

  Returns ActorCollectionClient

build

• build(id: string): BuildClient

• https://docs.apify.com/api/v2#/reference/actor-builds/build-object

  ---

  Parameters

  • id: string

  Returns BuildClient

builds

• builds(): BuildCollectionClient

• https://docs.apify.com/api/v2#/reference/actor-builds/build-collection

  ---

  Returns BuildCollectionClient

dataset

• dataset<Data>(id: string): DatasetClient<Data>

• https://docs.apify.com/api/v2#/reference/datasets/dataset

  ---

  Type parameters

  • Data: Record<string | number, any> = Record<string | number, unknown>

  Parameters

  • id: string

  Returns DatasetClient<Data>

datasets

• datasets(): DatasetCollectionClient

• https://docs.apify.com/api/v2#/reference/datasets/dataset-collection

  ---

  Returns DatasetCollectionClient

keyValueStore

• keyValueStore(id: string): KeyValueStoreClient

• https://docs.apify.com/api/v2#/reference/key-value-stores/store-object

  ---

  Parameters

  • id: string

  Returns KeyValueStoreClient

keyValueStores

• keyValueStores(): KeyValueStoreCollectionClient

• https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection

  ---

  Returns KeyValueStoreCollectionClient

log

• log(buildOrRunId: string): LogClient

• https://docs.apify.com/api/v2#/reference/logs

  ---

  Parameters

  • buildOrRunId: string

  Returns LogClient

requestQueue

• requestQueue(id: string, options?: RequestQueueUserOptions): RequestQueueClient

• https://docs.apify.com/api/v2#/reference/request-queues/queue

  ---

  Parameters

  • id: string

  • options: RequestQueueUserOptions = {}

  Returns RequestQueueClient

requestQueues

• requestQueues(): RequestQueueCollectionClient

• https://docs.apify.com/api/v2#/reference/request-queues/queue-collection

  ---

  Returns RequestQueueCollectionClient

run

• run(id: string): RunClient

• https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages

  ---

  Parameters

  • id: string

  Returns RunClient

runs

• runs(): RunCollectionClient

• https://docs.apify.com/api/v2#/reference/actor-runs/run-collection

  ---

  Returns RunCollectionClient

schedule

• schedule(id: string): ScheduleClient

• https://docs.apify.com/api/v2#/reference/schedules/schedule-object

  ---

  Parameters

  • id: string

  Returns ScheduleClient

schedules

• schedules(): ScheduleCollectionClient

• https://docs.apify.com/api/v2#/reference/schedules/schedules-collection

  ---

  Returns ScheduleCollectionClient

setStatusMessage

• setStatusMessage(message: string, options?: SetStatusMessageOptions): Promise<void>

• Parameters

  • message: string

  • optionaloptions: SetStatusMessageOptions

  Returns Promise<void>

store

• store(): StoreCollectionClient

• https://docs.apify.com/api/v2/#/reference/store

  ---

  Returns StoreCollectionClient

task

• task(id: string): TaskClient

• https://docs.apify.com/api/v2#/reference/actor-tasks/task-object

  ---

  Parameters

  • id: string

  Returns TaskClient

tasks

• tasks(): TaskCollectionClient

• https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection

  ---

  Returns TaskCollectionClient

user

• user(id?: string): UserClient

• https://docs.apify.com/api/v2#/reference/users

  ---

  Parameters

  • id: string = ME_USER_NAME_PLACEHOLDER

  Returns UserClient

webhook

• webhook(id: string): WebhookClient

• https://docs.apify.com/api/v2#/reference/webhooks/webhook-object

  ---

  Parameters

  • id: string

  Returns WebhookClient

webhookDispatch

• webhookDispatch(id: string): WebhookDispatchClient

• https://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object

  ---

  Parameters

  • id: string

  Returns WebhookDispatchClient

webhookDispatches

• webhookDispatches(): WebhookDispatchCollectionClient

• https://docs.apify.com/api/v2#/reference/webhook-dispatches

  ---

  Returns WebhookDispatchCollectionClient

webhooks

• webhooks(): WebhookCollectionClient

• https://docs.apify.com/api/v2#/reference/webhooks/webhook-collection

  ---

  Returns WebhookCollectionClient