ApifyClient
Index
Constructors
constructor
Parameters
options: ApifyClientOptions = {}
Returns ApifyClient
Properties
baseUrl
httpClient
logger
stats
optionaltoken
Methods
actor
Parameters
id: string
Returns ActorClient
actors
build
Parameters
id: string
Returns BuildClient
builds
dataset
Type parameters
- Data: Record<string | number, any> = Record<string | number, unknown>
Parameters
id: string
Returns DatasetClient<Data>
datasets
keyValueStore
Parameters
id: string
Returns KeyValueStoreClient
keyValueStores
log
Parameters
buildOrRunId: string
Returns LogClient
requestQueue
Parameters
id: string
options: RequestQueueUserOptions = {}
Returns RequestQueueClient
requestQueues
run
Parameters
id: string
Returns RunClient
runs
schedule
Parameters
id: string
Returns ScheduleClient
schedules
setStatusMessage
Parameters
message: string
options: SetStatusMessageOptionsoptional
Returns Promise<void>
store
task
Parameters
id: string
Returns TaskClient
tasks
user
Parameters
id: string = ME_USER_NAME_PLACEHOLDER
Returns UserClient
webhook
Parameters
id: string
Returns WebhookClient
webhookDispatch
Parameters
id: string
Returns WebhookDispatchClient
ApifyClient is the official library to access Apify API from your JavaScript applications. It runs both in Node.js and browser.