Apify Tools

Abort a running Apify Actor run. Use gracefully=true to let the Actor save partial results before stopping. Returns the updated run object.

Add a single URL request to an Apify request queue. The request will be picked up by an Actor crawling from this queue. Use unique_key for deduplicati...

Add multiple URL requests to an Apify request queue in a single batch call. Up to 10,000 requests per call. Returns counts of processed vs unprocessed...

Create an Apify request queue. Request queues manage URL crawl queues for Actors. Use apify_add_queue_req to add URLs to the queue.

Create an Apify schedule to automatically run Actors or tasks on a cron schedule. Define the cron expression, timezone, and which Actors/tasks to run.

Create a saved Apify Actor task with pre-configured input and options. Tasks let you save common Actor configurations for reuse.

Create an Apify webhook. Webhooks send HTTP POST requests to your URL when Actor run events occur (succeeded, failed, timed out, etc). Use conditions ...

Delete an Apify schedule. This permanently removes the schedule and stops all future runs.

Delete a saved Apify Actor task. This permanently removes the task configuration.

Delete an Apify webhook. This permanently removes the webhook.

Delete a specific request from an Apify request queue.

Get detailed information about a specific Apify Actor including its name, description, default run configuration (memory, timeout), input schema, stat...

Get metadata about a specific Apify dataset including item count, size, creation date, and modification date. Use apify_get_dataset_items to fetch the...

Get items (scraped data) from an Apify dataset. This is how you retrieve results after running an Actor. Pass the defaultDatasetId from the run respon...

Get statistics for an Apify dataset including item count, data size, field frequencies, and data quality metrics.

Get details of a specific Apify webhook dispatch including the request sent, HTTP response received, status, and timing.

Get a specific record from an Apify key-value store. Returns the record's content (JSON, text, or binary reference). Use apify_get_kv_store_keys to di...

List keys in an Apify key-value store. Returns key names, sizes, and content types. Common keys include 'INPUT' (run input), 'OUTPUT' (run output), an...

Get the next pending requests from the head of an Apify request queue. Returns the URLs that would be processed next by a crawling Actor.

Get details of a specific request in an Apify request queue including URL, method, handled status, retry count, and error messages.

Get details of an Apify request queue including total, handled, and pending request counts, creation date, and modification date.

Get status and details of an Apify Actor run. Returns status (READY, RUNNING, SUCCEEDED, FAILED, ABORTED, TIMED-OUT), timing info, defaultDatasetId (f...

Get the console log output of an Apify Actor run. Useful for debugging failed runs or monitoring progress. Returns the log as plain text.

Get details of an Apify schedule including its cron expression, timezone, associated Actors/tasks, enabled status, and next run time.

Get the execution log for an Apify schedule showing when it ran, what actions were triggered, and any errors.

Get details of a saved Apify Actor task including its name, associated Actor, saved input configuration, memory/timeout settings, and run history.

Get the current month's usage statistics for your Apify account. Returns compute units used, data transfer, storage usage, and costs against your plan...

Get the current Apify user's account info including username, email, plan details, usage limits, and proxy settings. Use this to check account status ...

Get details of an Apify webhook including its URL, event types, condition, request template, headers, and associated Actor/task.

List Actors in your Apify account. Returns Actor IDs, names, descriptions, creation dates, and run stats. Use 'my=true' to filter to only your own Act...

List datasets in your Apify account. Each Actor run creates a default dataset with scraped results. Returns dataset IDs, names, item counts, and creat...

List webhook dispatches across your Apify account. Shows delivery history for all webhooks including dispatch IDs, statuses, HTTP response codes, and ...

List key-value stores in your Apify account. Each Actor run creates a default key-value store for storing intermediate data, screenshots, and other ou...

List requests in an Apify request queue. Returns URLs, methods, unique keys, and handled status for each request in the queue.

List request queues in your Apify account. Request queues manage URL crawl queues for Actors. Returns queue IDs, names, pending/handled request counts...

List Actor runs across your Apify account. Returns run IDs, statuses, Actor IDs, timing, and dataset IDs. Filter by status to find running, succeeded,...

List schedules in your Apify account. Schedules automatically run Actors or tasks on a cron-based schedule. Returns schedule IDs, names, cron expressi...

List runs of a specific saved Apify Actor task. Returns run IDs, statuses, timing info, and dataset IDs for each execution of this task.

List saved Actor tasks in your Apify account. Tasks are pre-configured Actor runs with saved input, memory, and timeout settings. Returns task IDs, na...

List webhooks in your Apify account. Webhooks send HTTP requests when Actor runs succeed, fail, or other events occur. Returns webhook IDs, URLs, even...

Resurrect a finished Apify Actor run. This restarts the run from where it left off, preserving the existing dataset, key-value store, and request queu...

Run an Apify Actor (web scraper or automation). Pass the Actor ID and input parameters. The run starts asynchronously — use apify_get_run to poll stat...

Run a saved Apify Actor task. Tasks have pre-configured input, memory, and timeout settings. Optionally pass run_input to override specific fields. Re...

Search the Apify Store for pre-built Actors (web scrapers and automations). Find scrapers for specific websites or use cases like LinkedIn companies, ...

Test an Apify webhook by sending a sample event dispatch to the webhook URL. Returns the dispatch result including HTTP status code from your endpoint...

Update an existing Apify schedule. Change the cron expression, timezone, actions, or enable/disable the schedule. Only include fields you want to chan...

Update an existing Apify Actor task. Change the name, input configuration, or run options. Only include fields you want to change.

Update an existing Apify webhook. Change the URL, event types, conditions, payload template, or description. Only include fields you want to change.