API

Yeah, you guessed right - Apify also has its own API to enable programmatic access to the platform. Apify API is organized around RESTful HTTP endpoints. Both requests and responses (including errors) are encoded in JSON format with UTF-8. All API endpoints run on the host api.apify.com.

Note that you can find API endpoints related to specific sections of the app in the API tab, if available. For example, see the API tab on the actor list page.

IMPORTANT: All requests with JSON payloads need to specify the Content-Type: application/json HTTP header or they will not work!

For JavaScript / Node.js applications, the easiest way to access the Apify API is using the apify-client NPM package.

JavaScript API client

The apify-client NPM package provides a JavaScript client for Apify API. This package greatly simplifies the development of apps that depend on the Apify platform.

API reference

The latest version of the API used to manage Apify actors and associated resources. The API enables you to manage:

  • List actors and actor tasks, view and update their settings
  • Run and stop actors and actor tasks
  • Manage storage - key-value stores, datasets and request queues
  • Manage webhooks
  • View user information
  • Download logs

View API reference