Skip to main content
Version: 3.1

externalApifyClient

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

Index

Constructors

externalconstructor

Properties

externalbaseUrl

baseUrl: string

externalhttpClient

httpClient: HttpClient

externallogger

logger: Log

externalstats

stats: Statistics

externaloptionaltoken

token?: string

Methods

externalactor

  • actor(id: string): ActorClient

externalactors

  • actors(): ActorCollectionClient

externalbuild

  • build(id: string): BuildClient

externaldataset

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

externaldatasets

  • datasets(): DatasetCollectionClient

externalkeyValueStore

  • keyValueStore(id: string): KeyValueStoreClient

externalkeyValueStores

  • keyValueStores(): KeyValueStoreCollectionClient

externallog

  • log(buildOrRunId: string): LogClient

externalrequestQueue

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

externalrequestQueues

  • requestQueues(): RequestQueueCollectionClient

externalrun

  • run(id: string): RunClient

externalschedule

  • schedule(id: string): ScheduleClient

externalschedules

  • schedules(): ScheduleCollectionClient

externalsetStatusMessage

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

    • externalmessage: string
    • externaloptionaloptions: SetStatusMessageOptions

    Returns Promise<void>

externaltask

  • task(id: string): TaskClient

externaltasks

  • tasks(): TaskCollectionClient

externaluser

  • user(id?: string): UserClient

externalwebhook

  • webhook(id: string): WebhookClient

externalwebhookDispatch

  • webhookDispatch(id: string): WebhookDispatchClient

externalwebhookDispatches

  • webhookDispatches(): WebhookDispatchCollectionClient

externalwebhooks

  • webhooks(): WebhookCollectionClient