API

Yeah, you guessed it 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. For backwards compatibility, the legacy hostname api.apifier.com is still supported, but new integrations should not use it.

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 Acts list page.

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

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

Crawlers API (version 1)

This is a legacy API used to manage Crawlers. It enables the following operations:

  • List user's crawlers and access their settings
  • Execute a specific crawler, list its executions, check their status and stop them
  • Return the results of a particular crawler's execution

View Crawlers API (v1) reference

Acts API (version 2)

The new API for managing Acts. It enables the following operations:

  • List acts, view and update their settings
  • Run and stop acts
  • Manage key-value stores
  • Download logs

View Acts API (v2) reference