Apify

Run an Apify Actor (web scraper or automation). Starts the Actor asynchronously and returns run information including the run ID and default dataset ID for retrieving results. Supports webhook callbacks for long-running actors.

Run an Apify Actor and wait for results. This synchronous version waits for the Actor to complete (max 5 minutes) and returns the scraped data directly. Best for quick scraping tasks.

Get the status and details of an Actor run. Check if a run is RUNNING, SUCCEEDED, FAILED, ABORTED, or TIMED_OUT. Also provides usage costs and storage IDs.

List all your Actor runs with their status, costs, and timing information. Filter by status to find running, succeeded, or failed runs.

Stop a running Actor immediately or gracefully. Useful for canceling long-running or stuck scraping jobs.

Retrieve scraped data from an Apify dataset. Use the defaultDatasetId from a completed Actor run to get the results.

Add new items to an Apify dataset. Useful for storing scraped data or appending results.

List all datasets in your Apify account with their names, item counts, and creation dates.

Retrieve a specific record from a Key-Value Store. Useful for getting Actor state, configuration, or stored files.

Store a record in a Key-Value Store. Can be used for configuration, state, or file storage.

List available Actors in your Apify account. Shows your custom Actors that can be run.

Get detailed information about a specific Actor including its description, input schema, and configuration.

Run a pre-configured Apify Task. Tasks are saved Actor configurations with preset inputs, making it easy to run recurring scraping jobs. Supports webhook callbacks for long-running tasks.

List all your pre-configured Tasks. Tasks are saved Actor configurations for recurring scraping jobs.

Get information about your Apify account including usage limits, subscription plan, and account details.