Skip to main content
Version: 2.8

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

  • new ApifyClient(options): 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): ActorClient

actors

  • actors(): ActorCollectionClient

build

  • build(id): BuildClient

dataset

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

datasets

  • datasets(): DatasetCollectionClient

keyValueStore

  • keyValueStore(id): KeyValueStoreClient

keyValueStores

  • keyValueStores(): KeyValueStoreCollectionClient

log

  • log(buildOrRunId): LogClient

requestQueue

  • requestQueue(id, options): RequestQueueClient

requestQueues

  • requestQueues(): RequestQueueCollectionClient

run

  • run(id): RunClient

schedule

  • schedule(id): ScheduleClient

schedules

  • schedules(): ScheduleCollectionClient

setStatusMessage

  • setStatusMessage(message, options): Promise<void>
  • Parameters

    • message: string
    • options: SetStatusMessageOptionsoptional

    Returns Promise<void>

store

  • store(): StoreCollectionClient

task

  • task(id): TaskClient

tasks

  • tasks(): TaskCollectionClient

user

  • user(id): UserClient

webhook

  • webhook(id): WebhookClient

webhookDispatch

  • webhookDispatch(id): WebhookDispatchClient

webhookDispatches

  • webhookDispatches(): WebhookDispatchCollectionClient

webhooks

  • webhooks(): WebhookCollectionClient