> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Apify

> Apify is a platform for building, deploying, and managing web scraping and automation tools, known as Actors.

![Apify logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/apify.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=069c9f82a7d549471067e514f98d5ce3)

* **Category:** web scraping & browser
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 185
* **Triggers:** 0
* **Slug:** `APIFY`
* **Version:** 20261101\_00
* **Instant:** Supported on the latest version. Support varies by tool.

## Tools

> [accordion] Build Actor
>
> **Slug:** `APIFY_ACT_BUILDS_POST`
>
> Tool to build an Actor with specified configuration. Use when you need to create a new build of an Actor with a specific version. The build process compiles the Actor's source code into a Docker image.
>
> #### Input Parameters
>
> **tag** `string`
>
> Optional version tag specification for the build.
>
> **actorId** `string` *required*
>
> Actor ID or a tilde-separated owner's username and Actor name (e.g., 'janedoe\~my-actor').
>
> **useCache** `boolean`
>
> If true, uses cached layers from previous builds. Default: true.
>
> **betaPackages** `boolean`
>
> If true, uses beta versions of Apify SDK packages. Default: false.
>
> **versionNumber** `string`
>
> Actor version to build (e.g., '0.1'). If not provided, the latest version is used. Can be provided as query parameter or in request body.
>
> **waitForFinish** `integer`
>
> Optional timeout value (in seconds) to wait for build completion before returning response. Max 300 seconds.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Abort Actor Build
>
> **Slug:** `APIFY_ACTOR_BUILD_ABORT_POST`
>
> Tool to abort an Actor build that is starting or running. Use when you need to cancel a build in progress. Builds in terminal states (FINISHED, FAILED, ABORTING, TIMED-OUT) are not affected.
>
> #### Input Parameters
>
> **buildId** `string` *required*
>
> Unique identifier of the Actor build to abort. Only builds in STARTING or RUNNING status will be aborted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Actor Build
>
> **Slug:** `APIFY_ACTOR_BUILD_DELETE`
>
> Tool to delete an Actor build permanently. Use when you need to remove a specific build by its ID. The default build for an Actor cannot be deleted. Only users with build permissions can delete builds.
>
> #### Input Parameters
>
> **buildId** `string` *required*
>
> Unique identifier of the Actor build to delete. The build that is the current default build for the Actor cannot be deleted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Actor Build
>
> **Slug:** `APIFY_ACTOR_BUILD_GET`
>
> Get details of a specific Actor build by build ID. Optionally wait for the build to finish instead of immediately retrieving its current status.
>
> #### Input Parameters
>
> **buildId** `string` *required*
>
> Unique identifier of the Actor build to retrieve.
>
> **waitForFinish** `integer`
>
> Number of seconds to wait synchronously for the build to finish. If omitted or 0, returns immediately with the current build status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Actor Build Log
>
> **Slug:** `APIFY_ACTOR_BUILD_LOG_GET`
>
> Tool to retrieve the log file for a specific Actor build. Use when you need to inspect logs generated during an Actor build process. Only the trailing 5 million characters of the log are stored.
>
> #### Input Parameters
>
> **raw** `boolean`
>
> If true, the log includes formatting such as ANSI coloring sequences. If false (default), formatting is stripped.
>
> **stream** `boolean`
>
> If true, enables streaming of log output progressively. Used by API clients for streaming responses.
>
> **buildId** `string` *required*
>
> Unique identifier of the Actor build. The endpoint authenticates using the buildId itself.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get user builds list
>
> **Slug:** `APIFY_ACTOR_BUILDS_GET`
>
> Tool to get a paginated list of all builds for a user. Use when you need to retrieve build history across all actors. Supports pagination up to 1000 records.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true, sort builds by startedAt descending. Default is ascending (false).
>
> **limit** `integer`
>
> Maximum number of builds to return (pagination). Maximum and default is 1000.
>
> **offset** `integer`
>
> Number of builds to skip at the start (pagination). Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Abort Actor Run
>
> **Slug:** `APIFY_ACTOR_RUN_ABORT_POST`
>
> Tool to abort a running or starting Actor run. Use when you need to stop an Actor run that is currently in STARTING or RUNNING status. For runs with status FINISHED, FAILED, ABORTING, and TIMED-OUT this call does nothing.
>
> #### Input Parameters
>
> **runId** `string` *required*
>
> The unique identifier of the Actor run to abort.
>
> **gracefulAbort** `boolean`
>
> If true, the Actor run will abort gracefully. It will send 'aborting' and 'persistStates' events into the run and force-stop the run after 30 seconds. This is helpful when you plan to resurrect the run later. Default: false
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Actor Run
>
> **Slug:** `APIFY_ACTOR_RUN_DELETE`
>
> Tool to delete a finished Actor run. Use when you need to permanently remove a completed run. Only finished runs can be deleted by the initiating user or organization.
>
> #### Input Parameters
>
> **runId** `string` *required*
>
> Unique identifier of the Actor run to delete. Only finished runs can be deleted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Actor Run
>
> **Slug:** `APIFY_ACTOR_RUN_GET`
>
> Tool to get details about a specific Actor run. Use when you need to retrieve comprehensive information about a run including its execution status, resource usage, storage IDs, and metadata.
>
> #### Input Parameters
>
> **runId** `string` *required*
>
> The unique identifier of the Actor run to retrieve.
>
> **waitForFinish** `integer`
>
> Maximum seconds to wait for run completion before returning response. Range: 0-60. When set, the API endpoint will synchronously wait for the run to finish instead of returning immediately.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Actor Run Status Message
>
> **Slug:** `APIFY_ACTOR_RUN_PUT`
>
> Tool to update the status message of an Actor run. Use when you need to set progress information or status updates that will be displayed in the Apify Console UI during Actor execution.
>
> #### Input Parameters
>
> **runId** `string` *required*
>
> Run identifier for the Actor run to update.
>
> **statusMessage** `string` *required*
>
> Text displayed in Apify Console UI to communicate Actor progress.
>
> **isStatusMessageTerminal** `boolean`
>
> Indicates whether the status message is the very last one (terminal status). If not provided, defaults to False.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Actor Task
>
> **Slug:** `APIFY_ACTOR_TASK_DELETE`
>
> Tool to delete an Actor task permanently. Use when you need to remove a task by its ID or username\~taskName. Confirm before calling.
>
> #### Input Parameters
>
> **actorTaskId** `string` *required*
>
> Unique identifier of the Actor task to delete. Can be either the task ID (e.g., 'HG7ML7M8z78YcAPEB') or a tilde-separated username and task name (e.g., 'janedoe\~my-task').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Actor Task
>
> **Slug:** `APIFY_ACTOR_TASK_GET`
>
> Tool to get complete details about an Actor task. Use when you need to retrieve task configuration, input settings, or metadata by task ID or username\~task-name.
>
> #### Input Parameters
>
> **actorTaskId** `string` *required*
>
> Task ID (e.g., HG7ML7M8z78YcAPEB) or tilde-separated owner username and task name (e.g., janedoe\~my-task).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Actor Task
>
> **Slug:** `APIFY_ACTOR_TASK_PUT`
>
> Tool to update Actor task settings using JSON payload. Only specified properties are updated; others remain unchanged. Use when you need to modify task configuration, input, or execution options.
>
> #### Input Parameters
>
> **input** `string`
>
> Input configuration for the task. Can be any JSON object or array with task-specific fields. Only specified fields will be updated.
>
> **title** `string`
>
> Display title for the task. Only specified fields will be updated.
>
> **options** `object`
>
> Task execution options (e.g., build, timeoutSecs, memoryMbytes, restartOnError). Only specified fields will be updated.
>
> **actorTaskId** `string` *required*
>
> Task ID (e.g., 'HG7ML7M8z78YcAPEB') or tilde-separated owner's username and task name (e.g., 'janedoe\~my-task').
>
> **description** `string`
>
> Description of the task. Only specified fields will be updated.
>
> **actorStandby** `object`
>
> Actor standby configuration for faster task startup (request model).  When actorStandby is provided in a request, the API requires all 6 core fields: desiredRequestsPerActorRun, maxRequestsPerActorRun, idleTimeoutSecs, build, memoryMbytes, and shouldPassActorInput.  Note: isEnabled and disableStandbyFieldsOverride are response-only fields that cannot be sent in requests.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get last actor task run
>
> **Slug:** `APIFY_ACTOR_TASK_RUNS_LAST_GET`
>
> Tool to get the most recent run of a specific Actor task. Use when you need to retrieve the last execution details. You can filter by status to get only successful runs using status='SUCCEEDED'.
>
> #### Input Parameters
>
> **status** `string ("READY" | "RUNNING" | "SUCCEEDED" | "FAILED" | "TIMING-OUT" | "TIMED-OUT" | "ABORTING" | "ABORTED")`
>
> Filter to return only runs matching this status (e.g., 'SUCCEEDED' ensures you get the last successful run).
>
> **actorTaskId** `string` *required*
>
> Task ID or '\<username>\~\<taskName>' identifying the actor task.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Task Sync (GET)
>
> **Slug:** `APIFY_ACTOR_TASK_RUN_SYNC_GET`
>
> Tool to run a specific task synchronously and return its output. Use when immediate task results are needed with pre-configured settings. The run must finish within 300 seconds otherwise the HTTP request fails with a timeout error.
>
> #### Input Parameters
>
> **build** `string`
>
> Tag or number of the actor build to run (e.g. 'beta' or '1.2.345'). Note: For tasks, this parameter typically has no effect as tasks already reference a specific Actor build.
>
> **memory** `integer`
>
> Allocated memory in megabytes for the actor execution.
>
> **timeout** `integer`
>
> Timeout for the actor run in seconds. Zero value means there is no timeout.
>
> **maxItems** `integer`
>
> Maximum dataset items charged for pay-per-result actors.
>
> **webhooks** `string`
>
> Base64-encoded JSON array of webhook definitions for notifications on actor completion or failure.
>
> **actorTaskId** `string` *required*
>
> Unique identifier of the actor task to execute. Can be task ID or username\~taskName format.
>
> **restartOnError** `boolean`
>
> Determines whether the run will be restarted if it fails.
>
> **maxTotalChargeUsd** `number`
>
> Specifies the maximum cost of the Actor run for pay-per-event actors.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Task Sync & Get Dataset Items
>
> **Slug:** `APIFY_ACTOR_TASK_RUN_SYNC_GET_DATASET_ITEMS_GET`
>
> Run an Actor task synchronously and retrieve its dataset items. The run must finish within 300 seconds or the request times out; each call starts a task run, including calls with different limits or offsets.
>
> #### Input Parameters
>
> **bom** `boolean`
>
> Include UTF-8 Byte Order Mark in response (default varies by format).
>
> **desc** `boolean`
>
> Return results in reverse order (newest to oldest).
>
> **omit** `string`
>
> Comma-separated list of fields to exclude from output.
>
> **view** `string`
>
> Name of the dataset view to use.
>
> **build** `string`
>
> Tag or number of the build to run (e.g., 'latest', '1.2.3').
>
> **clean** `boolean`
>
> Shortcut for skipHidden=true and skipEmpty=true.
>
> **limit** `integer`
>
> Maximum number of items to return (default: 250000).
>
> **fields** `string`
>
> Comma-separated list of fields to include in output.
>
> **format** `string ("json" | "jsonl" | "csv" | "html" | "xlsx" | "xml" | "rss")`
>
> Output format - json, jsonl, csv, html, xlsx, xml, rss.
>
> **memory** `integer`
>
> Memory allocation in megabytes for the task execution.
>
> **offset** `integer`
>
> Number of items to skip from the start (default: 0).
>
> **unwind** `string`
>
> Field name to unwind array elements into separate items.
>
> **xmlRow** `string`
>
> XML element name for each item (default: 'item').
>
> **flatten** `string`
>
> Comma-separated list of fields to flatten.
>
> **timeout** `integer`
>
> Timeout for the run in seconds.
>
> **xmlRoot** `string`
>
> Root XML element name (default: 'items').
>
> **delimiter** `string`
>
> Delimiter character for CSV files (default: ',').
>
> **skipEmpty** `boolean`
>
> Skip empty items from output.
>
> **skipHidden** `boolean`
>
> Exclude fields starting with '#'.
>
> **actorTaskId** `string` *required*
>
> Unique identifier of the actor task to execute (e.g., 'pPHi5vTiEhou0Nw5F').
>
> **skipHeaderRow** `boolean`
>
> Skip header row in CSV format.
>
> **waitForFinish** `integer`
>
> Maximum time to wait for the run to finish in seconds (default: 300, max: 300).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Task Sync with Input Override & Get Dataset Items
>
> **Slug:** `APIFY_ACTOR_TASK_RUN_SYNC_GET_DATASET_ITEMS_POST`
>
> Tool to run an actor task synchronously with input overrides and retrieve its dataset items. Use when you need to override task input configuration and get immediate results. The run must finish within 300 seconds otherwise the request times out.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> Return results in reverse order (newest to oldest).
>
> **omit** `string`
>
> Comma-separated list of fields to exclude from output.
>
> **build** `string`
>
> Tag or number of the build to run (e.g., 'latest', '1.2.3').
>
> **clean** `boolean`
>
> Shortcut for skipHidden=true and skipEmpty=true.
>
> **limit** `integer`
>
> Maximum number of items to return. Recommended for large scrapes to avoid excessive dataset sizes and costs.
>
> **fields** `string`
>
> Comma-separated list of fields to include in output.
>
> **format** `string ("json" | "jsonl" | "csv" | "html" | "xlsx" | "xml" | "rss")`
>
> Output format - json, jsonl, csv, html, xlsx, xml, rss.
>
> **memory** `integer`
>
> Memory allocation in megabytes for the task execution.
>
> **offset** `integer`
>
> Number of items to skip from the start (default: 0).
>
> **unwind** `string`
>
> Field name to unwind array elements into separate items.
>
> **xmlRow** `string`
>
> XML element name for each item (default: 'item').
>
> **timeout** `integer`
>
> Timeout for the run in seconds.
>
> **xmlRoot** `string`
>
> Root XML element name (default: 'items').
>
> **maxItems** `integer`
>
> Maximum number of dataset items that will be charged for pay-per-result Actors. Does not limit actual items returned.
>
> **webhooks** `string`
>
> Base64-encoded JSON array of webhook definitions for notifications.
>
> **skipEmpty** `boolean`
>
> Skip empty items from output.
>
> **skipHidden** `boolean`
>
> Exclude fields starting with '#'.
>
> **actorTaskId** `string` *required*
>
> Unique identifier of the actor task to execute (e.g., 'pPHi5vTiEhou0Nw5F').
>
> **waitForFinish** `integer`
>
> Maximum time to wait for the run to finish in seconds (max: 60).
>
> **inputOverrides** `object`
>
> JSON object to override Actor input configuration. Properties not defined here use task defaults.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Task Sync (POST)
>
> **Slug:** `APIFY_ACTOR_TASK_RUN_SYNC_POST`
>
> Tool to run an Actor task synchronously with input override and return its output. Use when immediate task results are needed with custom input parameters. The run must finish within 300 seconds otherwise the HTTP request fails with a timeout error (though the run continues server-side).
>
> #### Input Parameters
>
> **build** `string`
>
> Specifies the Actor build to run (build tag or build number). By default, uses the build specified in task settings (typically 'latest').
>
> **memory** `integer`
>
> Allocated memory in megabytes for the actor execution. Overrides the task's default memory setting.
>
> **timeout** `integer`
>
> Timeout for the actor run in seconds. Overrides the task's default timeout setting.
>
> **maxItems** `integer`
>
> Maximum number of results that will be returned. Useful for limiting charges per result.
>
> **webhooks** `string`
>
> Base64-encoded JSON array of webhook definitions for notifications on actor completion or failure.
>
> **actorTaskId** `string` *required*
>
> Unique identifier of the actor task to execute. Can be task ID or username\~taskName format.
>
> **waitForFinish** `integer`
>
> Maximum number of seconds the server waits for the task run to finish (0-60 seconds; default is 0 for synchronous endpoints).
>
> **inputOverrides** `object`
>
> JSON object containing input field overrides for the Actor task. Properties in this object override the task's default configuration. Any property not defined will use the default value from the task configuration or Actor's input schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Actor
>
> **Slug:** `APIFY_ACT_PUT`
>
> Tool to update Actor settings using JSON payload. Only specified fields will be updated. Use when you need to modify Actor configuration, make an Actor public, or update version settings.
>
> #### Input Parameters
>
> **name** `string`
>
> Actor identifier name. Only specified fields will be updated.
>
> **title** `string`
>
> Display title for public actors. Required if isPublic is set to true.
>
> **actorId** `string` *required*
>
> Actor ID or tilde-separated owner's username and Actor name. Examples: 'Sbjr4vDajTluPyKl8' or 'apify\~web-scraper'.
>
> **isPublic** `boolean`
>
> Publication status. If set to true, title and categories are required.
>
> **seoTitle** `string`
>
> Search engine optimization title
>
> **versions** `array`
>
> Actor source code versions array
>
> **categories** `array`
>
> Classification tags for Apify Store. Required if isPublic is set to true.
>
> **description** `string`
>
> Human-readable Actor details. Only specified fields will be updated.
>
> **taggedBuilds** `object`
>
> Mapping of tag names to build references. Set to null to remove tag.
>
> **seoDescription** `string`
>
> SEO description text
>
> **exampleRunInput** `object`
>
> Example input for the Actor
>
> **defaultRunOptions** `object`
>
> Default execution settings for an Actor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get last actor run
>
> **Slug:** `APIFY_ACT_RUNS_LAST_GET`
>
> Tool to get the most recent run of a specific Actor. Use when you need to retrieve the last execution details of an Actor and optionally filter by status (e.g., status='SUCCEEDED' to get only the last successful run).
>
> #### Input Parameters
>
> **status** `string ("READY" | "RUNNING" | "SUCCEEDED" | "FAILED" | "TIMING-OUT" | "TIMED-OUT" | "ABORTING" | "ABORTED")`
>
> Filter to return only runs with a specific status (e.g., 'SUCCEEDED' ensures you get the last successful run).
>
> **actorId** `string` *required*
>
> Actor ID or tilde-separated owner's username and Actor name (e.g., 'janedoe\~my-actor').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Actor Sync without Input (GET)
>
> **Slug:** `APIFY_ACT_RUN_SYNC_GET`
>
> Run an Apify Actor synchronously using GET and return its JSON output, optionally supplying input overrides or selecting an output record. The request times out if the run exceeds the 300-second HTTP wait limit.
>
> #### Input Parameters
>
> **build** `string`
>
> Tag or number of the Actor build to run (e.g., 'beta' or '1.2.345'). Default: Latest configured build.
>
> **memory** `integer`
>
> Memory allocation for the Actor run in megabytes (e.g., 8192). Default: Memory limit specified in the default run configuration.
>
> **actorId** `string` *required*
>
> Actor ID or tilde-separated username~~actorname format (e.g., 'janedoe~~my-actor' or 'apify\~hello-world').
>
> **timeout** `integer`
>
> Maximum run time in seconds. Zero value means no timeout. Default: Timeout specified in the default run configuration.
>
> **maxItems** `integer`
>
> Maximum number of dataset items that will be charged for pay-per-result Actors.
>
> **webhooks** `string`
>
> Base64-encoded JSON array of webhook configurations to receive notifications for run events (ad hoc webhooks).
>
> **inputOverrides** `object`
>
> JSON object to override Actor input. Sent as a query parameter encoded as JSON string.
>
> **outputRecordKey** `string`
>
> Specifies which record from the Actor's key-value store to return. Must match a key produced by the Actor. Default: 'OUTPUT'.
>
> **maxTotalChargeUsd** `number`
>
> Maximum spending limit in USD for pay-per-event Actors. Accessible via environment variable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Actor Sync & Get Dataset Items
>
> **Slug:** `APIFY_ACT_RUN_SYNC_GET_DATASET_ITEMS_GET`
>
> Tool to run Actor synchronously and get dataset items. Supports both actors that require input and those that don't. Use when immediate access to Actor results is needed. The run must finish within 300 seconds otherwise the request times out.
>
> #### Input Parameters
>
> **bom** `boolean`
>
> Include BOM (Byte Order Mark) in CSV output.
>
> **desc** `boolean`
>
> Returns results in reverse order (newest to oldest).
>
> **omit** `string`
>
> Comma-separated list of fields to exclude from each item.
>
> **view** `string`
>
> Applies a predefined dataset view.
>
> **build** `string`
>
> Tag or number of the Actor build to run (e.g., 'beta' or '1.2.345').
>
> **clean** `boolean`
>
> Equivalent to skipHidden=true and skipEmpty=true.
>
> **input** `object`
>
> JSON input object passed to the Actor. Actor-specific schema validation is performed server-side. IMPORTANT: Most Actors expect enum values in lowercase (e.g., 'relevance' not 'RELEVANCE', 'all' not 'ALL'). Check the Actor's documentation for exact input requirements.
>
> **limit** `integer`
>
> Maximum number of items to return.
>
> **fields** `string`
>
> Comma-separated list of fields to include in each item.
>
> **format** `string ("json" | "jsonl" | "csv" | "html" | "xlsx" | "xml" | "rss")`
>
> Response format. Default: 'json'.
>
> **memory** `integer`
>
> Memory limit for the Actor run in megabytes.
>
> **offset** `integer`
>
> Number of items to skip from the start.
>
> **unwind** `string`
>
> Field name to unwind array elements into separate items.
>
> **xmlRow** `string`
>
> Customizes individual item XML element wrapper name.
>
> **actorId** `string` *required*
>
> Actor ID or username~~actor-name format (e.g., 'apify~~hello-world').
>
> **flatten** `string`
>
> Comma-separated list of fields to flatten.
>
> **timeout** `integer`
>
> Timeout for the Actor run in seconds. Zero means no timeout.
>
> **xmlRoot** `string`
>
> Customizes root XML element wrapper name.
>
> **maxItems** `integer`
>
> Maximum number of dataset items that will be charged for pay-per-result Actors.
>
> **delimiter** `string`
>
> Delimiter character for CSV format.
>
> **skipEmpty** `boolean`
>
> Excludes empty items from results.
>
> **attachment** `boolean`
>
> Sets Content-Disposition: attachment header to force download.
>
> **simplified** `boolean`
>
> Legacy feature, applies fields=\['url','pageFunctionResult','errorInfo'] and unwind='pageFunctionResult'.
>
> **skipHidden** `boolean`
>
> Omits fields beginning with '#' character.
>
> **skipHeaderRow** `boolean`
>
> Skips header row in CSV output.
>
> **waitForFinish** `integer`
>
> Maximum time in seconds the server waits for the run to finish (0-60 seconds).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of Actors
>
> **Slug:** `APIFY_ACTS_GET`
>
> Tool to get the list of all Actors that the user created or used. Use when you need to enumerate or browse Actors. Add my=1 to get only user-created Actors.
>
> #### Input Parameters
>
> **my** `boolean`
>
> If true or 1, returns only Actors owned by the user. Default is false.
>
> **desc** `boolean`
>
> If true or 1, sorts objects by createdAt field in descending order. Default is false (ascending).
>
> **limit** `integer`
>
> Maximum number of records to return (pagination). Default and max is 1000.
>
> **offset** `integer`
>
> Number of records to skip at the start (pagination). Default is 0.
>
> **sortBy** `string ("createdAt" | "stats.lastRunStartedAt")`
>
> Field to sort by. Values: 'createdAt' (default) or 'stats.lastRunStartedAt' for most recently run Actors.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Actor Version
>
> **Slug:** `APIFY_ACT_VERSION_DELETE`
>
> Tool to delete a specific version of an Actor's source code. Use when you need to remove an Actor version by actor ID and version number. Confirm before calling.
>
> #### Input Parameters
>
> **actorId** `string` *required*
>
> Actor identifier in ID format or username~~actorName format. Examples: '5fCDx7kGq9xcRt8FP' or 'john\_doe~~data-scraper'.
>
> **versionNumber** `string` *required*
>
> Actor version number to delete. Examples: '0.1', '1.0', '2.3'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Actor Version Environment Variable
>
> **Slug:** `APIFY_ACT_VERSION_ENV_VAR_DELETE`
>
> Tool to delete an environment variable from a specific Actor version. Use when removing environment variables from Actor versions.
>
> #### Input Parameters
>
> **actorId** `string` *required*
>
> Actor ID or a tilde-separated owner's username and Actor name.
>
> **envVarName** `string` *required*
>
> The name of the environment variable to delete.
>
> **versionNumber** `string` *required*
>
> Actor version number (e.g., '0.0', '0.1', '1.0').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Actor Version Environment Variable
>
> **Slug:** `APIFY_ACT_VERSION_ENV_VAR_GET`
>
> Tool to get environment variable details for a specific Actor version. Use when retrieving environment variable information from an Actor version. Returns name, value (if not secret), and secret status.
>
> #### Input Parameters
>
> **actorId** `string` *required*
>
> Actor ID or tilde-separated owner's username and Actor name (e.g., 'janedoe\~my-actor' or 'flDZ3hqh45G99mwJu').
>
> **envVarName** `string` *required*
>
> The name of the environment variable to retrieve.
>
> **versionNumber** `string` *required*
>
> Actor version number (e.g., '0.0', '0.1', '1.0').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Actor Version Environment Variable
>
> **Slug:** `APIFY_ACT_VERSION_ENV_VAR_PUT`
>
> Tool to update environment variable for a specific Actor version using JSON payload. Only specified fields will be updated. Use when modifying existing environment variables in Actor versions.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The environment variable name (must match envVarName).
>
> **value** `string` *required*
>
> The updated environment variable value.
>
> **actorId** `string` *required*
>
> Actor ID or tilde-separated owner's username and Actor name (e.g., 'janedoe\~my-actor' or 'flDZ3hqh45G99mwJu').
>
> **isSecret** `boolean`
>
> When set to true, the value will not be returned in subsequent requests. Only specified fields will be updated.
>
> **envVarName** `string` *required*
>
> The name of the environment variable to update.
>
> **versionNumber** `string` *required*
>
> Actor version number (e.g., '0.0', '0.1', '1.0').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of Actor version environment variables
>
> **Slug:** `APIFY_ACT_VERSION_ENV_VARS_GET`
>
> Tool to get the list of environment variables for a specific Actor version. Use when you need to retrieve environment variable configurations for an Actor version.
>
> #### Input Parameters
>
> **actorId** `string` *required*
>
> Actor ID or a tilde-separated owner's username and Actor name.
>
> **versionNumber** `string` *required*
>
> Actor version number (e.g., '0.0', '0.1', '1.0').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Actor Version Environment Variable
>
> **Slug:** `APIFY_ACT_VERSION_ENV_VARS_POST`
>
> Tool to create an environment variable for a specific Actor version. Use when adding new environment variables to Actor versions. Requires name and value parameters.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The environment variable name.
>
> **value** `string` *required*
>
> The environment variable value.
>
> **actorId** `string` *required*
>
> Actor ID or a tilde-separated owner's username and Actor name.
>
> **isSecret** `boolean`
>
> Indicates if the value is a secret. When true, the value will be omitted from responses. Defaults to false.
>
> **versionNumber** `string` *required*
>
> Actor version number (e.g., '0.0', '0.1', '1.0').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Actor version
>
> **Slug:** `APIFY_ACT_VERSION_GET`
>
> Tool to get details about a specific version of an Actor. Use when you need version metadata including source type, build tag, and configuration details.
>
> #### Input Parameters
>
> **actorId** `string` *required*
>
> Actor ID or tilde-separated owner's username and Actor name (e.g., 'janedoe\~my-actor' or 'nwua9Gu5YrADL7ZDj').
>
> **versionNumber** `string` *required*
>
> Actor major and minor version number (e.g., '0.1', '1.0').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Actor Version
>
> **Slug:** `APIFY_ACT_VERSION_PUT`
>
> Tool to update an Actor version's configuration and source code. Use when modifying version properties such as buildTag, sourceType, or environment variables. Only specified properties will be updated.
>
> #### Input Parameters
>
> **actorId** `string` *required*
>
> Actor ID or tilde-separated owner's username and Actor name (e.g., 'janedoe\~my-actor' or 'nwua9Gu5YrADL7ZDj').
>
> **envVars** `array`
>
> List of environment variables with name, value, and optional isSecret properties.
>
> **buildTag** `string`
>
> Build tag identifier to associate with this version.
>
> **gitRepoUrl** `string`
>
> Git repository URL. Only used when sourceType is GIT\_REPO.
>
> **sourceType** `string ("SOURCE_FILES" | "GIT_REPO" | "TARBALL" | "GITHUB_GIST")`
>
> Type of source code storage. SOURCE\_FILES for inline files, GIT\_REPO for Git repository, TARBALL for tarball/zip archive, GITHUB\_GIST for GitHub Gist.
>
> **tarballUrl** `string`
>
> Tarball or Zip archive URL. Only used when sourceType is TARBALL.
>
> **sourceFiles** `array`
>
> Array of source file objects with name, format (TEXT or BASE64), and content fields. Only used when sourceType is SOURCE\_FILES.
>
> **gitHubGistUrl** `string`
>
> GitHub Gist URL. Only used when sourceType is GITHUB\_GIST.
>
> **versionNumber** `string` *required*
>
> Actor major and minor version number to update (e.g., '0.1', '1.0').
>
> **applyEnvVarsToBuild** `boolean`
>
> Whether to apply environment variables during the build process.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of Actor versions
>
> **Slug:** `APIFY_ACT_VERSIONS_GET`
>
> Tool to get the list of versions of a specific Actor. Use when you need to retrieve version metadata including source type, version number, and configuration details.
>
> #### Input Parameters
>
> **actorId** `string` *required*
>
> Actor ID or tilde-separated owner's username and Actor name (e.g., 'janedoe\~my-actor' or 'nwua9Gu5YrADL7ZDj').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Actor Version
>
> **Slug:** `APIFY_ACT_VERSIONS_POST`
>
> Tool to create a new version of an Actor. Use when you need to add a new version with specific source code location and configuration. Requires versionNumber and sourceType parameters, plus conditional parameters based on the sourceType.
>
> #### Input Parameters
>
> **actorId** `string` *required*
>
> Actor ID or tilde-separated owner's username and Actor name.
>
> **envVars** `array`
>
> Array of environment variables for the Actor version.
>
> **buildTag** `string`
>
> Build tag identifier (e.g., 'latest').
>
> **gitRepoUrl** `string`
>
> URL of Git repository to clone. Required when sourceType is 'GIT\_REPO'.
>
> **sourceType** `string ("SOURCE_FILES" | "GIT_REPO" | "TARBALL" | "GITHUB_GIST")` *required*
>
> Source code location type. Must be one of: 'SOURCE\_FILES', 'GIT\_REPO', 'TARBALL', or 'GITHUB\_GIST'.
>
> **tarballUrl** `string`
>
> URL of tarball or zip archive. Required when sourceType is 'TARBALL'.
>
> **sourceFiles** `array`
>
> Array of source files. Required when sourceType is 'SOURCE\_FILES'.
>
> **gitHubGistUrl** `string`
>
> URL of GitHub Gist. Required when sourceType is 'GITHUB\_GIST'.
>
> **versionNumber** `string` *required*
>
> Major and minor version identifier (e.g., '0.1', '1.0').
>
> **applyEnvVarsToBuild** `boolean`
>
> Whether to apply environment variables during build process. Defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of Actor webhooks
>
> **Slug:** `APIFY_ACT_WEBHOOKS_GET`
>
> Tool to get a list of webhooks for a specific Actor. Use when you need to review or manage webhooks configured for an Actor.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true, sort by createdAt descending. Default is false (ascending).
>
> **limit** `integer`
>
> Maximum number of webhooks to return (pagination). Default and max is 1000.
>
> **offset** `integer`
>
> Number of webhooks to skip at the start (pagination). Default is 0.
>
> **actorId** `string` *required*
>
> Actor ID or '\<username>\~\<actorName>' format to list webhooks for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Actor
>
> **Slug:** `APIFY_CREATE_ACTOR`
>
> Tool to create a new Actor with specified configuration. Use when you need to initialize a fresh Actor programmatically before publishing or running it.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique name for the new actor (must be 1–63 characters, lowercase letters, digits, and dashes).
>
> **title** `string`
>
> Human-readable title for the actor.
>
> **isPublic** `boolean`
>
> Whether the actor should be publicly visible on Apify Store. Cannot be true on actor creation - actors must be created as private, then built and published later. Setting isPublic=true will result in a 403 error.
>
> **versions** `array`
>
> Initial actor versions definition. Each item must include versionNumber, sourceType (string value like 'SOURCE\_FILES' or 'INLINE', not an object), and buildTag.
>
> **categories** `array`
>
> List of category IDs to which this actor belongs.
>
> **description** `string`
>
> Detailed description of what the actor does.
>
> **isDeprecated** `boolean`
>
> Whether the actor is deprecated (discouraged for new runs).
>
> **defaultRunOptions** `object`
>
> Default execution options for running the Actor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Dataset
>
> **Slug:** `APIFY_CREATE_DATASET`
>
> Tool to create a new dataset. Use when you need to initialize or retrieve a dataset by name.
>
> #### Input Parameters
>
> **name** `string`
>
> Custom unique name for the dataset (1-63 characters). Must contain only lowercase letters (a-z), digits (0-9), and hyphens (-). Hyphens can only appear in the middle, not at the start or end. If omitted, a random name is generated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Actor Task
>
> **Slug:** `APIFY_CREATE_TASK`
>
> Create an Actor task with specified input and execution settings for later runs.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the task. Must contain only lowercase letters (a-z), digits (0-9), and hyphens (only in the middle). Names are automatically sanitized: spaces and special characters become hyphens, uppercase letters become lowercase.
>
> **actId** `string` *required*
>
> ID or 'username\~actorName' of the Actor to attach the task to.
>
> **input** `object`
>
> Input configuration for the task. This is the Actor-specific input data (e.g., keywords, URLs, settings). Keys must exactly match the target Actor's input schema; mismatched or extra keys cause INVALID\_INPUT failures even when the API returns HTTP 200.
>
> **title** `string`
>
> Display title for the task.
>
> **options** `object`
>
> Task execution options such as memoryMbytes, timeoutSecs, build, diskMbytes. Note: Do NOT include 'input' here - use the separate 'input' field instead.
>
> **actorStandby** `object`
>
> Actor standby configuration for faster task startup. When actorStandby is used, build, maxRequestsPerActorRun, desiredRequestsPerActorRun, idleTimeoutSecs, memoryMbytes, and shouldPassActorInput must be provided.
>
> **original\_name** `string`
>
> Internal field to store original name before sanitization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Task Webhook
>
> **Slug:** `APIFY_CREATE_TASK_WEBHOOK`
>
> Tool to create a webhook for an Actor task. Use when you need external notifications about task run events (e.g., completion or failure) in downstream systems.
>
> #### Input Parameters
>
> **isAdHoc** `boolean`
>
> If true, webhook is ad hoc (single dispatch).
>
> **condition** `object` *required*
>
> Condition object specifying actor or task IDs.
>
> **eventTypes** `array` *required*
>
> List of event types that trigger the webhook, e.g., \['ACTOR.TASK.RUN.SUCCEEDED'].
>
> **requestUrl** `string` *required*
>
> Target URL to which Apify will POST the webhook payload.
>
> **description** `string`
>
> Description of the webhook.
>
> **idempotencyKey** `string`
>
> Unique key to prevent duplicate webhook creation.
>
> **headersTemplate** `string`
>
> JSON-like template for request headers. Some headers are managed by Apify.
>
> **payloadTemplate** `string`
>
> JSON-like template for the POST body. Handlebars variables allowed.
>
> **shouldInterpolateStrings** `boolean`
>
> Whether to interpolate variables inside strings in payloadTemplate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Dataset
>
> **Slug:** `APIFY_DATASET_DELETE`
>
> Tool to delete a dataset permanently. Use when you need to remove a dataset by its ID or username\~dataset-name. Confirm before calling.
>
> #### Input Parameters
>
> **datasetId** `string` *required*
>
> Unique identifier of the dataset to delete, in ID format or username\~dataset-name format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Dataset
>
> **Slug:** `APIFY_DATASET_GET`
>
> Tool to retrieve dataset metadata by dataset ID. Use when you need information about a dataset's structure, item counts, or access URLs. This does not return dataset items themselves.
>
> #### Input Parameters
>
> **datasetId** `string` *required*
>
> Identifier of the dataset to retrieve (e.g., 'username/datasetName' or dataset ID). Empty string returns a paginated list of all datasets.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Dataset
>
> **Slug:** `APIFY_DATASET_PUT`
>
> Tool to update a dataset's name via JSON payload. Use when you need to rename an existing dataset.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New name for the dataset.
>
> **datasetId** `string` *required*
>
> Dataset ID or username\~dataset-name format to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of datasets
>
> **Slug:** `APIFY_DATASETS_GET`
>
> Tool to get list of datasets for a user. Use when you need to enumerate or browse user's datasets. Supports pagination with up to 1000 items per page.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true or 1, sorts datasets by createdAt field in descending order (newest first). Default is false (ascending).
>
> **limit** `integer`
>
> Maximum number of datasets to return (pagination). Default and max is 1000.
>
> **offset** `integer`
>
> Number of items to skip at the start (pagination). Default is 0.
>
> **unnamed** `boolean`
>
> Whether to include unnamed datasets in the list. Unnamed datasets expire after 7 days unless otherwise specified. Default is false.
>
> **ownership** `string ("ownedByMe" | "sharedWithMe")`
>
> Ownership filter options for dataset listing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Dataset Statistics
>
> **Slug:** `APIFY_DATASET_STATISTICS_GET`
>
> Tool to get dataset field statistics by dataset ID. Use when you need statistical information about dataset fields including min, max, null count, and empty count. Only provides field statistics when dataset schema is configured.
>
> #### Input Parameters
>
> **datasetId** `string` *required*
>
> Identifier of the dataset to retrieve statistics for (e.g., 'username\~dataset-name' or dataset ID).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Actor
>
> **Slug:** `APIFY_DELETE_ACTOR`
>
> Tool to delete an Actor permanently. Use when you need to remove an Actor by its ID or username\~actorName. Confirm before calling.
>
> #### Input Parameters
>
> **actorId** `string` *required*
>
> Unique identifier of the Actor to delete, in ID format or username\~actorName format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook
>
> **Slug:** `APIFY_DELETE_WEBHOOK`
>
> Tool to delete a webhook by its ID. Use when removing a webhook after confirming the webhook ID.
>
> #### Input Parameters
>
> **webhookId** `string` *required*
>
> Unique identifier of the webhook to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Discover G2 Products
>
> **Slug:** `APIFY_DISCOVER_G2_PRODUCTS`
>
> Discover G2 software products with the fixed Actor in product-search mode, requesting up to 1,000 products and preserving separate rating fields. Runs may incur charges; managed calls require an explicit product quantity and use a shorter timeout.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.003 per product
>
> **Discount:** 40
>
> #### Input Parameters
>
> **maxProducts** `integer`
>
> Maximum matching software products to return.
>
> **searchQuery** `string` *required*
>
> Software product, category, or capability to search on G2.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Actor Details
>
> **Slug:** `APIFY_GET_ACTOR`
>
> Get details of a specific Actor by ID or username/actorName. The response can include deprecation status and pricing model information.
>
> #### Input Parameters
>
> **actorId** `string` *required*
>
> Actor ID as either: (1) username and actor name separated by tilde (~~) or forward slash (/), e.g., 'apify~~web-scraper' or 'apify/web-scraper', or (2) 24-character hexadecimal ID. Forward slashes are automatically converted to tildes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Actor Last Run Dataset Items
>
> **Slug:** `APIFY_GET_ACTOR_LAST_RUN_DATASET_ITEMS`
>
> Get dataset output from an Actor's last run, optionally filtered by run status. JSON and JSONL are returned as items; other text formats are wrapped as content, and XLSX content is base64-encoded.
>
> #### Input Parameters
>
> **bom** `boolean`
>
> Include UTF-8 Byte Order Mark in response.
>
> **desc** `boolean`
>
> If true, returns items in reverse order (newest to oldest).
>
> **omit** `string`
>
> Comma-separated list of fields to exclude from each item.
>
> **view** `string`
>
> Name of the dataset view to use.
>
> **clean** `boolean`
>
> Shortcut for skipHidden=true and skipEmpty=true. When true, removes Apify-specific metadata and empty items.
>
> **limit** `integer`
>
> Maximum number of items to return. API has a limit of 250,000 items per request.
>
> **fields** `string`
>
> Comma-separated list of fields to include in each item.
>
> **format** `string ("json" | "jsonl" | "csv" | "html" | "xlsx" | "xml" | "rss")`
>
> Output format for the dataset items. Default is JSON.
>
> **offset** `integer`
>
> Number of items to skip from the start (pagination). Default is 0.
>
> **status** `string ("READY" | "RUNNING" | "SUCCEEDED" | "FAILED" | "TIMING-OUT" | "TIMED-OUT" | "ABORTING" | "ABORTED")`
>
> Filter to return dataset items only from runs with a specific status (e.g., 'SUCCEEDED' ensures you get items from the last successful run).
>
> **unwind** `string`
>
> Field name to unwind array elements into separate items.
>
> **xmlRow** `string`
>
> XML element name for each item (default: 'item').
>
> **actorId** `string` *required*
>
> Actor ID or tilde-separated owner's username and Actor name (e.g., 'janedoe\~my-actor' or 'apify/hello-world').
>
> **flatten** `string`
>
> Comma-separated list of fields to flatten.
>
> **xmlRoot** `string`
>
> Root XML element name (default: 'items').
>
> **delimiter** `string`
>
> Delimiter character for CSV format (default: ',').
>
> **skipEmpty** `boolean`
>
> If true, skips empty items from results.
>
> **attachment** `boolean`
>
> If true, forces 'Content-Disposition: attachment' in the response.
>
> **skipHidden** `boolean`
>
> If true, skips fields beginning with '#' character.
>
> **skipHeaderRow** `boolean`
>
> Skip header row in CSV format.
>
> **skipFailedPages** `boolean`
>
> If true, excludes items with errorInfo property.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get all webhooks
>
> **Slug:** `APIFY_GET_ALL_WEBHOOKS`
>
> Tool to get a list of all webhooks created by the user. Use when you need to enumerate webhooks before filtering or maintenance.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true, sort results in descending order (by creation date).
>
> **limit** `integer`
>
> Maximum number of webhooks to return (pagination). Must be >= 1.
>
> **offset** `integer`
>
> Number of webhooks to skip at the start (pagination). Must be >= 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CARFAX Report by VIN
>
> **Slug:** `APIFY_GET_CARFAX_REPORT_BY_VIN`
>
> Check CARFAX report availability or purchase PDFs by VIN with easytools/carfax-report-by-vin; checks and AUTO\_PURCHASE purchases are paid. A maximum charge is required, managed calls impose a lower spend cap and shorter timeout, and a timed-out run may continue.
>
> #### Input Parameters
>
> **mode** `string ("CHECK_ONLY" | "AUTO_PURCHASE")` *required*
>
> Required purchase decision. CHECK\_ONLY performs paid availability checks without buying PDFs. AUTO\_PURCHASE irreversibly buys each available report for \$3.50 and returns its PDF link.
>
> **vinCodes** `string` *required*
>
> One or more 17-character alphanumeric VINs as a single VIN, comma/newline-separated text, or a JSON array encoded as text. The Actor uppercases and deduplicates VINs in first-seen order.
>
> **maxTotalChargeUsd** `number` *required*
>
> Required maximum total run charge in USD for availability checks or report purchases.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get dataset items
>
> **Slug:** `APIFY_GET_DATASET_ITEMS`
>
> Tool to retrieve items from a dataset. Use when you need to fetch data from a specified dataset by pagination or filtering. Only JSON format is fully supported. For datasets larger than 1000 items, issue multiple calls incrementing `offset` by `limit` until the response returns fewer items than `limit`.
>
> #### Input Parameters
>
> **bom** `boolean`
>
> If true, includes BOM header in CSV output.
>
> **desc** `boolean`
>
> If true, return items in reverse order. Default is ascending.
>
> **omit** `string`
>
> Comma-separated list of fields to exclude from the returned items.
>
> **clean** `boolean`
>
> When true, removes any Apify-specific metadata from items.
>
> **limit** `integer`
>
> Maximum number of items to return (pagination). Default and max is 1000. For full dataset retrieval, paginate with multiple calls using `offset`, stopping when response count is less than `limit`.
>
> **fields** `string`
>
> Comma-separated list of fields to include in the returned items.
>
> **format** `string ("json" | "csv" | "xlsx")`
>
> Output format of dataset items. Only 'json' is fully supported.
>
> **offset** `integer`
>
> Number of items to skip (pagination). Default is 0.
>
> **unwind** `string`
>
> Name of the field to unwind into multiple items.
>
> **flatten** `boolean`
>
> If true, flattens nested JSON into a single level for CSV.
>
> **datasetId** `string` *required*
>
> Identifier of the dataset to retrieve items from (e.g., 'username/datasetName' or dataset ID).
>
> **delimiter** `string`
>
> Delimiter to use for CSV format.
>
> **offsetKey** `string`
>
> Key to use for pagination instead of numeric offset.
>
> **skipEmpty** `boolean`
>
> If true, skips empty rows in CSV output.
>
> **attachment** `boolean`
>
> If true, forces 'Content-Disposition: attachment' in the response.
>
> **skipHidden** `boolean`
>
> If true, skips hidden items (include only visible items).
>
> **asciiHeaders** `boolean`
>
> If true, forces ASCII-only headers in CSV format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Default Build
>
> **Slug:** `APIFY_GET_DEFAULT_BUILD`
>
> Tool to get the default build for an Actor. Use after specifying the Actor ID; optionally wait for the build to finish before returning.
>
> #### Input Parameters
>
> **actorId** `string` *required*
>
> Actor ID or owner's username and Actor name separated by tilde or slash (e.g. 'janedoe\~my-actor' or 'janedoe/my-actor'). Both formats are accepted.
>
> **waitForFinish** `number`
>
> Maximum number of seconds to wait synchronously for the build to finish. If omitted or 0, returns immediately with the current status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Key-Value Record
>
> **Slug:** `APIFY_GET_KEY_VALUE_RECORD`
>
> Retrieve a record by key from an Apify key-value store. The response indicates whether the record was found and returns text content or base64-encoded binary content with its content type.
>
> #### Input Parameters
>
> **format** `string ("json" | "xml" | "html" | "text")`
>
> Desired format of the retrieved record.
>
> **storeId** `string` *required*
>
> ID of the key-value store.
>
> **recordKey** `string` *required*
>
> Key of the record to retrieve.
>
> **attachment** `boolean`
>
> If true, force the response as an attachment (for browser downloads).
>
> **disableRedirect** `boolean`
>
> If true, do not redirect to the raw value; return metadata only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of builds
>
> **Slug:** `APIFY_GET_LIST_OF_BUILDS`
>
> Tool to get a list of builds for a specific Actor. Use when you need paginated access to an Actor’s build (version) history.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true, sort builds by creation date descending.
>
> **limit** `integer`
>
> Maximum number of builds to retrieve (pagination).
>
> **offset** `integer`
>
> Number of builds to skip (pagination).
>
> **status** `string ("RUNNING" | "SUCCEEDED" | "FAILED" | "ABORTED")`
>
> Filter builds by status.
>
> **actorId** `string` *required*
>
> Actor ID or '\<username>/\<actorName>' to list builds for.
>
> **unnamed** `boolean`
>
> If true, return only unnamed builds.
>
> **waitForFinish** `integer`
>
> Seconds to wait for build to finish before returning.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of runs
>
> **Slug:** `APIFY_GET_LIST_OF_RUNS`
>
> Tool to get a list of runs for a specific Actor. Use when you need to paginate through runs and optionally filter by status before processing run data.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true, sort by startedAt descending. Default is ascending.
>
> **limit** `integer`
>
> Maximum number of runs to return (pagination). Default and max is 1000.
>
> **offset** `integer`
>
> Number of runs to skip at the start (pagination). Default is 0.
>
> **status** `string ("READY" | "RUNNING" | "SUCCEEDED" | "FAILED" | "TIMING-OUT" | "TIMED-OUT" | "ABORTING" | "ABORTED")`
>
> Filter runs by this lifecycle status.
>
> **actorId** `string` *required*
>
> Actor ID (e.g., 'HG7ML7M8z78YcAPEB') or a tilde-separated owner username and Actor name (e.g., 'janedoe\~my-actor'). If provided in 'username/actorName' format, it will be automatically converted to use tilde separator.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of task runs
>
> **Slug:** `APIFY_GET_LIST_OF_TASK_RUNS`
>
> Tool to get a list of runs for a specific Actor task. Use when you need to paginate through task runs and optionally filter by status.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true, sort by startedAt descending. Default is ascending.
>
> **limit** `integer`
>
> Maximum number of array elements to return. Default and max is 1000.
>
> **offset** `integer`
>
> Number of array elements to skip. Default is 0.
>
> **status** `string ("READY" | "RUNNING" | "SUCCEEDED" | "FAILED" | "TIMING-OUT" | "TIMED-OUT" | "ABORTING" | "ABORTED")`
>
> Filter runs by this lifecycle status.
>
> **actorTaskId** `string` *required*
>
> Task ID or '\<username>\~\<taskName>' identifying the task.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of tasks
>
> **Slug:** `APIFY_GET_LIST_OF_TASKS`
>
> Tool to fetch a paginated list of tasks belonging to the authenticated user. Use when you need to browse or sort tasks created by the user.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true, sort by createdAt descending. Default is ascending.
>
> **limit** `integer`
>
> Maximum number of records to return (pagination). Default and max is 1000.
>
> **offset** `integer`
>
> Number of records to skip at the start (pagination). Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of task webhooks
>
> **Slug:** `APIFY_GET_LIST_OF_TASK_WEBHOOKS`
>
> Tool to get a list of webhooks for a specific Actor task. Use when you need to review or paginate webhooks after creating or updating a task.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true, sort by createdAt descending. Default is ascending.
>
> **limit** `integer`
>
> Maximum number of webhooks to return (pagination). Default and max is 1000.
>
> **offset** `integer`
>
> Number of webhooks to skip at the start (pagination). Default is 0.
>
> **actorTaskId** `string` *required*
>
> Actor task ID or '\<username>\~\<taskName>' to list webhooks for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get log
>
> **Slug:** `APIFY_GET_LOG`
>
> Tool to retrieve logs for a specific Actor run or build. Use after a run completes or fails — a run may report success status yet contain only informational messages, making log inspection the only way to confirm actual outcomes. For long runs, log responses can be very large; prioritize error-level entries and recent timestamps to diagnose issues efficiently.
>
> #### Input Parameters
>
> **buildOrRunId** `string` *required*
>
> ID of the Actor run or build to retrieve the log for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get OpenAPI Definition
>
> **Slug:** `APIFY_GET_OPEN_API_DEFINITION`
>
> Tool to get the OpenAPI definition for a specific Actor build. Use when you need the API schema for code generation or analysis.
>
> #### Input Parameters
>
> **token** `string`
>
> API authentication token. Only required for private Actors; public Actors can be queried without one.
>
> **actorId** `string`
>
> Actor ID or tilde-separated owner's username and Actor name. Required when using 'default' as buildId.
>
> **buildId** `string` *required*
>
> ID of the build to retrieve, or 'default' for the default Actor build.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Run Dataset Items
>
> **Slug:** `APIFY_GET_RUN_DATASET_ITEMS`
>
> Tool to get dataset items from a specific Actor run. Use when you need to retrieve the output data from a completed or running Actor run.
>
> #### Input Parameters
>
> **bom** `boolean`
>
> Include BOM (Byte Order Mark) in CSV output.
>
> **desc** `boolean`
>
> If true, returns items in reverse order (newest to oldest).
>
> **omit** `string`
>
> Comma-separated list of fields to exclude from each item.
>
> **view** `string`
>
> Applies a predefined dataset view.
>
> **clean** `boolean`
>
> When true, removes any Apify-specific metadata from items.
>
> **limit** `integer`
>
> Maximum number of items to return. Default depends on format.
>
> **runId** `string` *required*
>
> The unique identifier of the Actor run to retrieve dataset items from.
>
> **fields** `string`
>
> Comma-separated list of fields to include in each item.
>
> **format** `string ("json" | "jsonl" | "csv" | "html" | "xlsx" | "xml" | "rss")`
>
> Output format for the dataset items. Default is JSON.
>
> **offset** `integer`
>
> Number of items to skip from the start (pagination). Default is 0.
>
> **unwind** `string`
>
> Field name to unwind array elements into separate items.
>
> **xmlRow** `string`
>
> Customizes individual item XML element wrapper name.
>
> **flatten** `string`
>
> Comma-separated list of fields to flatten.
>
> **xmlRoot** `string`
>
> Customizes root XML element wrapper name.
>
> **delimiter** `string`
>
> Delimiter character for CSV format.
>
> **skipEmpty** `boolean`
>
> If true, skips empty items from results.
>
> **attachment** `boolean`
>
> If true, forces 'Content-Disposition: attachment' in the response.
>
> **skipHidden** `boolean`
>
> If true, skips fields beginning with '#' character.
>
> **skipHeaderRow** `boolean`
>
> Skips header row in CSV output.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Run Default Dataset
>
> **Slug:** `APIFY_GET_RUN_DEFAULT_DATASET`
>
> Get metadata for an Actor run's default dataset, not its items. This API read and later dataset storage/reads contribute to Apify usage and monthly charging. The default API resource limit is 60 requests per second.
>
> #### Input Parameters
>
> **runId** `string` *required*
>
> Actor run ID whose default dataset metadata will be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Run Default Key-Value Store
>
> **Slug:** `APIFY_GET_RUN_DEFAULT_KEY_VALUE_STORE`
>
> Get metadata for an Actor run's default key-value store, not record values. This API read and later record storage/reads contribute to Apify usage and monthly charging. The default API resource limit is 60 requests per second.
>
> #### Input Parameters
>
> **runId** `string` *required*
>
> Actor run ID whose default key-value store metadata will be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Run Default Request Queue
>
> **Slug:** `APIFY_GET_RUN_DEFAULT_REQUEST_QUEUE`
>
> Get metadata for an Actor run's default request queue, not queued requests. This API read and later queue storage/reads contribute to Apify usage and monthly charging. The default API resource limit is 60 requests per second.
>
> #### Input Parameters
>
> **runId** `string` *required*
>
> Actor run ID whose default request queue metadata will be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Run Input
>
> **Slug:** `APIFY_GET_RUN_INPUT`
>
> Retrieve the exact JSON input supplied to an Actor run.
>
> #### Input Parameters
>
> **runId** `string` *required*
>
> Actor run ID whose submitted input should be retrieved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Task Input
>
> **Slug:** `APIFY_GET_TASK_INPUT`
>
> Tool to retrieve the input configuration of a specific task. Use when you need to inspect stored task input before execution or debugging.
>
> #### Input Parameters
>
> **taskId** `string` *required*
>
> Unique identifier of the Actor task to retrieve input for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Task Last Run Dataset Items
>
> **Slug:** `APIFY_GET_TASK_LAST_RUN_DATASET_ITEMS`
>
> Get dataset items from the last run of an Actor task, optionally filtering runs by status. JSON and JSONL are returned as items; other formats are wrapped as content, with XLSX encoded in base64.
>
> #### Input Parameters
>
> **bom** `boolean`
>
> Include UTF-8 Byte Order Mark in response (default varies by format).
>
> **desc** `boolean`
>
> Return results in reverse order (newest to oldest).
>
> **omit** `string`
>
> Comma-separated list of fields to exclude from output.
>
> **view** `string`
>
> Name of the dataset view to use.
>
> **clean** `boolean`
>
> Shortcut for skipHidden=true and skipEmpty=true.
>
> **limit** `integer`
>
> Maximum number of items to return (max: 250000).
>
> **fields** `string`
>
> Comma-separated list of fields to include in output.
>
> **format** `string ("json" | "jsonl" | "csv" | "html" | "xlsx" | "xml" | "rss")`
>
> Output format - json, jsonl, csv, html, xlsx, xml, rss.
>
> **offset** `integer`
>
> Number of items to skip from the start (default: 0).
>
> **status** `string ("READY" | "RUNNING" | "SUCCEEDED" | "FAILED" | "TIMING-OUT" | "TIMED-OUT" | "ABORTING" | "ABORTED")`
>
> Filter to return dataset items only from runs matching this status (e.g., 'SUCCEEDED' for last successful run).
>
> **unwind** `string`
>
> Field name to unwind array elements into separate items.
>
> **xmlRow** `string`
>
> XML element name for each item (default: 'item').
>
> **flatten** `string`
>
> Comma-separated list of fields to flatten.
>
> **xmlRoot** `string`
>
> Root XML element name (default: 'items').
>
> **delimiter** `string`
>
> Delimiter character for CSV files (default: ',').
>
> **skipEmpty** `boolean`
>
> Skip empty items from output.
>
> **attachment** `boolean`
>
> Force browser download via Content-Disposition header.
>
> **skipHidden** `boolean`
>
> Exclude fields starting with '#'.
>
> **actorTaskId** `string` *required*
>
> Task ID or '\<username>\~\<taskName>' identifying the actor task.
>
> **skipHeaderRow** `boolean`
>
> Skip header row in CSV format.
>
> **skipFailedPages** `boolean`
>
> Exclude items with errorInfo (failed pages).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get US Fuel Price Averages
>
> **Slug:** `APIFY_GET_US_FUEL_PRICE_AVERAGES`
>
> Get a national US fuel-price average using the third-party crawlerbros/fuel-prices-scraper. This paid Actor run requests one result and may include history even when history is not requested; a run may continue after a synchronous timeout.
>
> #### Input Parameters
>
> **maxItems** `integer`
>
> Fixed one-record limit for the national US aggregate.
>
> **fuelTypes** `array`
>
> Fuel grades to include in the national average record.
>
> **includeHistory** `boolean`
>
> Request historical comparison values; national records may include history even when false.
>
> **primaryFuelType** `string ("regular" | "midgrade" | "premium" | "diesel")`
>
> Fuel grade used by the Actor for primary sorting and comparison semantics.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **includeChangeMetrics** `boolean`
>
> Request price-change metrics when the Actor makes them available.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Key-Value Store
>
> **Slug:** `APIFY_KEY_VALUE_STORE_DELETE`
>
> Tool to delete a key-value store permanently. Use when you need to remove a key-value store by its ID. Confirm before calling.
>
> #### Input Parameters
>
> **storeId** `string` *required*
>
> Unique identifier of the key-value store to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Key-Value Store
>
> **Slug:** `APIFY_KEY_VALUE_STORE_GET`
>
> Tool to retrieve key-value store metadata by store ID. Use when you need detailed information about a specific key-value store including stats and access URLs.
>
> #### Input Parameters
>
> **storeId** `string` *required*
>
> Identifier of the key-value store to retrieve. Can be the store ID or username/store-name format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Key-Value Store Keys
>
> **Slug:** `APIFY_KEY_VALUE_STORE_KEYS_GET`
>
> Tool to retrieve a list of keys from a key-value store. Use when you need to list keys in a store with optional filtering and pagination support.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of keys to return. Maximum value is 1000.
>
> **prefix** `string`
>
> Limits results to keys starting with the specified prefix.
>
> **storeId** `string` *required*
>
> Key-value store ID or 'username\~store-name'.
>
> **signature** `string`
>
> Signature used to access the keys.
>
> **collection** `string`
>
> Filters results to keys in a specific collection. Requires the store to have a schema.
>
> **exclusiveStartKey** `string`
>
> All keys up to this one (including) are skipped from the result. Used for pagination.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Key-Value Store Record
>
> **Slug:** `APIFY_KEY_VALUE_STORE_RECORD_DELETE`
>
> Tool to delete a record from a key-value store. Use when you need to remove a specific record by its key from an Apify Key-Value Store.
>
> #### Input Parameters
>
> **storeId** `string` *required*
>
> Identifier of the key-value store.
>
> **recordKey** `string` *required*
>
> The record's unique identifier to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Key-Value Store Record Exists
>
> **Slug:** `APIFY_KEY_VALUE_STORE_RECORD_HEAD`
>
> Tool to check if a record exists in a key-value store. Use when you need to verify whether a specific key exists in an Apify Key-Value Store without retrieving its content.
>
> #### Input Parameters
>
> **storeId** `string` *required*
>
> Identifier of the key-value store. Can be the store ID or username\~store-name format.
>
> **recordKey** `string` *required*
>
> The key of the record to verify existence.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of key-value stores
>
> **Slug:** `APIFY_KEY_VALUE_STORES_GET`
>
> Tool to get the list of key-value stores owned by the user. Use when you need to enumerate or browse available stores. Supports pagination up to 1000 records per request.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true or 1, sorts stores by createdAt field in descending order. Default is false (ascending).
>
> **limit** `integer`
>
> Maximum number of records to return (pagination). Maximum is 1000.
>
> **offset** `integer`
>
> Number of records to skip at the start (pagination). Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Key-Value Store
>
> **Slug:** `APIFY_KEY_VALUE_STORES_POST`
>
> Tool to create a new key-value store or retrieve an existing one by name. Use when you need to initialize a store for saving data records or files. If a store with the given name already exists, returns that store instead of creating a duplicate.
>
> #### Input Parameters
>
> **name** `string`
>
> Optional name for the key-value store. If provided, creates or retrieves a store with this name. If omitted, a random name is generated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List User Actor Runs
>
> **Slug:** `APIFY_LIST_USER_RUNS`
>
> Tool to get a paginated list of all Actor runs for the authenticated user. Use when you need to browse all runs across all actors, optionally filtered by status or date range.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true or 1 then the objects are sorted by the startedAt field in descending order. By default, they are sorted in ascending order.
>
> **limit** `integer`
>
> Maximum number of array elements to return. The default value (as well as the maximum) is 1000.
>
> **offset** `integer`
>
> Number of array elements that should be skipped at the start. The default value is 0.
>
> **status** `string`
>
> Single status or comma-separated list of statuses to filter runs by. Available statuses: READY, RUNNING, SUCCEEDED, FAILED, TIMING-OUT, TIMED-OUT, ABORTING, ABORTED.
>
> **startedAfter** `string`
>
> Filter runs that started after the specified date and time (inclusive). The value must be a valid ISO 8601 datetime string (UTC).
>
> **startedBefore** `string`
>
> Filter runs that started before the specified date and time (inclusive). The value must be a valid ISO 8601 datetime string (UTC).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Request Queue
>
> **Slug:** `APIFY_REQUEST_QUEUE_DELETE`
>
> Tool to delete a request queue permanently. Use when you need to remove a request queue by its ID.
>
> #### Input Parameters
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Request Queue
>
> **Slug:** `APIFY_REQUEST_QUEUE_GET`
>
> Tool to retrieve request queue metadata by queue ID. Use when you need information about a specific request queue including its statistics and request counts.
>
> #### Input Parameters
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue to retrieve. Can be queue ID or 'username\~queue-name' format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Request Queue Head
>
> **Slug:** `APIFY_REQUEST_QUEUE_HEAD_GET`
>
> Tool to retrieve first requests from the queue for inspection. Use when you need to examine pending requests without locking them.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of requests to return from the queue head. Must be >= 1.
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue. Can be queue ID or 'username\~queue-name' format.
>
> **clientKey** `string`
>
> A client identifier used for tracking queue access by multiple clients. Used to determine cache consistency.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Head and Lock Queue Requests
>
> **Slug:** `APIFY_REQUEST_QUEUE_HEAD_LOCK_POST`
>
> Tool to get and lock head requests from the queue. Returns the given number of first requests from the queue and locks them for the given time, preventing other clients from accessing them during the lock period. Use when you need to process requests exclusively without concurrent access by other clients.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of requests to retrieve and lock from the queue head. Must be between 1 and 25. If not specified, returns all available unlocked requests.
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue. Can be queue ID or 'username\~queue-name' format.
>
> **lockSecs** `integer` *required*
>
> How long the requests will be locked for, in seconds. Specifies the duration of the lock before it expires and the requests become available again.
>
> **clientKey** `string`
>
> A unique identifier of the client accessing the request queue. Must be a string between 1 and 32 characters in length. Used to determine whether the queue was accessed by multiple clients.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Request Queue
>
> **Slug:** `APIFY_REQUEST_QUEUE_PUT`
>
> Tool to update request queue name using JSON payload. Use when you need to rename an existing request queue.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The new name for the request queue.
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue to update. Can be queue ID or 'username\~queue-name' format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Request from Queue
>
> **Slug:** `APIFY_REQUEST_QUEUE_REQUEST_DELETE`
>
> Tool to delete a specific request from a request queue. Use when you need to remove a request by its ID from an Apify request queue.
>
> #### Input Parameters
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue.
>
> **requestId** `string` *required*
>
> Unique identifier of the request to delete from the queue.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Request from Queue
>
> **Slug:** `APIFY_REQUEST_QUEUE_REQUEST_GET`
>
> Tool to retrieve a specific request from a request queue by its ID. Use when you need to get detailed information about a request in an Apify request queue.
>
> #### Input Parameters
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue containing the request.
>
> **requestId** `string` *required*
>
> Unique identifier of the specific request to retrieve from the queue.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Request Lock
>
> **Slug:** `APIFY_REQUEST_QUEUE_REQUEST_LOCK_DELETE`
>
> Tool to delete a request lock from a request queue. Use when you need to unlock a previously locked request. Only the client that locked the request can delete its lock.
>
> #### Input Parameters
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue, or username\~queue-name format.
>
> **clientKey** `string` *required*
>
> Unique client identifier (1-32 characters) used for lock/unlock operations. Must match the key that created the lock.
>
> **forefront** `boolean`
>
> Determines queue position after lock removal. If true, request moves to head; if false, moves to end.
>
> **requestId** `string` *required*
>
> Unique identifier of the request whose lock should be deleted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Prolong Request Lock
>
> **Slug:** `APIFY_REQUEST_QUEUE_REQUEST_LOCK_PUT`
>
> Tool to prolong request lock in a request queue. Use when you need to extend the lock duration on a previously locked request. Only the client that locked the request can prolong its lock.
>
> #### Input Parameters
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue, or username\~queue-name format.
>
> **lockSecs** `number` *required*
>
> Duration in seconds for how long the request lock will be prolonged.
>
> **clientKey** `string` *required*
>
> Unique client identifier (1-32 characters) used for lock authorization. Must match the key that created the original lock.
>
> **forefront** `string`
>
> Determines if request should be added to the head of the queue or to the end after lock expires. If not specified, the request stays in its current position.
>
> **requestId** `string` *required*
>
> Unique identifier of the request whose lock should be prolonged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Request in Queue
>
> **Slug:** `APIFY_REQUEST_QUEUE_REQUEST_PUT`
>
> Tool to update a request in a request queue. Use when you need to modify request properties or mark a request as handled by setting handledAt to the current date/time. If handledAt is set, the request will be removed from the head of the queue and unlocked if applicable.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Request identifier.
>
> **url** `string` *required*
>
> URL of the web page to crawl. Must be a non-empty string.
>
> **method** `string`
>
> HTTP method (e.g., 'GET', 'POST'). Defaults to 'GET' if not specified.
>
> **headers** `object`
>
> HTTP headers as key-value pairs. Key is header name, value is the value.
>
> **noRetry** `boolean`
>
> The true value indicates that the request will not be automatically retried on error.
>
> **payload** `string`
>
> HTTP request payload, e.g., for POST requests.
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue, or username\~queue-name format.
>
> **userData** `object`
>
> Custom user data assigned to the request.
>
> **clientKey** `string`
>
> Client identifier string between 1 and 32 characters in length.
>
> **forefront** `boolean`
>
> Boolean determining queue position. If true, places request at the beginning of the queue. Default: false.
>
> **handledAt** `string`
>
> ISO 8601 timestamp when the request has been processed. Set to current date/time (e.g., '2025-12-06T14:42:30.000Z') to mark request as handled and remove from queue head. Is null if the request has not been crawled yet.
>
> **loadedUrl** `string`
>
> The actual URL after any redirects occur.
>
> **requestId** `string` *required*
>
> Unique identifier of the request to update in the queue.
>
> **uniqueKey** `string` *required*
>
> A unique key identifying the request. Two requests with the same uniqueKey are considered as pointing to the same URL.
>
> **retryCount** `integer`
>
> Indicates the number of times the crawling of the request has been retried on error.
>
> **errorMessages** `array`
>
> An array of error messages from request processing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Delete Requests from Queue
>
> **Slug:** `APIFY_REQUEST_QUEUE_REQUESTS_BATCH_DELETE`
>
> Tool to batch-delete up to 25 requests from a queue. Use when you need to remove multiple requests efficiently. Failed requests due to rate limits should be retried with exponential backoff.
>
> #### Input Parameters
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue.
>
> **requests** `array` *required*
>
> Array of requests to delete (max 25 items). Each request must contain either id or uniqueKey.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Add Requests to Queue
>
> **Slug:** `APIFY_REQUEST_QUEUE_REQUESTS_BATCH_POST`
>
> Tool to batch-add up to 25 requests to a request queue. Use when you need to add multiple requests efficiently. Failed requests due to rate limits should be retried with exponential backoff.
>
> #### Input Parameters
>
> **queueId** `string` *required*
>
> Request queue ID or username\~queue-name format.
>
> **requests** `array` *required*
>
> Array of requests to add to the queue (max 25 items). Each request must contain url, uniqueKey, and method fields.
>
> **clientKey** `string`
>
> Unique identifier of the client accessing the request queue. Must be 1-32 characters.
>
> **forefront** `boolean`
>
> Add requests to queue head (true) or end (false). Default: false
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Request Queue Requests
>
> **Slug:** `APIFY_REQUEST_QUEUE_REQUESTS_GET`
>
> Tool to list requests in a request queue with pagination support. Use when you need to retrieve multiple requests from an Apify request queue.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of requests to return per page.
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue to list requests from. Can be queue ID or 'username\~queue-name' format.
>
> **exclusiveStartId** `string`
>
> All requests up to this one (including) are skipped from the result. Used for pagination to specify where to start fetching results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Request to Queue
>
> **Slug:** `APIFY_REQUEST_QUEUE_REQUESTS_POST`
>
> Tool to add a request to the queue. Use when you need to add a web page URL to a request queue for crawling. If a request with the same uniqueKey was already present in the queue, returns the ID of the existing request.
>
> #### Input Parameters
>
> **id** `string`
>
> Request ID.
>
> **url** `string` *required*
>
> URL of the web page to crawl.
>
> **method** `string`
>
> HTTP method for the request.
>
> **headers** `object`
>
> Object with HTTP headers where key is header name and value is the header value.
>
> **noRetry** `boolean`
>
> When true, prevents automatic retry attempts on failure.
>
> **payload** `string`
>
> HTTP request payload, e.g. for POST requests.
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue. Can be queue ID or 'username\~queue-name' format.
>
> **userData** `object`
>
> Custom user data assigned to the request to save any request-related data to the request's scope, keeping them accessible on retries, failures, etc.
>
> **clientKey** `string`
>
> A client identifier string between 1 and 32 characters. Used to determine whether the queue was accessed by multiple clients. If not provided, the system considers this API call to come from a new client.
>
> **forefront** `boolean`
>
> Whether to add the request to the head (true) or the end (false) of the queue. When true, enables depth-first crawling; when false or omitted, enables breadth-first crawling.
>
> **handledAt** `string`
>
> Timestamp of completion in ISO 8601 format.
>
> **loadedUrl** `string`
>
> Final URL after redirects.
>
> **uniqueKey** `string`
>
> A unique key identifying the request for deduplication. Two requests with the same uniqueKey are considered as pointing to the same URL. If not provided, the URL is used as uniqueKey.
>
> **retryCount** `integer`
>
> Count of retry attempts following errors.
>
> **errorMessages** `array`
>
> Collection of error descriptions from processing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unlock Queue Requests
>
> **Slug:** `APIFY_REQUEST_QUEUE_REQUESTS_UNLOCK_POST`
>
> Tool to unlock requests in a request queue that are currently locked by the client. If the client is within an Actor run, unlocks all requests locked by that specific run plus all requests locked by the same clientKey. If the client is outside of an Actor run, unlocks all requests locked using the same clientKey.
>
> #### Input Parameters
>
> **queueId** `string` *required*
>
> Unique identifier of the request queue containing the locked requests.
>
> **clientKey** `string`
>
> Unique client identifier (1-32 characters) used for lock/unlock operations. If within an Actor run, unlocks all requests locked by that run plus those locked by this clientKey. If outside an Actor run, unlocks all requests locked by this clientKey.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of request queues
>
> **Slug:** `APIFY_REQUEST_QUEUES_GET`
>
> Tool to get list of request queues for a user. Use when you need to enumerate or browse user's request queues. Supports pagination with up to 1000 items per page.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true or 1, sorts request queues by createdAt field in descending order (newest first). Default is false (ascending).
>
> **limit** `integer`
>
> Maximum number of request queues to return (pagination). Maximum value is 1000.
>
> **offset** `integer`
>
> Number of request queues to skip at the start (pagination). Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Request Queue
>
> **Slug:** `APIFY_REQUEST_QUEUES_POST`
>
> Tool to create a new request queue or retrieve an existing one by name. Use when you need to initialize a queue for storing and managing web scraping requests. If a queue with the given name already exists, returns that queue instead of creating a duplicate. Unnamed queues follow data retention period policies.
>
> #### Input Parameters
>
> **name** `string`
>
> Custom unique name to easily identify the queue in the future. If a queue with this name already exists, the existing queue object will be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resurrect Run
>
> **Slug:** `APIFY_RESURRECT_RUN`
>
> Tool to resurrect a finished Actor run. Use when you need to restart a completed or failed run. Deprecated endpoint; may be removed in future.
>
> #### Input Parameters
>
> **runId** `string` *required*
>
> ID of the Actor run to resurrect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Actor Asynchronously
>
> **Slug:** `APIFY_RUN_ACTOR`
>
> Start an Actor run and return its run details. The request can optionally wait for the run to finish before returning.
>
> #### Input Parameters
>
> **body** `object`
>
> JSON input object passed to the Actor. IMPORTANT: Each Actor has its own required input fields - check the Actor's documentation on Apify Store for its input schema. Common examples: (1) apify/web-scraper REQUIRES both 'startUrls' (array of \{url: string}) AND 'pageFunction' (JavaScript async function string); (2) Simple actors like apify/hello-world may work with empty \{}; (3) Search actors may require 'queries' as a string. Always check the specific Actor's input schema before running.
>
> **build** `string`
>
> Specifies the Actor build to run (tag or build number). Defaults to default run config.
>
> **memory** `number`
>
> Memory limit for the run, in megabytes. Must be power of 2 and at least 128.
>
> **actorId** `string` *required*
>
> Actor ID or '\<username>~~\<actorName>' (tilde) or '\<username>/\<actorName>' (forward slash), e.g. 'john~~my-actor' or 'john/my-actor'.
>
> **timeout** `number`
>
> Optional timeout for the run, in seconds. Default uses actor's default timeout.
>
> **maxItems** `number`
>
> Maximum number of items that the Actor run should return.
>
> **webhooks** `string`
>
> Base64-encoded JSON array of webhook definitions.
>
> **waitForFinish** `number`
>
> Max seconds the server waits for the run to finish. Default 0, max 60.
>
> **maxTotalChargeUsd** `number`
>
> Specifies the maximum cost of the Actor run in USD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Actor Sync
>
> **Slug:** `APIFY_RUN_ACTOR_SYNC`
>
> Tool to run a specific Actor synchronously with input and return its output record. Use when immediate Actor results are needed; runs may timeout after 300 seconds. To avoid timeouts, scope inputs to specific URLs rather than broad crawls and request only necessary fields (e.g., text or markdown).
>
> #### Input Parameters
>
> **build** `string`
>
> Build tag or number to run (default Actor's default build, usually 'latest').
>
> **input** `object` *required*
>
> JSON object passed as input to the Actor run.
>
> **memory** `integer`
>
> Memory limit in MB; power of two, minimum 128. Uses default if unset.
>
> **actorId** `string` *required*
>
> Actor ID or a tilde-separated owner and actor name (e.g., 'user\~actor-name'). If provided with a forward slash (e.g., 'user/actor-name'), it will be automatically converted to the tilde format.
>
> **timeout** `number`
>
> Run timeout in seconds. Uses Actor default if unset; HTTP wait max 300s.
>
> **maxItems** `integer`
>
> Maximum number of dataset items to return.
>
> **webhooks** `string`
>
> Base64-encoded JSON array defining webhooks for run notifications.
>
> **outputRecordKey** `string`
>
> Key of the record in the default key-value store to return (default 'OUTPUT').
>
> **maxTotalChargeUsd** `number`
>
> Maximum total charge in USD for the run. For pay-per-result actors, this parameter is required and must be at least \$1.00. Officially documented for pay-per-event actors but also enforced by pay-per-result actors. Set this to control spending limits.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Actor Sync & Get Dataset Items
>
> **Slug:** `APIFY_RUN_ACTOR_SYNC_GET_DATASET_ITEMS`
>
> Tool to run an Actor synchronously and retrieve its dataset items. Use when immediate access to run results is needed.
>
> #### Input Parameters
>
> **bom** `boolean`
>
> Include BOM (Byte Order Mark) in CSV output.
>
> **desc** `boolean`
>
> Returns results in reverse order (newest to oldest).
>
> **omit** `string`
>
> Comma-separated list of fields to exclude from each item.
>
> **view** `string`
>
> Applies a predefined dataset view.
>
> **build** `string`
>
> Tag or number of the Actor build to run (e.g., 'beta' or '1.2.345').
>
> **clean** `boolean`
>
> Equivalent to skipHidden=true and skipEmpty=true.
>
> **input** `object`
>
> JSON input object passed to the Actor run. CRITICAL: Each Actor has its own unique input schema with specific field names - you MUST use the exact field names defined by that Actor or the run will fail. Check the Actor's input schema at [https://apify.com/store](https://apify.com/store) before calling. URL FORMATTING: Always include full protocol (https\://) in URLs. Actors use different URL formats - some accept plain strings, many require objects with a 'url' property (e.g., \{'startUrls': \[\{'url': 'https\://...'}]}). Check the Actor's input schema to determine which format is required. Most Actors expect enum values in lowercase (e.g., 'relevance' not 'RELEVANCE').
>
> **limit** `integer`
>
> Maximum number of items to return.
>
> **fields** `string`
>
> Comma-separated list of fields to include in each item.
>
> **format** `string ("json" | "jsonl" | "csv" | "html" | "xlsx" | "xml" | "rss")`
>
> Response format. Default: 'json'.
>
> **memory** `integer`
>
> Memory limit for the Actor run in megabytes.
>
> **offset** `integer`
>
> Number of items to skip from the start.
>
> **unwind** `string`
>
> Field name to unwind array elements into separate items.
>
> **xmlRow** `string`
>
> Customizes individual item XML element wrapper name.
>
> **actorId** `string` *required*
>
> Actor ID or name in format 'username/actor-name' or 'username\~actor-name'. The actor must exist on Apify Store. Find actors at [https://apify.com/store](https://apify.com/store) - use the exact username and actor name shown (e.g., 'compass/crawler-google-places' for Google Maps Scraper, not 'apify/google-maps-scraper').
>
> **flatten** `string`
>
> Comma-separated list of fields to flatten.
>
> **timeout** `integer`
>
> Timeout for the Actor run in seconds. Zero means no timeout.
>
> **xmlRoot** `string`
>
> Customizes root XML element wrapper name.
>
> **maxItems** `integer`
>
> Maximum number of dataset items that will be charged for pay-per-result Actors. IMPORTANT: Pay-per-result Actors enforce a minimum cost per run (varies by Actor, commonly \$0.02-\$0.50). If maxItems results in a cost below the minimum, the API will reject the request. Use a higher maxItems value to meet the Actor's minimum cost requirement.
>
> **delimiter** `string`
>
> Delimiter character for CSV format.
>
> **skipEmpty** `boolean`
>
> Excludes empty items from results.
>
> **attachment** `boolean`
>
> Sets Content-Disposition: attachment header to force download.
>
> **simplified** `boolean`
>
> Legacy feature, applies fields=\['url','pageFunctionResult','errorInfo'] and unwind='pageFunctionResult'.
>
> **skipHidden** `boolean`
>
> Omits fields beginning with '#' character.
>
> **skipHeaderRow** `boolean`
>
> Skips header row in CSV output.
>
> **waitForFinish** `integer`
>
> Maximum time in seconds the server waits for the run to finish (0-300 seconds, max 5 minutes). If the run takes longer, the response will have status 408 (Request Timeout).
>
> **maxTotalChargeUsd** `number`
>
> Maximum total cost of the run in USD across all Actor pricing models.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Task Asynchronously
>
> **Slug:** `APIFY_RUN_TASK`
>
> Start an Actor task run and return its run details. The request can optionally wait for the run to finish before returning.
>
> #### Input Parameters
>
> **body** `object`
>
> JSON input object passed to the Actor.
>
> **build** `string`
>
> Specifies the Actor build to run (tag or build number). Defaults to default run config.
>
> **memory** `number`
>
> Memory limit for the run, in megabytes. Must be power of 2 and at least 128.
>
> **timeout** `number`
>
> Optional timeout for the run, in seconds. Default uses task's default timeout.
>
> **maxItems** `number`
>
> Maximum number of items that the Actor run should return.
>
> **webhooks** `string`
>
> Base64-encoded JSON array of webhook definitions.
>
> **actorTaskId** `string` *required*
>
> Task ID (e.g., 'HG7ML7M8z78YcAPEB') or tilde-separated owner username and task name (e.g., 'janedoe~~my-task'). Note: Use tilde (~~) as separator, not slash (/).
>
> **waitForFinish** `number`
>
> Max seconds the server waits for the run to finish. Default 0, max 60.
>
> **maxTotalChargeUsd** `number`
>
> Specifies the maximum cost of the Actor run in USD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Schedule
>
> **Slug:** `APIFY_SCHEDULE_DELETE`
>
> Tool to delete a schedule by its ID. Use when you need to remove a schedule from the Apify system.
>
> #### Input Parameters
>
> **scheduleId** `string` *required*
>
> Unique identifier of the schedule to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Schedule
>
> **Slug:** `APIFY_SCHEDULE_GET`
>
> Tool to get schedule details by ID. Use when you need to retrieve comprehensive information about a schedule including cron expression, timezone, actions, and execution times.
>
> #### Input Parameters
>
> **scheduleId** `string` *required*
>
> Unique identifier of the schedule to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Schedule Log
>
> **Slug:** `APIFY_SCHEDULE_LOG_GET`
>
> Tool to get schedule log by ID. Use when you need to retrieve execution history for a schedule, including invocation timestamps and status messages. Returns up to 1000 invocations.
>
> #### Input Parameters
>
> **scheduleId** `string` *required*
>
> Unique identifier of the schedule whose log you want to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Schedule
>
> **Slug:** `APIFY_SCHEDULE_PUT`
>
> Tool to update an existing schedule with new settings. Use when you need to modify schedule properties like cron expression, timezone, enabled status, or actions. Only specified fields are updated; others remain unchanged.
>
> #### Input Parameters
>
> **name** `string`
>
> The schedule's name (should be 3-63 characters long).
>
> **title** `string`
>
> A human-friendly display title for the schedule.
>
> **actions** `array`
>
> Actors or tasks that should be run on this schedule. Each action object specifies the type and target to run.
>
> **timezone** `string`
>
> Timezone in which your cron expression runs (TZ database name format, e.g., 'UTC', 'America/New\_York'). Defaults to UTC.
>
> **isEnabled** `boolean`
>
> True if the schedule should be enabled.
>
> **scheduleId** `string` *required*
>
> Unique identifier of the schedule to update.
>
> **description** `string`
>
> Description of this schedule's purpose.
>
> **isExclusive** `boolean`
>
> When set to true, don't start Actor or Actor task if it's still running from the previous schedule.
>
> **notifications** `object`
>
> Notification settings for the schedule.
>
> **cronExpression** `string`
>
> The cron expression used by this schedule (e.g., '@monthly', '@daily', '0 0 \* \* \*').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of schedules
>
> **Slug:** `APIFY_SCHEDULES_GET`
>
> Tool to get list of schedules created by the user. Use when you need to browse or enumerate user's schedules. Supports pagination with up to 1000 items per page.
>
> #### Input Parameters
>
> **desc** `integer`
>
> Set to 1 to sort schedules by createdAt field in descending order (newest first). Default is 0 (ascending).
>
> **limit** `integer`
>
> Maximum number of schedules to return (pagination). Default and max is 1000.
>
> **offset** `integer`
>
> Number of items to skip at the start (pagination). Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Schedule
>
> **Slug:** `APIFY_SCHEDULES_POST`
>
> Tool to create a new schedule with specified settings. Use when you need to automate Actor or Actor task execution at specific times using cron expressions.
>
> #### Input Parameters
>
> **name** `string`
>
> The schedule's name (should be 3-63 characters long).
>
> **title** `string`
>
> A human-friendly display title for the schedule.
>
> **actions** `array`
>
> Actors or tasks that should be run on this schedule. Each action object specifies the type and target to run.
>
> **timezone** `string`
>
> Timezone in which your cron expression runs (TZ database name format, e.g., 'UTC', 'America/New\_York'). Defaults to UTC.
>
> **isEnabled** `boolean` *required*
>
> True if the schedule should be enabled.
>
> **description** `string`
>
> Description of this schedule's purpose.
>
> **isExclusive** `boolean` *required*
>
> When set to true, don't start Actor or Actor task if it's still running from the previous schedule.
>
> **notifications** `object`
>
> Notification settings for the schedule.
>
> **cronExpression** `string` *required*
>
> The cron expression used by this schedule (e.g., '@monthly', '@daily', '0 0 \* \* \*').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Amazon Product Details
>
> **Slug:** `APIFY_SCRAPE_AMAZON_PRODUCT_DETAILS`
>
> Scrape detailed Amazon product pages by ASIN or URL with delicious\_zebu/amazon-product-details-scraper. Pricing is \$1.50 per 1,000 unique product results, so 10,000 monthly products cost about \$15. Actor compute and in-run storage are included; later dataset retention and reads can consume platform usage. The Actor emits one result per unique input and documents 20 marketplaces, but no run-wide input maximum; use a bounded products list and maxTotalChargeUsd. Apify's global API limit is 250,000 requests/minute, with resource-specific limits reported in X-RateLimit-Limit.
>
> #### Input Parameters
>
> **website** `string ("amazon.com" | "amazon.ca" | "amazon.com.mx" | "amazon.com.br" | "amazon.co.uk" | "amazon.de" | "amazon.it" | "amazon.es" | "amazon.nl" | "amazon.pl" | "amazon.se" | "amazon.co.jp" | "amazon.in" | "amazon.com.au" | "amazon.sg" | "amazon.ie" | "amazon.ae" | "amazon.eg" | "amazon.sa" | "amazon.com.tr")`
>
> Amazon marketplace used for bare ASINs, such as amazon.com, amazon.de, or amazon.co.jp. Full URLs keep their own domain.
>
> **zipCode** `string`
>
> Optional marketplace-local postal code for a precise delivery location.
>
> **currency** `string ("default" | "USD" | "CLP" | "COP" | "HKD" | "IDR" | "ILS" | "KRW" | "MYR" | "NZD" | "THB" | "TWD" | "CRC" | "PEN" | "UYU" | "BRL" | "AUD" | "CAD" | "CNY" | "EUR" | "JPY" | "MXN" | "GBP" | "AED" | "SGD" | "SAR" | "NOK" | "ARS" | "AMD" | "AWG" | "AZN" | "BSD" | "BZD" | "BOB" | "BND" | "BGN" | "KHR" | "KYD" | "DOP" | "XCD" | "EGP" | "GHS" | "GTQ" | "HUF" | "INR" | "JMD" | "KZT" | "KES" | "LBP" | "HNL" | "MOP" | "MUR" | "MAD" | "NAD" | "NGN" | "PAB" | "PYG" | "QAR" | "RUB" | "ZAR" | "TZS" | "PHP" | "TTD" | "MNT" | "TRY" | "VND" | "SEK" | "PLN" | "BBD" | "BMD" | "XPF" | "XOF" | "XAF" | "NIO" | "CZK" | "DKK" | "GEL" | "GYD" | "PKR" | "RON" | "MVR" | "LKR" | "CHF" | "UZS")`
>
> Requested ISO currency code, or default for the marketplace currency.
>
> **language** `string ("default" | "en" | "ar" | "de" | "es" | "fr" | "he" | "it" | "ja" | "ko" | "nl" | "pl" | "pt" | "sv" | "tr" | "zh_CN" | "zh_TW")`
>
> Amazon page language code, or default to retain each marketplace's language.
>
> **products** `array` *required*
>
> Amazon ASINs or product detail URLs. Values may span marketplaces; duplicates are scraped and charged once.
>
> **deliverTo** `string ("AF" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "CV" | "KH" | "CM" | "CA" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CD" | "CG" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "CI" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "SZ" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "MK" | "RO" | "RU" | "RW" | "RE" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW" | "AX")`
>
> Delivery-country code, primarily affecting amazon.com prices, availability, and offers.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Amazon Reviews
>
> **Slug:** `APIFY_SCRAPE_AMAZON_REVIEWS`
>
> Scrape Amazon customer reviews with axesso\_data/amazon-reviews-scraper. Pricing is \$0.90 per 1,000 dataset items, so 10,000 monthly reviews cost about \$9. Actor compute and in-run storage are included; later dataset retention and reads can consume platform usage. Each ASIN is limited to 10 pages; invalid ASINs and filters yielding no reviews produce three charged penalty items, so validate targets and set maxPages and maxTotalChargeUsd. Apify's global API limit is 250,000 requests/minute, with resource-specific limits reported in X-RateLimit-Limit.
>
> #### Input Parameters
>
> **products** `array` *required*
>
> One or more independently configured Amazon products to scrape.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Booking Reviews
>
> **Slug:** `APIFY_SCRAPE_BOOKING_REVIEWS`
>
> Scrape public Booking.com property reviews with voyager/booking-reviews-scraper. Pricing per 1,000 reviews is \$2 Free, \$1.90 Bronze, \$1.50 Silver, \$0.90 Gold, \$0.50 Platinum, or \$0.30 Diamond, plus a \$0.00005/GB start event; 10,000 monthly reviews cost about \$20/\$19/\$15/\$9/\$5/\$3 before negligible start charges. Actor compute and in-run storage are included; retained datasets and later reads can consume platform usage. Reviews can contain copyrighted text and personal context; use only for a legitimate analysis purpose, preserve id and startUrl attribution, and do not bulk republish. Bound maxReviewsPerHotel and maxTotalChargeUsd.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per review
>
> **Discount:** 55
>
> #### Input Parameters
>
> **startUrls** `array` *required*
>
> Booking.com property URLs.
>
> **cutoffDate** `string`
>
> Oldest review date or documented relative date.
>
> **reviewScores** `array`
>
> Review-score bands to include.
>
> **sortReviewsBy** `string ("f_relevance" | "f_recent_desc" | "f_score_desc" | "f_score_asc")`
>
> Review ordering.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **maxReviewsPerHotel** `integer`
>
> Maximum reviews per property.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Meta/Facebook Ads
>
> **Slug:** `APIFY_SCRAPE_FACEBOOK_ADS`
>
> Scrape public Meta ads with apify/facebook-ads-scraper, with per-URL result limits and an optional run charge limit. E-commerce enrichment may incur additional charges and is unavailable on managed calls; a timed-out paid run can continue server-side.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.005 per ad
>
> **Discount:** 32
>
> #### Input Parameters
>
> **sorting** `string ("" | "total_impressions" | "relevancy_monthly_grouped")`
>
> Sort by default order, highest impressions, or most recent unless the input URL already specifies sorting.
>
> **startUrls** `array` *required*
>
> Facebook Page or Meta Ad Library URLs. URL-encoded Ad Library filters take precedence over separate status and sorting inputs.
>
> **activeStatus** `string ("" | "active" | "inactive")`
>
> Filter active or inactive ads unless the input Ad Library URL already specifies status; empty includes both.
>
> **resultsLimit** `integer`
>
> Maximum ads returned per input URL. Omit to request every available ad; use maxTotalChargeUsd to bound charges.
>
> **isDetailsPerAd** `boolean`
>
> Include available advertiser, spend, political-ad, EU audience, and reach details for each ad.
>
> **includeAboutPage** `boolean`
>
> Include advertiser managing organization, admin-country, and page-history details when available.
>
> **onlyAdsNewerThan** `string`
>
> Include ads active on or after YYYY-MM-DD or a positive relative period such as '2 months'.
>
> **onlyAdsOlderThan** `string`
>
> Include ads active on or before YYYY-MM-DD or a positive relative period such as '2 months'.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.0058 when supplied.
>
> **enrichWithEcommerceData** `boolean`
>
> Enrich product landing pages with product and price data. Each enriched product URL is an additional billable event, and one ad can contain multiple URLs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Facebook Comments
>
> **Slug:** `APIFY_SCRAPE_FACEBOOK_COMMENTS`
>
> Scrape public Facebook post comments with apify/facebook-comments-scraper. Each run has a \$0.001 start charge; comments cost \$0.0025 Free, \$0.002 Bronze, \$0.0017 Silver, \$0.0014 Gold, \$0.0009 Platinum, or \$0.0004 Diamond. Nested comments and the separately priced date-filter add-on are disabled. resultsLimit is per run and maxTotalChargeUsd separately caps exposure. Dataset retention and reads can consume normal usage. A synchronous timeout after 300 seconds may leave the paid run active.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per comment
>
> **Discount:** 30
>
> #### Input Parameters
>
> **startUrls** `array` *required*
>
> One to 50 public Facebook post URLs. Each URL is an independent comment source.
>
> **viewOption** `string ("RANKED_UNFILTERED" | "RECENT_ACTIVITY")`
>
> Comment ordering: RANKED\_UNFILTERED uses Facebook's ranked order; RECENT\_ACTIVITY requests newest activity first.
>
> **resultsLimit** `integer`
>
> Maximum top-level comments returned per source post, from 1 to 5,000. Replies are excluded because nested-comment expansion is always disabled. Provide this or maxTotalChargeUsd.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Facebook Events
>
> **Slug:** `APIFY_SCRAPE_FACEBOOK_EVENTS`
>
> Search and scrape public Facebook events with apify/facebook-events-scraper, with a per-query event limit and an optional run charge limit. A timed-out paid run can continue server-side.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.01 per event
>
> **Discount:** 30
>
> #### Input Parameters
>
> **maxEvents** `integer`
>
> Maximum events per search query. Omit for no Actor-specific limit; use maxTotalChargeUsd separately to cap total run charges.
>
> **startUrls** `array`
>
> Unique absolute facebook.com or fb.com event, event search, event explore, page-hosted-event, or group-event URLs.
>
> **searchQueries** `array`
>
> Unique topic, place, or combined topic-and-place searches used to discover public events.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Facebook Group Posts
>
> **Slug:** `APIFY_SCRAPE_FACEBOOK_GROUP_POSTS`
>
> Scrape posts from public Facebook groups with apify/facebook-groups-scraper; resultsLimit applies to chronological sorting, and non-chronological modes require maxTotalChargeUsd. A timed-out paid run can continue server-side.
>
> #### Input Parameters
>
> **startUrls** `array` *required*
>
> Public Facebook group URLs whose posts should be scraped. Private groups are unsupported.
>
> **viewOption** `string ("CHRONOLOGICAL" | "RECENT_ACTIVITY" | "TOP_POSTS" | "CHRONOLOGICAL_LISTINGS")`
>
> Post sorting mode. CHRONOLOGICAL\_LISTINGS is intended for Buy/Sell groups.
>
> **resultsLimit** `integer`
>
> Maximum posts returned for chronological sorting. Omit to scrape as many as available; this limit does not apply to every sort mode, so use maxTotalChargeUsd separately to cap total run charges.
>
> **searchGroupYear** `string`
>
> Year used with searchGroupKeyword.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **onlyPostsNewerThan** `string`
>
> UTC cutoff as YYYY-MM-DD, an ISO date-time, or a relative duration such as '2 months'.
>
> **searchGroupKeyword** `string`
>
> Optional public-group search text. Without login, words often return no results; one or two letters are recommended.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Facebook Pages
>
> **Slug:** `APIFY_SCRAPE_FACEBOOK_PAGES`
>
> Scrape public Facebook page/profile metadata with apify/facebook-pages-scraper. Current pricing is \$12.00 per 1,000 pages on Free, \$8.20 Bronze, \$6.50 Silver, \$5.40 Gold, \$4.00 Platinum, and \$2.00 Diamond; 10,000 monthly pages cost about \$120, \$82, \$65, \$54, \$40, or \$20. Actor compute and in-run proxy/storage usage are included; later dataset retention and reads can consume platform usage. The Actor documents no page-count cap, and restricted pages can return fewer fields, so bound startUrls and maxTotalChargeUsd. Apify's global API limit is 250,000 requests/minute, with resource-specific limits reported in X-RateLimit-Limit.
>
> #### Input Parameters
>
> **startUrls** `array` *required*
>
> Public Facebook pages to scrape for profile, contact, audience, and page metadata.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Facebook Photos
>
> **Slug:** `APIFY_SCRAPE_FACEBOOK_PHOTOS`
>
> Scrape public Facebook photo metadata and OCR text with apify/facebook-photos-scraper. Current pricing is a \$0.001 start plus \$0.003 per photo on Free and \$0.0004-\$0.002 per photo on paid tiers; Actor compute is included, while later dataset retention and reads affect storage usage. This paid call creates a run and dataset and consumes monthly credits. Bound URLs and resultsLimit and use maxTotalChargeUsd. The action returns source image URLs for attribution but never downloads or returns media bytes.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per photo
>
> **Discount:** 45
>
> #### Input Parameters
>
> **startUrls** `array` *required*
>
> Public Facebook targets whose photo collections should be scraped.
>
> **resultsLimit** `integer`
>
> Maximum photo records to return across the supplied targets.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.0041 when supplied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Facebook Posts
>
> **Slug:** `APIFY_SCRAPE_FACEBOOK_POSTS`
>
> Scrape public Facebook page and profile posts with apify/facebook-posts-scraper. Each run costs \$0.001 to start; posts cost \$0.005 Free, \$0.004 Bronze, \$0.0025 Silver, \$0.002 Gold, \$0.0016 Platinum, or \$0.0008 Diamond. Date-filter and transcript/download expansion are not exposed; caption extraction is disabled. resultsLimit bounds output and maxTotalChargeUsd caps total exposure. Later dataset usage is separate, and a 300-second timeout can leave the paid run active.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.004 per post
>
> **Discount:** 50
>
> #### Input Parameters
>
> **startUrls** `array` *required*
>
> One to 50 public Facebook page or profile URLs whose posts should be scraped.
>
> **resultsLimit** `integer`
>
> Maximum posts returned per source page or profile, from 1 to 5,000. Provide this or maxTotalChargeUsd.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Facebook Reels
>
> **Slug:** `APIFY_SCRAPE_FACEBOOK_REELS`
>
> Scrape public Facebook reel metadata with apify/facebook-reels-scraper. Current per-reel pricing is \$0.005 on Free/Bronze and \$0.00097-\$0.00409 on paid tiers; Actor compute is included, while later dataset retention and reads affect storage usage. This paid call creates a run and dataset and consumes monthly credits. Bound pages and resultsLimit and use maxTotalChargeUsd; only metadata and source URLs are returned, never downloaded media bytes.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.005 per reel
>
> **Discount:** 37
>
> #### Input Parameters
>
> **startUrls** `array` *required*
>
> Public Facebook pages, profiles, or reels to scrape.
>
> **resultsLimit** `integer`
>
> Maximum reel records to return across the supplied targets.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **onlyPostsNewerThan** `string`
>
> Documented absolute date or relative age such as '30 days'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Facebook Reviews
>
> **Slug:** `APIFY_SCRAPE_FACEBOOK_REVIEWS`
>
> Scrape public Facebook page reviews with apify/facebook-reviews-scraper, using an optional result limit and run charge limit. A timed-out paid run can continue server-side.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per review
>
> **Discount:** 30
>
> #### Input Parameters
>
> **startUrls** `array` *required*
>
> Public Facebook page review URLs to scrape.
>
> **resultsLimit** `integer`
>
> Maximum reviews returned across the run. Omit to scrape as many as available; use maxTotalChargeUsd separately to cap total run charges.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **onlyReviewsNewerThan** `string`
>
> UTC cutoff as YYYY-MM-DD, an ISO date-time, or a relative duration such as '2 months'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape G2 Reviews
>
> **Slug:** `APIFY_SCRAPE_G2_REVIEWS`
>
> Scrape G2 software reviews with fixed Actor BkxudbF8MgHuC8WfI, with a limit of 50,000 reviews per product. Runs may incur charges; managed calls require an explicit review limit and use a shorter timeout.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.005 per review
>
> **Discount:** 40
>
> #### Input Parameters
>
> **minRating** `integer`
>
> Minimum G2 NPS score from 0 through 10, not a five-star threshold.
>
> **maxReviews** `integer`
>
> Maximum reviews per product. The Actor paginates in batches of 100.
>
> **productUrls** `array` *required*
>
> G2 product review URLs, protocol-less G2 URLs, or product slugs such as slack.
>
> **sortReviews** `string ("newest" | "helpful" | "rating_high" | "rating_low")`
>
> Review ordering used by G2.
>
> **publishedAfter** `string`
>
> Inclusive ISO 8601 publication lower bound. A date-only value includes the full UTC day.
>
> **publishedBefore** `string`
>
> Inclusive ISO 8601 publication upper bound. A date-only value includes the full UTC day.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Google Maps Places
>
> **Slug:** `APIFY_SCRAPE_GOOGLE_MAPS_PLACES`
>
> Scrape Google Maps place listings with damilo/google-maps-scraper. This paid run costs \$3.00 per 1,000 results. The event price includes Actor compute; dataset storage and retention still consume account resources. Charges count toward monthly Apify usage and hard limits, so set max\_results and maxTotalChargeUsd deliberately. Apify limits the API to 250,000 requests/minute globally and reports the current per-resource limit in X-RateLimit-Limit.
>
> #### Input Parameters
>
> **cid** `string`
>
> Optional Google Maps customer identification (CID) value.
>
> **query** `string` *required*
>
> Business or place search query, such as 'bookstore'.
>
> **language** `string`
>
> Language code in which Google Maps results should be returned.
>
> **location** `string` *required*
>
> City, town, address, or other location in which to search.
>
> **place\_id** `string`
>
> Optional Google Maps Place ID used to target a location.
>
> **max\_results** `integer`
>
> Maximum number of place listings for the Actor to scrape.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Google Maps Reviews
>
> **Slug:** `APIFY_SCRAPE_GOOGLE_MAPS_REVIEWS`
>
> Scrape Google Maps reviews with compass/google-maps-reviews-scraper. Pricing starts at \$0.30 per 1,000 reviews plus Apify platform compute/storage usage. Every run counts toward monthly Apify usage and hard limits; the Actor recommends at most 1,000 reviews per place, while maxReviews and maxTotalChargeUsd bound volume and charge exposure. Apify limits the API to 250,000 requests/minute globally and reports the current per-resource limit in X-RateLimit-Limit.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.045 per 100 reviews
>
> **Discount:** 33
>
> #### Input Parameters
>
> **language** `string`
>
> Language code in which results should be scraped.
>
> **placeIds** `array`
>
> Google Maps Place IDs to crawl. Supply this or startUrls.
>
> **startUrls** `array`
>
> Google Maps place/search/review URLs to crawl. Supply this or placeIds.
>
> **maxReviews** `integer`
>
> Maximum reviews to scrape per place. The Actor recommends 1,000 or fewer to limit resource consumption.
>
> **personalData** `boolean`
>
> Include reviewer identity fields and review URLs. Use only with a legitimate legal basis.
>
> **reviewsOrigin** `string ("all" | "google")`
>
> Scrape all supported review sources or Google reviews only.
>
> **reviewsStartDate** `string`
>
> Absolute UTC/ISO date-time or relative past duration such as '8 days'. When supplied, this action automatically uses newest-first sorting so the Actor can stop at the cutoff.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **reviewsFilterString** `string`
>
> Only return reviews containing these keywords; Google limits the UTF-8 value to 500 bytes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Indeed Jobs
>
> **Slug:** `APIFY_SCRAPE_INDEED_JOBS`
>
> Scrape Indeed jobs with valig/indeed-jobs-scraper without Indeed credentials. Pricing is tiered from \$0.10 to \$0.07 per 1,000 results plus a \$0.001 to \$0.0007 Actor-start event. Actor compute is included and platform usage is not separately charged; results use the default dataset, whose retention and reads affect account storage usage. Charges consume monthly credits and limits. The Actor had 3,879 monthly users and a 99.999% success rate in the audited 30-day period. Each run is limited to 1,000 jobs, the supported country and posting-age values are enumerated, and the default Actor timeout is 300 seconds. Apify's global API rate limit is 250,000 requests per minute, with the applicable resource limit returned in X-RateLimit-Limit. This paid call creates a run and dataset; use maxTotalChargeUsd to cap spend.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.009 per 100 jobs
>
> **Discount:** 22
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of Indeed jobs to return.
>
> **title** `string`
>
> Job title, keywords, or company to search for.
>
> **country** `string ("ar" | "au" | "at" | "bh" | "be" | "br" | "ca" | "cl" | "cn" | "co" | "cr" | "cz" | "dk" | "ec" | "eg" | "fi" | "fr" | "de" | "gr" | "hk" | "hu" | "in" | "id" | "ie" | "il" | "it" | "jp" | "kw" | "lu" | "my" | "mx" | "ma" | "nl" | "nz" | "ng" | "no" | "om" | "pk" | "pa" | "pe" | "ph" | "pl" | "pt" | "qa" | "ro" | "sa" | "sg" | "za" | "kr" | "es" | "se" | "ch" | "tw" | "th" | "tr" | "ua" | "ae" | "uk" | "us" | "uy" | "ve" | "vn")`
>
> Lowercase Indeed country/site code from the Actor's supported ISO-style list.
>
> **location** `string`
>
> City, state, postal code, or 'remote'.
>
> **datePosted** `string ("" | "1" | "3" | "7" | "14")`
>
> Posting age: empty for any time, or 1, 3, 7, or 14 days.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Instagram Comments
>
> **Slug:** `APIFY_SCRAPE_INSTAGRAM_COMMENTS`
>
> Scrape public Instagram post and Reel comments with apify/instagram-comment-scraper, excluding nested-comment expansion. Runs may incur charges; managed calls require an explicit results limit and use a shorter timeout, and a timed-out run can continue server-side.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per comment
>
> **Discount:** 5
>
> #### Input Parameters
>
> **directUrls** `array` *required*
>
> One to 50 full public Instagram post or Reel URLs in instagram.com/p/\<shortcode> or instagram.com/reel/\<shortcode> form.
>
> **resultsLimit** `integer`
>
> Maximum top-level comments returned per post or Reel, from 1 to 5,000. Replies are excluded because nested-comment expansion is always disabled. Provide this or maxTotalChargeUsd.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Instagram Hashtag Content
>
> **Slug:** `APIFY_SCRAPE_INSTAGRAM_HASHTAGS`
>
> Scrape public Instagram posts or reels by hashtag or keyword with Apify's fixed Actor; the results limit applies per target. Runs may incur charges; managed calls require an explicit results limit and use a shorter timeout, and a timed-out run can continue server-side.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per post
>
> **Discount:** 5
>
> #### Input Parameters
>
> **hashtags** `array` *required*
>
> Hashtags (with or without #) or keyword phrases. Each entry is a separate target and can return up to resultsLimit chargeable results; set keywordSearch for phrases.
>
> **resultsType** `string ("posts" | "reels")`
>
> Content type to scrape. The Actor handles either posts or reels per run, and each returned result is billable at the current Actor rate.
>
> **resultsLimit** `integer`
>
> Maximum results per hashtag or keyword, so total requested results can reach len(hashtags) multiplied by this value. Free usage covers only the first result page; check plan and monthly usage, and use maxTotalChargeUsd as the total charge cap.
>
> **keywordSearch** `boolean`
>
> Search each hashtags entry as a keyword phrase instead of merging its words into one hashtag. Keyword records can include extra comments and Facebook metrics, which may increase result detail but not the per-target result limit.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Instagram Mentions
>
> **Slug:** `APIFY_SCRAPE_INSTAGRAM_MENTIONS`
>
> Find public Instagram posts that tag or mention known accounts with apify/instagram-tagged-scraper. Current per-post pricing is \$0.0027 on Free, declining to \$0.0005 by tier; Actor compute is included, while later dataset storage and reads affect usage. This paid call creates a run and dataset and consumes monthly credits. Bound usernames and resultsLimit and use maxTotalChargeUsd. Comment expansion, transcripts, downloaded video, media bytes, and profile enrichment are not exposed.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per post
>
> **Discount:** 25
>
> #### Input Parameters
>
> **username** `array` *required*
>
> Public Instagram usernames whose tagged posts and mentions should be found.
>
> **resultsLimit** `integer`
>
> Maximum tagged-post or mention records to return across all usernames.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.0027 when supplied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Instagram Posts
>
> **Slug:** `APIFY_SCRAPE_INSTAGRAM_POSTS`
>
> Scrape public Instagram posts with Apify's fixed Actor; the results limit applies per profile. Runs may incur charges; managed calls require an explicit results limit, use basic data only, and have a shorter timeout, and a timed-out run can continue server-side.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per post
>
> **Discount:** 50
>
> #### Input Parameters
>
> **username** `array` *required*
>
> Instagram usernames, public profile URLs, or public post URLs. Each profile can produce up to resultsLimit items and each returned item can be chargeable.
>
> **resultsLimit** `integer`
>
> Maximum posts returned per profile (not applicable to direct post URLs). This Actor-specific limit controls work and charged result volume; use maxTotalChargeUsd separately to cap total run charges.
>
> **dataDetailLevel** `string ("basicData" | "detailedData")`
>
> Data package to extract. detailedData is charged at a higher Actor rate; verify current pricing and remaining monthly Apify usage before running.
>
> **skipPinnedPosts** `boolean`
>
> Skip pinned posts unless they satisfy an onlyPostsNewerThan filter. Skipping results can reduce chargeable output but does not replace a billing cap.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **onlyPostsNewerThan** `string`
>
> UTC cutoff in YYYY-MM-DD, full ISO, or relative form such as '1 day', '2 months', or '3 years'. Limits profile history and therefore potential result volume.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Instagram Profiles
>
> **Slug:** `APIFY_SCRAPE_INSTAGRAM_PROFILES`
>
> Scrape public Instagram profile details with Apify's fixed Profile Scraper Actor. This starts a paid run: Free-plan pricing is \$2.60 per 1,000 results and Starter pricing is \$2.30 per 1,000 (about 12,600 results with the included monthly usage). The event price includes Actor compute; later dataset storage and reads can consume account usage. Each input yields at most one result. Apify limits the API to 250,000 requests per minute globally and reports the current per-resource limit in the X-RateLimit-Limit response header.
>
> #### Input Parameters
>
> **usernames** `array` *required*
>
> Instagram usernames, numeric profile IDs, or full profile URLs to scrape. Each public profile produces at most one charged result.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **includeAboutSection** `boolean`
>
> Whether to buy the additional About-profile lookup (join date, country, verification history, and related details). This paid add-on can increase the run charge.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Instagram Reels
>
> **Slug:** `APIFY_SCRAPE_INSTAGRAM_REELS`
>
> Scrape public Instagram Reels with apify/instagram-reel-scraper. Each run costs \$0.001 to start; Reels cost \$0.0026 Free, \$0.0023 Bronze, \$0.0014 Silver, \$0.001 Gold, \$0.0008 Platinum, or \$0.0004 Diamond. Shares, transcript, and video-download add-ons are disabled, and pinned/trial Reels are skipped. resultsLimit bounds each source and maxTotalChargeUsd caps total exposure. Later dataset usage is separate; a 300-second timeout can leave the paid run active.
>
> #### Input Parameters
>
> **username** `array` *required*
>
> One to 50 public Instagram usernames, instagram.com profile URLs, or instagram.com/reel URLs. Pinned and trial Reels are always skipped.
>
> **resultsLimit** `integer`
>
> Maximum Reels returned per username or profile URL, from 1 to 1,000; a direct Reel URL identifies one item. Provide this or maxTotalChargeUsd.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape LinkedIn Companies
>
> **Slug:** `APIFY_SCRAPE_LINKEDIN_COMPANIES`
>
> Scrape public LinkedIn company details with harvestapi/linkedin-company, without LinkedIn cookies or caller credentials. Current pricing is a \$0.00005 start plus \$0.004 per company on Free/Bronze and \$0.003-\$0.0035 on paid tiers; compute is included, while later dataset storage and reads affect account usage. This paid call creates a run and dataset, charges monthly credits, and can continue after the 300-second synchronous wait, so bound targets and use maxTotalChargeUsd. Contact and profile-enrichment modes are intentionally not exposed.
>
> #### Input Parameters
>
> **searches** `array`
>
> Company names to resolve and scrape when a LinkedIn URL is not known.
>
> **companies** `array`
>
> Known public LinkedIn company URLs to scrape.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.004 when supplied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape LinkedIn Company Employees
>
> **Slug:** `APIFY_SCRAPE_LINKEDIN_COMPANY_EMPLOYEES`
>
> Enumerate and filter employees of specified LinkedIn companies, with short or full profiles and company batching on direct calls. Managed calls require an explicit positive result limit and use short profiles with all-at-once batching; runs may incur charges.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.003 per profile
>
> **Discount:** 50
>
> #### Input Parameters
>
> **schools** `array`
>
> LinkedIn schools to include.
>
> **maxItems** `integer`
>
> Maximum profiles across the run; 0 requests all available profiles, up to 2,500 per query.
>
> **companies** `array`
>
> LinkedIn company URLs whose employees should be enumerated.
>
> **jobTitles** `array`
>
> Exact current job titles to include.
>
> **locations** `array`
>
> Employee locations to include.
>
> **startPage** `integer`
>
> First search page; provider documentation says page numbering starts at 1 although its schema accepts 0.
>
> **takePages** `integer`
>
> Number of 25-profile search pages to scrape.
>
> **functionIds** `array`
>
> LinkedIn function IDs to include.
>
> **industryIds** `array`
>
> LinkedIn industry IDs to include.
>
> **searchQuery** `string`
>
> Fuzzy query applied to employees.
>
> **pastJobTitles** `array`
>
> Exact past job titles to include.
>
> **excludeSchools** `array`
>
> LinkedIn schools to exclude.
>
> **companyBatchMode** `string ("all_at_once" | "one_by_one")`
>
> Search at most 10 companies together, or process up to 1,000 companies separately with a start event for each.
>
> **companyHeadcount** `array`
>
> Current-company headcount bands A-I.
>
> **excludeLocations** `array`
>
> Employee locations to exclude.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.05 when supplied.
>
> **seniorityLevelIds** `array`
>
> LinkedIn seniority IDs to include.
>
> **excludeFunctionIds** `array`
>
> LinkedIn function IDs to exclude.
>
> **excludeIndustryIds** `array`
>
> LinkedIn industry IDs to exclude.
>
> **maxItemsPerCompany** `integer`
>
> Maximum profiles for each company in one-by-one mode.
>
> **profileScraperMode** `string ("Short ($4 per 1k)" | "Full ($8 per 1k)")`
>
> Return basic or full typed profiles. Email-search mode is omitted because its output contract is not documented strongly enough. Labels are the Actor's documented values.
>
> **recentlyChangedJobs** `boolean`
>
> Only employees who recently changed jobs.
>
> **excludePastCompanies** `array`
>
> Past-company LinkedIn URLs to exclude.
>
> **excludePastJobTitles** `array`
>
> Past job titles to exclude.
>
> **yearsOfExperienceIds** `array`
>
> Total-experience bands 1-5, from under one year through over ten years.
>
> **excludeCurrentJobTitles** `array`
>
> Current job titles to exclude.
>
> **excludeSeniorityLevelIds** `array`
>
> LinkedIn seniority IDs to exclude.
>
> **yearsAtCurrentCompanyIds** `array`
>
> Current-company tenure bands 1-5, from under one year through over ten years.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape LinkedIn Profile Posts
>
> **Slug:** `APIFY_SCRAPE_LINKEDIN_PROFILE_POSTS`
>
> Fetch posts from specified LinkedIn profiles, companies, posts, or activities, with optional comments and reactions on direct calls. Managed calls require an explicit positive post limit and exclude comment and reaction scraping; runs may incur charges.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per post
>
> **Discount:** 25
>
> #### Input Parameters
>
> **maxPosts** `integer`
>
> Maximum posts per target; 0 requests all available posts and overrides pagination.
>
> **targetUrls** `array`
>
> LinkedIn profile, company, post, or activity URLs whose posts should be fetched.
>
> **maxComments** `integer`
>
> Maximum comments per post; 0 requests all comments.
>
> **postedLimit** `string ("any" | "1h" | "24h" | "week" | "month" | "3months" | "6months" | "year")`
>
> Only posts newer than this documented interval.
>
> **maxReactions** `integer`
>
> Maximum reactions per post; 0 requests all reactions.
>
> **contextCountry** `string ("any" | "US" | "GB" | "DE" | "FR")`
>
> LinkedIn regional context, which can affect visible content.
>
> **includeReposts** `boolean`
>
> Include shared posts without commentary.
>
> **scrapeComments** `boolean`
>
> Scrape comments as separately charged dataset records.
>
> **postedLimitDate** `string`
>
> Inclusive oldest post as a JavaScript-compatible date string or millisecond timestamp.
>
> **scrapeReactions** `boolean`
>
> Scrape reactions as separately charged dataset records.
>
> **includeQuotePosts** `boolean`
>
> Include shared posts that add commentary.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.002 when supplied.
>
> **postNestedComments** `boolean`
>
> Also nest comments in post records; legacy and discouraged for large comment sets because of dataset item-size limits.
>
> **commentsPostedLimit** `string ("any" | "1h" | "24h" | "week" | "month")`
>
> Only comments newer than this documented interval.
>
> **postNestedReactions** `boolean`
>
> Also nest reactions in post records; legacy and discouraged for large reaction sets because of dataset item-size limits.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape LinkedIn Profiles
>
> **Slug:** `APIFY_SCRAPE_LINKEDIN_PROFILES`
>
> Scrape known LinkedIn profiles in bulk with harvestapi/linkedin-profile-scraper; unlike people search, this action requires profile URLs or identifiers and needs no LinkedIn credentials or cookies. Typed profile details cost \$4 per 1,000; the Actor's separate email-search mode is intentionally omitted because its output contract is not documented strongly enough. Actor compute is included; later dataset retention and reads affect account storage usage. Charges consume monthly credits and limits. The Actor had 9,732 monthly users and a 99.999% audited success rate. This paid call creates a run and dataset; use bounded target lists and maxTotalChargeUsd to cap spend.
>
> #### Input Parameters
>
> **urls** `array`
>
> LinkedIn profile URLs to scrape.
>
> **queries** `array`
>
> LinkedIn profile URLs or public identifiers to scrape.
>
> **profileIds** `array`
>
> LinkedIn internal profile IDs to scrape.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **publicIdentifiers** `array`
>
> LinkedIn public identifiers, which are the final path segment of profile URLs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Snapchat Profiles
>
> **Slug:** `APIFY_SCRAPE_SNAPCHAT_PROFILES`
>
> Scrape Snapchat profiles with automation-lab/snapchat-scraper. Every run costs \$0.005. Per-profile prices by Apify Store tier are Free \$0.002, Bronze \$0.0017, Silver \$0.0015, Gold \$0.0013, Platinum \$0.001, and Diamond \$0.0008; 1,000 Free-tier profiles in one run cost \$2.005. Compute, proxy, and in-run storage are included, while later dataset reads, writes, and retention consume normal account usage. There is no rental and charges count against monthly Apify usage. Related expansion is one hop and capped at 50 profiles. The Actor reports about two seconds/profile, up to 20 concurrent proxy requests or 3 without proxy; it publishes no hard seed or request-rate maximum. The Apify API global limit is 250,000 requests/minute, with the applicable resource limit returned in X-RateLimit-Limit. The synchronous endpoint waits 300 seconds and a timed-out paid run may continue server-side.
>
> #### Input Parameters
>
> **usernames** `array` *required*
>
> Snapchat usernames, @handles, or full snapchat.com/add profile URLs.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **relatedProfilesLimit** `integer`
>
> Maximum unique related profiles to scrape after all seeds. Expansion is one hop and each emitted profile is charged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Snapchat Spotlight
>
> **Slug:** `APIFY_SCRAPE_SNAPCHAT_SPOTLIGHT`
>
> Scrape public Snapchat Spotlight items with tri\_angle/snapchat-spotlight-scraper. Each paid run costs \$0.001 to start plus \$0.0015 per Spotlight item. Actor compute is included; later dataset reads and retention can consume normal Apify usage. A source list is capped at 100 and maxTotalChargeUsd is required to cap total exposure. The synchronous endpoint waits 300 seconds; a timed-out or transport-failed paid run may continue server-side and must not be retried blindly.
>
> #### Input Parameters
>
> **spotlightUrls** `array` *required*
>
> One to 100 full public snapchat.com/spotlight/\<id> URLs. Each URL identifies one Spotlight item.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape TikTok Ads
>
> **Slug:** `APIFY_SCRAPE_TIK_TOK_ADS`
>
> Search public TikTok Ad Library records with lexis-solutions/tiktok-ads-scraper. Current pricing is temporarily PPE plus user-paid platform usage due to high running costs: exactly \$0.49 per 1,000 returned ads plus \$0.00001 per Actor start event (one per GB, minimum one). Compute, proxy, transfer, dataset operations, and storage are additional; at the default 1 GB, one runtime hour is 1 CU, currently \$0.20 Free/Starter, \$0.16 Scale, or \$0.13 Business. Event-fee-only monthly ceilings are about 10,204 Free, 38,775 Starter, 406,122 Scale, and 2,038,775 Business ads, but platform usage lowers them and paid overage can be invoiced. Search returns 12 ads/page and TikTok caps 300 pages (3,600 ads); maxPages and maxTotalChargeUsd bound exposure. Apify's API limit is 250,000 requests/minute, with resource limits in X-RateLimit-Limit; a paid run can continue server-side after the 300-second synchronous wait.
>
> #### Input Parameters
>
> **adIds** `array`
>
> Specific TikTok ad IDs to fetch. At least one of adIds, query, advertiserName, or a specific country is required; adIds ignore all search fields.
>
> **query** `string`
>
> Words to find in TikTok ads. At least one of query, advertiserName, adIds, or a specific country is required. Wrap a phrase in quotation marks for exact order.
>
> **sortBy** `string ("last_shown_date,desc" | "last_shown_date,asc" | "create_time,desc" | "create_time,asc" | "impression,desc" | "impression,asc")`
>
> Order search results by last-shown date, publication date, or impressions.
>
> **country** `string ("all" | "FR" | "AT" | "BE" | "BG" | "HR" | "CY" | "CZ" | "DK" | "EE" | "FI" | "DE" | "GR" | "HU" | "IS" | "IE" | "IT" | "LV" | "LI" | "LT" | "LU" | "MT" | "NL" | "NO" | "PL" | "PT" | "RO" | "SK" | "SI" | "ES" | "SE" | "CH" | "GB")`
>
> TikTok Ad Library country filter. If query is omitted, choose a specific country rather than 'all'.
>
> **endDate** `string`
>
> End of the search window in YYYY-MM-DD. Omit for now; future values are clamped to now.
>
> **maxPages** `integer`
>
> Maximum 12-result pages to crawl. Use 0 for every available page; TikTok exposes at most 300 pages (3,600 ads).
>
> **timezone** `string`
>
> IANA timezone from the Actor's current timezone list, such as Europe/London. Omit for UTC.
>
> **startDate** `string`
>
> Start of the search window in YYYY-MM-DD. Omit for one year before the run; a value after endDate resets the Actor to its default range.
>
> **quickSearch** `boolean`
>
> Skip detail pages for faster, cheaper partial records; landing, advertiser, impression, and targeting fields can be null or absent.
>
> **advertiserName** `string`
>
> Advertiser name to resolve before searching. At least one of advertiserName, query, adIds, or a specific country is required; advertiserName takes priority over query.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape TikTok Comments
>
> **Slug:** `APIFY_SCRAPE_TIK_TOK_COMMENTS`
>
> Scrape top-level comments from public TikTok videos with clockworks/tiktok-comments-scraper. Comments cost \$0.00125 Free, \$0.001 Bronze, \$0.00075 Silver, \$0.0005 Gold, \$0.0003 Platinum, or \$0.00015 Diamond. Reply and profile expansion are disabled; commentsPerPost bounds each source and maxTotalChargeUsd caps total exposure. Compute is included, while later dataset usage is not. A synchronous timeout after 300 seconds can leave the paid run active server-side.
>
> #### Input Parameters
>
> **postURLs** `array` *required*
>
> One to 50 full public TikTok video URLs in tiktok.com/@\<username>/video/\<numeric-id> form.
>
> **commentsPerPost** `integer`
>
> Maximum top-level comments returned per video, from 1 to 1,000. Replies are never returned because maxRepliesPerComment is fixed to zero. Provide this or maxTotalChargeUsd.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **excludePinnedPosts** `boolean`
>
> Send the Actor's pinned-video exclusion flag. This action accepts only direct video URLs and never discovers additional posts from a profile.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape TikTok Posts
>
> **Slug:** `APIFY_SCRAPE_TIK_TOK_POSTS`
>
> Scrape public TikTok posts with apidojo/tiktok-scraper. Pricing is a fixed \$0.30 per 1,000 returned posts with Actor compute included; dataset retention and later reads can still affect storage usage. Free users are limited to five runs monthly and ten items per run; paid queries and start URLs must request at least ten posts. maxItems applies to each keyword or start URL, so total results and charges can approach maxItems multiplied by the number of sources; maxTotalChargeUsd caps total exposure. The Actor claims 400-600 posts/second, while Apify reports API limits in X-RateLimit-Limit.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.003 per 10 posts
>
> #### Input Parameters
>
> **keywords** `array`
>
> TikTok search terms whose matching posts should be returned.
>
> **location** `string ("AF" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "CV" | "KH" | "CM" | "CA" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CD" | "CG" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "CI" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "SZ" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "MK" | "RO" | "RU" | "RW" | "RE" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW" | "AX")`
>
> ISO 3166-1 alpha-2 region used to localize results.
>
> **maxItems** `integer`
>
> Maximum posts returned. Each query or start URL must request at least 10 posts; omit for the Actor's documented unlimited mode and use maxTotalChargeUsd to cap total run charges.
>
> **sortType** `string ("RELEVANCE" | "MOST_LIKED" | "DATE_POSTED")`
>
> Sort order for keyword searches; ignored for start URLs.
>
> **dateRange** `string ("DEFAULT" | "ALL_TIME" | "YESTERDAY" | "THIS_WEEK" | "THIS_MONTH" | "LAST_THREE_MONTHS" | "LAST_SIX_MONTHS")`
>
> TikTok date filter for keyword searches; ignored for start URLs.
>
> **startUrls** `array`
>
> Absolute tiktok.com profile, search, hashtag/tag, music, or location URLs. Single video and photo URLs are not supported by this Actor.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **includeSearchKeywords** `boolean`
>
> Include the source keyword annotation on records from keyword searches. The Actor controls the annotation field name; unknown provider fields are preserved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape TikTok Video
>
> **Slug:** `APIFY_SCRAPE_TIK_TOK_VIDEO`
>
> Scrape specified public TikTok videos with clockworks/tiktok-video-scraper. Video records cost \$0.003 Free, \$0.002 Bronze, \$0.0015 Silver, \$0.001 Gold, \$0.0006 Platinum, or \$0.0003 Diamond. Download and transcription add-ons are disabled by construction; compute is included, while later dataset usage is not. resultsPerPage or maxTotalChargeUsd bounds exposure. The synchronous wait is 300 seconds and an ambiguous timeout can leave a paid run active server-side.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per video
>
> **Discount:** 50
>
> #### Input Parameters
>
> **postURLs** `array` *required*
>
> One to 100 full public TikTok video URLs in tiktok.com/@\<username>/video/\<numeric-id> form. Related-video discovery is always disabled.
>
> **resultsPerPage** `integer`
>
> Maximum submitted-video records returned, from 1 to 100. Each direct URL identifies at most one record; provide this or maxTotalChargeUsd.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Tripadvisor Reviews
>
> **Slug:** `APIFY_SCRAPE_TRIPADVISOR_REVIEWS`
>
> Scrape public Tripadvisor reviews with maxcopell/tripadvisor-reviews. Pricing per 1,000 reviews is \$5 Free, \$1.90 Bronze, \$1.50 Silver, \$0.90 Gold, \$0.50 Platinum, or \$0.30 Diamond, plus a \$0.00005 start event; 10,000 monthly reviews cost about \$50/\$19/\$15/\$9/\$5/\$3 before start charges. Reviewer profiles are disabled and one language is enforced; photo/profile enrichment is not exposed. Actor compute and in-run storage are included; retained datasets and later reads can consume platform usage. Review text is protected content; preserve review url and placeInfo.webUrl attribution and do not bulk republish. Bound maxItemsPerQuery and maxTotalChargeUsd.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per review
>
> **Discount:** 55
>
> #### Input Parameters
>
> **startUrls** `array` *required*
>
> Tripadvisor place URLs.
>
> **reviewRatings** `array`
>
> Rating bands to include.
>
> **lastReviewDate** `string`
>
> Oldest review date or documented relative date.
>
> **maxItemsPerQuery** `integer`
>
> Maximum reviews per place.
>
> **reviewsLanguages** `array`
>
> Exactly one review language, as recommended by the Actor.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **disableMachineTranslations** `boolean`
>
> Return original review text without machine translation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Trustpilot Reviews
>
> **Slug:** `APIFY_SCRAPE_TRUSTPILOT_REVIEWS`
>
> Scrape public Trustpilot reviews with fixed Actor 6q70QEFc2Zk0ObldU without exposing reviewer-enrichment or contact controls. Pricing has a \$0.005 start event plus \$0.000575 per review Free, \$0.0005 Bronze, \$0.00039 Silver, \$0.0003 Gold, \$0.0002 Platinum, or \$0.00014 Diamond. For 10,000 monthly reviews across 100 runs, cost is about \$6.25 to \$1.90. In-run compute, proxy, and storage are included; retained datasets and later reads consume normal platform storage and monthly usage. Each paid call creates a run and dataset and is bounded to 20 companies and 1,000 reviews per company; maxTotalChargeUsd caps event exposure. Review text, replies, and display metadata remain third-party content and personal data requiring lawful, attributed use. Apify's global API rate limit is 250,000 requests/minute; synchronous waiting ends after 300 seconds.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.005 per 10 reviews
>
> **Discount:** 40
>
> #### Input Parameters
>
> **date** `string ("all" | "last30days" | "last3months" | "last6months" | "last12months")`
>
> Server-side rolling publication window for reviews.
>
> **sort** `string ("recency" | "relevance")`
>
> Order reviews by newest publication or relevance.
>
> **verified** `boolean`
>
> Return only verified reviews when true.
>
> **languages** `array`
>
> Optional ISO 639-1 review language filters.
>
> **companyUrls** `array` *required*
>
> Trustpilot company review URLs or bare company domains.
>
> **withReplies** `boolean`
>
> Return only reviews with company replies when true; false does not remove replies that exist.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **includeCompanyInfo** `boolean`
>
> Include public company summary fields alongside each review.
>
> **maxReviewsPerCompany** `integer`
>
> Maximum public reviews returned for each company.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape X/Twitter Posts
>
> **Slug:** `APIFY_SCRAPE_TWITTER_POSTS`
>
> Search bulk public X posts from one to five advanced-search queries; this Actor does not support a specified single post or conversation. It charges from \$0.40 per 1,000 results, with Actor compute included; dataset storage and reads can still consume usage. Free accounts are limited to 5 runs monthly and 10 results per run, while paid queries require at least 50 results. Apify limits the API to 250,000 requests/minute globally and reports the current per-resource limit in X-RateLimit-Limit; this Actor permits one concurrent run.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.004 per 10 tweets
>
> #### Input Parameters
>
> **sort** `string ("Latest" | "Top" | "Latest + Top")`
>
> X search ordering. 'Latest + Top' runs both modes and can return duplicates.
>
> **maxItems** `integer`
>
> Maximum posts returned across the run. Omit for the Actor's documented unlimited mode. Paid-plan queries should target at least 50 posts, while free accounts are capped at 10; use maxTotalChargeUsd separately to cap total run charges.
>
> **onlyImage** `boolean`
>
> Return only posts containing images.
>
> **onlyQuote** `boolean`
>
> Return only quote posts.
>
> **onlyVideo** `boolean`
>
> Return only posts containing videos.
>
> **searchTerms** `array` *required*
>
> One to five X advanced-search queries. Each query should be expected to return at least 50 posts; single-post and conversation scraping are not supported by this Actor.
>
> **tweetLanguage** `string`
>
> Optional ISO 639-1 language code used to restrict posts.
>
> **minimumReplies** `integer`
>
> Minimum reply count.
>
> **minimumRetweets** `integer`
>
> Minimum repost count.
>
> **onlyTwitterBlue** `boolean`
>
> Return only posts from X Blue subscribers.
>
> **minimumFavorites** `integer`
>
> Minimum like count.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **onlyVerifiedUsers** `boolean`
>
> Return only posts from verified users.
>
> **includeSearchTerms** `boolean`
>
> Include the matching search query in each result.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Website Traffic Insights
>
> **Slug:** `APIFY_SCRAPE_WEBSITE_TRAFFIC_INSIGHTS`
>
> Collect base website traffic estimates with radeance/similarweb-scraper. This wrapper always requests one aggregated base record per URL and disables the similar-sites and in-depth paid add-ons. Base-result pricing is \$0.008 Free/Bronze, \$0.006 Silver, and \$0.005 Gold/Platinum/Diamond, plus a \$0.001 start event; the Actor requires maxTotalChargeUsd of at least \$0.25. For 20 URLs the variable result charge is about \$0.16 to \$0.10 plus start. In-run compute and storage are included, while retained datasets and later reads affect platform storage and monthly usage. Each call creates a paid run and dataset and is bounded to 20 URLs. Values are third-party scraped Similarweb estimates, not an official or licensed Similarweb API. Apify's global API rate limit is 250,000 requests/minute; synchronous waiting ends after 300 seconds.
>
> #### Input Parameters
>
> **urls** `array` *required*
>
> One to twenty public website domains or URLs to analyze.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.25 when supplied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Yelp Reviews
>
> **Slug:** `APIFY_SCRAPE_YELP_REVIEWS`
>
> Scrape public Yelp reviews with web\_wanderer/yelp-reviews-scraper. Pricing is \$0.30 per 1,000 reviews with no separate event listed, so 10,000 monthly reviews cost about \$3. Personal-data collection is forced off; search expansion and translation are not exposed. Actor compute and in-run storage are included; retained datasets and later reads can consume platform usage. Reviews are third-party scraped, copyrighted content; preserve reviewUrl, businessUrl, and scrapedAt, and do not bulk republish. Bound reviews\_limit and maxTotalChargeUsd.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.003 per 10 reviews
>
> #### Input Parameters
>
> **domain** `string ("www.yelp.com" | "www.yelp.ca" | "www.yelp.co.uk" | "www.yelp.com.au" | "www.yelp.com.sg" | "www.yelp.com.hk" | "www.yelp.com.ph" | "www.yelp.com.tr" | "www.yelp.com.mx" | "www.yelp.com.ar" | "www.yelp.co.nz" | "www.yelp.com.tw" | "www.yelp.cl" | "www.yelp.com.br" | "www.yelp.de" | "www.yelp.fr" | "www.yelp.it" | "www.yelp.nl" | "www.yelp.ie" | "www.yelp.at" | "www.yelp.dk" | "www.yelp.no" | "www.yelp.pl" | "www.yelp.pt" | "www.yelp.cz" | "www.yelp.es" | "www.yelp.se" | "www.yelp.fi" | "de.yelp.ch" | "fr.yelp.ch" | "it.yelp.ch" | "en.yelp.ch" | "en.yelp.be" | "fr.yelp.be" | "nl.yelp.be" | "en.yelp.my" | "ms.yelp.my" | "en.yelp.com.hk" | "en.yelp.com.ph" | "fil.yelp.com.ph" | "fi.yelp.fi" | "sv.yelp.fi" | "ja.yelp.co.jp")`
>
> Current regional Yelp domain enum from the Actor input schema.
>
> **biz\_ids** `array`
>
> Yelp business aliases or IDs.
>
> **biz\_urls** `array`
>
> Public Yelp business URLs.
>
> **date\_from** `string`
>
> Oldest review date or documented relative date.
>
> **reviews\_sort** `string ("newest" | "relevance" | "rating_desc" | "rating_asc")`
>
> Review ordering.
>
> **reviews\_limit** `integer`
>
> Maximum reviews per business.
>
> **reviews\_rating** `array`
>
> Ratings to include.
>
> **reviews\_keywords** `array`
>
> At most five review keywords.
>
> **reviews\_language** `string`
>
> Review language code.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape YouTube Comments
>
> **Slug:** `APIFY_SCRAPE_YOUTUBE_COMMENTS`
>
> Scrape public YouTube comments with streamers/youtube-comments-scraper. Per-comment prices by Apify Store tier are Free \$0.002, Bronze \$0.0015, Silver \$0.0012, Gold \$0.0009, Platinum \$0.0006, and Diamond \$0.0003 (\$2.00-\$0.30 per 1,000). A supplied maxTotalChargeUsd must be at least \$0.50. The event price includes compute, proxy, and in-run storage; later dataset reads/writes and retention use normal account usage. There is no Actor rental, but the Actor README says residential proxies require Apify's Starter plan (\$19/month, or \$17/month billed annually). maxComments applies per video; no numeric maximum or Actor-specific request rate is published. The Apify API global limit is 250,000 requests/minute, with the applicable resource limit returned in X-RateLimit-Limit. The synchronous endpoint waits at most 300 seconds, and a timed-out paid run may continue.
>
> #### Input Parameters
>
> **startUrls** `array` *required*
>
> One or more public YouTube video URLs whose comments should be scraped.
>
> **maxComments** `integer`
>
> Maximum comments returned per video. The Actor publishes no numeric upper bound.
>
> **sortCommentsBy** `string ("TOP_COMMENTS" | "NEWEST_FIRST")`
>
> YouTube comment ordering. A date filter forces newest-first behavior.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD. This Actor requires at least \$0.50 when a cap is supplied.
>
> **oldestCommentDate** `string`
>
> Return comments on/after an absolute date or within a relative age such as '2 days'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape YouTube Videos
>
> **Slug:** `APIFY_SCRAPE_YOUTUBE_VIDEOS`
>
> Search and scrape YouTube with the fixed streamers/youtube-scraper Actor. Current per-video prices by Store tier are \$0.004/\$0.003/\$0.0026/\$0.0024/ \$0.0015/\$0.001 (Free through Diamond); the README's \$5/1,000 statement is stale. Per-result date-filter add-ons are \$0.0013/\$0.001/\$0.0008/\$0.0006/ \$0.0003/\$0.00017. AI description and summary each cost \$0.015/\$0.01/ \$0.0085/\$0.007/\$0.0043/\$0.0021 per video-minute. Generated transcript minutes cost \$0.048/\$0.041/\$0.033/\$0.027/\$0.02/\$0.015 per started minute. Compute, proxy, and in-run storage are included; later dataset/KVS access and retention use normal monthly usage. There is no rental. The Actor documents at most 20,000 videos per URL even though numeric inputs accept 999,999. It publishes no Actor-specific request rate. The Apify API global limit is 250,000 requests/minute, with the applicable resource limit in X-RateLimit-Limit. The synchronous wait is 300 seconds and the paid run may continue after an HTTP timeout.
>
> #### Input Parameters
>
> **is3D** `boolean`
>
> Apply the 3D filter.
>
> **is4K** `boolean`
>
> Apply the 4K filter.
>
> **isHD** `boolean`
>
> Apply the HD filter.
>
> **hasCC** `boolean`
>
> Apply the Creative Commons filter.
>
> **is360** `boolean`
>
> Apply the 360-degree filter.
>
> **isHDR** `boolean`
>
> Apply the HDR filter.
>
> **isLive** `boolean`
>
> Apply the Live filter.
>
> **isVR180** `boolean`
>
> Apply the VR180 filter.
>
> **isBought** `boolean`
>
> Apply the Purchased filter.
>
> **startUrls** `array`
>
> Direct YouTube URLs. At least one startUrls or searchQueries entry is required; when URLs are present the provider ignores searchQueries.
>
> **videoType** `string ("video" | "movie")`
>
> YouTube search video-type filter.
>
> **dateFilter** `string ("hour" | "today" | "week" | "month" | "year")`
>
> YouTube upload-date filter; applies only to searchQueries.
>
> **maxResults** `integer`
>
> Maximum regular videos per search term or channel.
>
> **hasLocation** `boolean`
>
> Apply the Location filter.
>
> **hasSubtitles** `boolean`
>
> Apply the Subtitles/CC filter.
>
> **lengthFilter** `string ("under4" | "between420" | "plus20")`
>
> YouTube search duration filter.
>
> **sortVideosBy** `string ("NEWEST" | "POPULAR" | "OLDEST")`
>
> Sort videos, Shorts, and streams on channel pages.
>
> **sortingOrder** `string ("relevance" | "rating" | "date" | "views")`
>
> YouTube search ordering; applies only to searchQueries.
>
> **saveSubsToKVS** `boolean`
>
> Save downloaded subtitles to the run key-value store. Transcripts are always stored there.
>
> **searchQueries** `array`
>
> YouTube search terms. At least one searchQueries or startUrls entry is required; do not combine both source types.
>
> **aiVideoSummary** `boolean`
>
> Buy an AI summary per video-minute.
>
> **oldestPostDate** `string`
>
> For channel URLs, keep videos on/after an absolute date or within a relative age such as '2 days'. This paid filter resets sorting to newest.
>
> **subtitlesFormat** `string ("srt" | "vtt" | "xml" | "plaintext")`
>
> Format of downloaded subtitles.
>
> **maxResultStreams** `integer`
>
> Maximum streams per search term or channel.
>
> **maxResultsShorts** `integer`
>
> Maximum Shorts per search term or channel.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **subtitlesLanguage** `string ("any" | "en" | "de" | "es" | "fr" | "it" | "ja" | "ko" | "nl" | "pt" | "ru")`
>
> Subtitle language used by subtitle-enabled modes.
>
> **aiVideoDescription** `boolean`
>
> Buy a time-segmented AI visual/audio description per video-minute.
>
> **transcriptionAndSubtitle** `string ("NONE" | "ALWAYS_SUBTITLES" | "TRANSCRIPTION_AS_FALLBACK" | "ALWAYS_TRANSCRIBE")`
>
> Download existing subtitles, transcribe with paid speech-to-text, or skip both.
>
> **preferAutoGeneratedSubtitles** `boolean`
>
> Prefer auto-generated over creator-provided subtitles in subtitle-enabled modes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape YouTube Video Transcripts
>
> **Slug:** `APIFY_SCRAPE_YOUTUBE_VIDEO_TRANSCRIPTS`
>
> Extract timestamped YouTube transcripts with starvibe/youtube-video-transcript for a video or channel; channel runs accept at most 200 videos. Managed calls require an explicit channel video limit, so direct video requests are unavailable in managed mode; a timed-out paid run may continue server-side.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.005 per transcript
>
> #### Input Parameters
>
> **end\_date** `string`
>
> Inclusive channel-video end date as YYYY-MM-DD or ISO 8601. Ignored for a video URL.
>
> **language** `string`
>
> Optional two-letter ISO 639-1 transcript language. The Actor may fall back when that language is unavailable.
>
> **max\_videos** `integer`
>
> Maximum channel videos to process. The Actor defaults to 10; valid range is 1-200. Ignored for a video URL.
>
> **start\_date** `string`
>
> Inclusive channel-video start date as YYYY-MM-DD or ISO 8601. Ignored for a video URL.
>
> **channel\_url** `string`
>
> YouTube channel ID, custom-name, or @handle URL. Provide exactly one of channel\_url and youtube\_url.
>
> **youtube\_url** `string`
>
> YouTube video, Short, embed, or youtu.be URL. Provide exactly one of youtube\_url and channel\_url.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **include\_transcript\_text** `boolean`
>
> Also return transcript\_text as one plain string without timestamps.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Zillow Property Details
>
> **Slug:** `APIFY_SCRAPE_ZILLOW_PROPERTY_DETAILS`
>
> Fetch full Zillow property details with fixed Actor ENK9p4RZHg0iVso52. Result pricing per 1,000 is \$3.60 Free, \$3.00 Bronze, \$2.40 Silver, \$1.70 Gold, \$1.30 Platinum, and \$0.80 Diamond. At 10,000 monthly results this is \$36/\$30/\$24/\$17/\$13/\$8, with no Actor rental or start event. Actor compute and in-run storage are included; later dataset reads, writes, and retention consume normal Apify usage. No input-count or request rate limit is published. Building expansion can emit several billed results per URL. Apify's global API rate limit is 250,000 requests/minute, with the resource limit reported in X-RateLimit-Limit. Bound inputs and use maxTotalChargeUsd because the synchronous endpoint waits only 300 seconds.
>
> #### Input Parameters
>
> **addresses** `array`
>
> US postal addresses such as '123 Main St, City, ST 12345'. At least one of addresses, startUrls, or searchResultsDatasetId is required.
>
> **startUrls** `array`
>
> Zillow property, apartment-building, or community URLs to inspect. At least one of startUrls, addresses, or searchResultsDatasetId is required.
>
> **propertyStatus** `string ("FOR_SALE" | "RECENTLY_SOLD" | "FOR_RENT")`
>
> Expected status of startUrls. A wrong status causes extra Zillow requests while the Actor detects the actual status.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **extractBuildingUnits** `string ("disabled" | "all" | "for_sale" | "recently_sold" | "for_rent" | "off_market")`
>
> For building pages, optionally emit individual unit details by listing status.
>
> **searchResultsDatasetId** `string`
>
> Apify dataset ID containing Zillow search results to enrich. At least one of searchResultsDatasetId, startUrls, or addresses is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search AliExpress Products
>
> **Slug:** `APIFY_SEARCH_ALIEXPRESS_PRODUCTS`
>
> Search AliExpress listing cards with khadinakbar/aliexpress-all-in-one-scraper, with detailed product enrichment and reviews disabled. Each run can request up to 100 listings and may incur charges; managed calls have shorter time and spend limits, and a timed-out run may continue.
>
> #### Input Parameters
>
> **site** `string`
>
> AliExpress marketplace domain.
>
> **maxResults** `integer`
>
> Maximum listing cards to return.
>
> **searchQuery** `string` *required*
>
> Product keywords to search on AliExpress.
>
> **shipCountry** `string`
>
> Uppercase ISO 3166-1 alpha-2 destination country.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Amazon Products
>
> **Slug:** `APIFY_SEARCH_AMAZON_PRODUCTS`
>
> Search Amazon product listings with axesso\_data/amazon-search-scraper. Pricing is \$10 per 1,000 results on Free and \$0.10 per 1,000 on paid tiers, so 10,000 monthly results cost about \$100 or \$1. Actor compute and in-run storage are included; later dataset retention and reads can consume platform usage. Each query is limited to 20 pages; multiple queries are allowed, but no run-wide result cap is documented, so use maxPages and maxTotalChargeUsd. Apify's global API limit is 250,000 requests/minute, with resource-specific limits reported in X-RateLimit-Limit.
>
> #### Input Parameters
>
> **searches** `array` *required*
>
> One or more independently configured Amazon product searches.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Booking Properties
>
> **Slug:** `APIFY_SEARCH_BOOKING_PROPERTIES`
>
> Search public Booking.com properties with voyager/booking-scraper. Pricing per 1,000 properties is \$5 Free, \$3.90 Bronze, \$2.90 Silver, \$2 Gold, \$1.50 Platinum, or \$1.25 Diamond, plus a \$0.00005/GB start event; 10,000 monthly properties cost about \$50/\$39/\$29/\$20/\$15/\$12.50 before negligible start charges. Paid additional-hotel-data enrichment is disabled. Actor compute and in-run storage are included; retained datasets and later reads can consume platform usage. Rates and availability are transient third-party observations, not bookable quotes; preserve url and timeOfScrapeISO. Use maxItems and maxTotalChargeUsd to bound every run.
>
> #### Input Parameters
>
> **rooms** `integer`
>
> Number of rooms.
>
> **adults** `integer`
>
> Number of adults.
>
> **search** `string`
>
> Booking.com destination query.
>
> **sortBy** `string ("bayesian_review_score" | "distance_from_search" | "class_asc" | "price" | "review_score_and_price" | "class_and_price")`
>
> Current Booking.com result-order enum.
>
> **checkIn** `string`
>
> Check-in date or documented relative date.
>
> **checkOut** `string`
>
> Check-out date or documented relative date.
>
> **children** `integer`
>
> Number of children.
>
> **currency** `string ("ARS" | "AUD" | "AZN" | "BHD" | "BRL" | "BGN" | "CAD" | "XOF" | "CLP" | "CNY" | "COP" | "CZK" | "DKK" | "EGP" | "EUR" | "FJD" | "GEL" | "HKD" | "HUF" | "INR" | "IDR" | "ILS" | "JPY" | "JOD" | "KZT" | "KRW" | "KWD" | "MYR" | "MXN" | "MDL" | "NAD" | "TWD" | "NZD" | "NOK" | "OMR" | "PLN" | "GBP" | "QAR" | "RON" | "RUB" | "SAR" | "SGD" | "ZAR" | "SEK" | "CHF" | "THB" | "TRY" | "AED" | "USD" | "UAH")`
>
> Current complete Actor display-currency enum.
>
> **language** `string ("en-gb" | "en-us" | "de" | "nl" | "fr" | "es" | "es-ar" | "ca" | "it" | "pt-pt" | "pt-br" | "no" | "fi" | "sv" | "da" | "cs" | "hu" | "ro" | "ja" | "zh-cn" | "zh-tw" | "pl" | "el" | "ru" | "tr" | "bg" | "ar" | "ko" | "he" | "lv" | "uk" | "id" | "ms" | "th" | "et" | "hr" | "lt" | "sk" | "sr" | "sl" | "vi" | "tl" | "is")`
>
> Current complete Actor Booking.com locale enum.
>
> **maxItems** `integer`
>
> Maximum properties to return.
>
> **minScore** `string`
>
> Minimum guest score from 0 to 10 as a string with at most one decimal place, matching the Actor's documented '8.4' format. The Actor warns that values below 5 may be inefficient.
>
> **startUrls** `array`
>
> Booking.com search or property URLs.
>
> **propertyType** `string ("none" | "Hotels" | "Apartments" | "Hostels" | "Guest houses" | "Homestays" | "Bed and breakfasts" | "Holiday homes" | "Boats" | "Villas" | "Motels" | "Resorts" | "Holiday parks" | "Campsites" | "Luxury tents")`
>
> Current Booking.com property-type enum.
>
> **starsCountFilter** `string ("any" | "1" | "2" | "3" | "4" | "5" | "unrated")`
>
> Current Booking.com star-count enum.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Eventbrite Events
>
> **Slug:** `APIFY_SEARCH_EVENTBRITE_EVENTS`
>
> Search public Eventbrite events with aitorsm/eventbrite. Pricing per 1,000 events is \$20 Free, \$15 Bronze, \$10 Silver, or \$5 Gold+; organizer enrichment costs \$15 per 1,000 and is disabled. Thus 10,000 monthly events cost about \$200/\$150/\$100/\$50, plus \$0.00005/GB start events. maxResults is only a soft cap and can overshoot by about 200, so maxTotalChargeUsd is required for strict spend control. Actor compute and in-run storage are included; retained datasets and later reads can consume platform usage. This is a third-party scrape, not Eventbrite's official API; preserve eventbrite\_event\_id and url and do not republish images/descriptions wholesale.
>
> #### Input Parameters
>
> **city** `string`
>
> City name.
>
> **price** `string ("paid" | "free" | "")`
>
> Paid/free event filter.
>
> **country** `string ("afghanistan" | "albania" | "algeria" | "american-samoa" | "andorra" | "angola" | "anguilla" | "antarctica" | "antigua-and-barbuda" | "argentina" | "armenia" | "aruba" | "australia" | "austria" | "azerbaijan" | "bahamas" | "bahrain" | "bangladesh" | "barbados" | "belarus" | "belgium" | "belize" | "benin" | "bermuda" | "bhutan" | "bolivia" | "bosnia-and-herzegovina" | "botswana" | "bouvet-island" | "brazil" | "british-indian-ocean-territory" | "brunei-darussalam" | "bulgaria" | "burkina-faso" | "burundi" | "cambodia" | "cameroon" | "canada" | "cape-verde" | "cayman-islands" | "central-african-republic" | "chad" | "chile" | "china" | "christmas-island" | "colombia" | "comoros" | "republic-of-congo" | "democratic-republic-of-the-congo" | "cook-islands" | "costa-rica" | "cote-d ivoire" | "croatia" | "cuba" | "cyprus" | "czech-republic" | "denmark" | "djibouti" | "dominica" | "dominican-republic" | "ecuador" | "egypt" | "el-salvador" | "equatorial-guinea" | "eritrea" | "estonia" | "ethiopia" | "falkland-islands" | "faroe-islands" | "fiji" | "finland" | "france" | "french-guiana" | "french-polynesia" | "french-southern-territories" | "gabon" | "gambia" | "georgia" | "germany" | "ghana" | "gibraltar" | "greece" | "greenland" | "grenada" | "guadeloupe" | "guam" | "guatemala" | "guernsey" | "guinea" | "guinea-bissau" | "guyana" | "haiti" | "vatican" | "honduras" | "hong-kong" | "hungary" | "iceland" | "india" | "indonesia" | "iran" | "iraq" | "ireland" | "isle-of-man" | "israel" | "italy" | "jamaica" | "japan" | "jersey" | "jordan" | "kazakhstan" | "kenya" | "kiribati" | "south-korea" | "kuwait" | "kyrgyzstan" | "laos" | "latvia" | "lebanon" | "lesotho" | "liberia" | "libyan-arab-jamahiriya" | "liechtenstein" | "lithuania" | "luxembourg" | "macao" | "macedonia" | "madagascar" | "malawi" | "malaysia" | "maldives" | "mali" | "malta" | "marshall-islands" | "martinique" | "mauritania" | "mauritius" | "mayotte" | "mexico" | "micronesia" | "moldova" | "monaco" | "mongolia" | "montserrat" | "morocco" | "mozambique" | "myanmar" | "namibia" | "nauru" | "nepal" | "netherlands" | "netherlands-antilles" | "new-caledonia" | "new-zealand" | "nicaragua" | "niger" | "nigeria" | "niue" | "norfolk-island" | "northern-mariana-islands" | "norway" | "oman" | "pakistan" | "palau" | "palestinian-territory" | "panama" | "papua-new-guinea" | "paraguay" | "peru" | "philippines" | "pitcairn" | "poland" | "portugal" | "puerto-rico" | "qatar" | "reunion" | "romania" | "russian-federation" | "rwanda" | "saint-helena" | "saint-kitts-and-nevis" | "saint-lucia" | "saint-pierre-and-miquelon" | "saint-vincent-and-the-grenadines" | "samoa" | "san-marino" | "sao-tome-and-principe" | "saudi-arabia" | "senegal" | "serbia-and-montenegro" | "seychelles" | "sierra-leone" | "singapore" | "slovakia" | "slovenia" | "solomon-islands" | "somalia" | "south-africa" | "south-georgia-and-the-south-sandwich-islands" | "spain" | "sri-lanka" | "sudan" | "suriname" | "svalbard-and-jan-mayen" | "swaziland" | "sweden" | "switzerland" | "syrian-arab-republic" | "taiwan" | "tajikistan" | "tanzania" | "thailand" | "timor-leste" | "togo" | "tokelau" | "tonga" | "trinidad-and-tobago" | "tunisia" | "turkey" | "turkmenistan" | "turks-and-caicos-islands" | "tuvalu" | "uganda" | "ukraine" | "united-arab-emirates" | "united-kingdom" | "united-states" | "united-states-minor-outlying-islands" | "uruguay" | "uzbekistan" | "vanuatu" | "venezuela" | "vietnam" | "virgin-islands" | "wallis-and-futuna" | "western-sahara" | "yemen" | "zambia" | "zimbabwe")` *required*
>
> Current complete Actor Eventbrite country enum.
>
> **endDate** `string`
>
> Inclusive end date (YYYY-MM-DD).
>
> **keyword** `string`
>
> Required search keyword when category is custom.
>
> **category** `string ("" | "custom" | "business" | "food-and-drink" | "health" | "music" | "auto-boat-and-air" | "charity-and-causes" | "community" | "family-and-education" | "fashion" | "film-and-media" | "hobbies" | "home-and-lifestyle" | "arts" | "government" | "spirituality" | "school-activities" | "science-and-tech" | "holiday" | "sports-and-fitness" | "travel-and-outdoor" | "other")`
>
> Current Eventbrite category enum, or custom with keyword.
>
> **startDate** `string`
>
> Inclusive start date (YYYY-MM-DD).
>
> **maxResults** `integer`
>
> Soft result cap; the Actor may overshoot by about 200.
>
> **maxTotalChargeUsd** `number` *required*
>
> Required run charge cap in USD. The \$0.0202 minimum covers the current highest-tier event charge (\$0.02) plus the Actor's 4 GB start charge (\$0.0002).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Facebook Marketplace
>
> **Slug:** `APIFY_SEARCH_FACEBOOK_MARKETPLACE`
>
> Search public Facebook Marketplace listings with apify/facebook-marketplace-scraper. Pricing per 1,000 listings is \$6.20 Free, \$5 Bronze, \$3.80 Silver, \$2.60 Gold, \$1.50 Platinum, or \$0.80 Diamond, with a minimum max charge of \$0.0062; 10,000 monthly listings cost about \$62/\$50/\$38/\$26/\$15/\$8. The equally priced listing-details add-on is disabled, preventing description, precise-coordinate, attribute, and expanded seller collection. Actor compute and in-run storage are included; retained datasets and later reads can consume platform usage. This is not Facebook's official API; preserve id, listingUrl, and facebookUrl, and avoid media republication. Bound resultsLimit and maxTotalChargeUsd.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.005 per listing
>
> **Discount:** 48
>
> #### Input Parameters
>
> **startUrls** `array` *required*
>
> Facebook Marketplace URLs to search.
>
> **resultsLimit** `integer`
>
> Maximum listings to return across inputs.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; the Actor requires at least \$0.0062.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Google
>
> **Slug:** `APIFY_SEARCH_GOOGLE`
>
> Search ordinary Google results with Apify's Google Search Results Scraper, requesting up to ten queries and ten pages per query. Runs may incur charges; managed calls require an explicit page limit and use a shorter timeout.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.003 per search page
>
> **Discount:** 40
>
> #### Input Parameters
>
> **queries** `string` *required*
>
> One to ten Google queries separated by newlines; each query must contain no more than 32 words.
>
> **countryCode** `string ("" | "af" | "al" | "dz" | "as" | "ad" | "ao" | "ai" | "aq" | "ag" | "ar" | "am" | "aw" | "au" | "at" | "az" | "bs" | "bh" | "bd" | "bb" | "by" | "be" | "bz" | "bj" | "bm" | "bt" | "bo" | "ba" | "bw" | "bv" | "br" | "io" | "bn" | "bg" | "bf" | "bi" | "kh" | "cm" | "ca" | "cv" | "ky" | "cf" | "td" | "cl" | "cn" | "cx" | "cc" | "co" | "km" | "cg" | "cd" | "ck" | "cr" | "ci" | "hr" | "cu" | "cy" | "cz" | "dk" | "dj" | "dm" | "do" | "ec" | "eg" | "sv" | "gq" | "er" | "ee" | "et" | "fk" | "fo" | "fj" | "fi" | "fr" | "gf" | "pf" | "tf" | "ga" | "gm" | "ge" | "de" | "gh" | "gi" | "gr" | "gl" | "gd" | "gp" | "gu" | "gt" | "gn" | "gw" | "gy" | "ht" | "hm" | "va" | "hn" | "hk" | "hu" | "is" | "in" | "id" | "ir" | "iq" | "ie" | "il" | "it" | "jm" | "jp" | "jo" | "kz" | "ke" | "ki" | "kp" | "kr" | "kw" | "kg" | "la" | "lv" | "lb" | "ls" | "lr" | "ly" | "li" | "lt" | "lu" | "mo" | "mk" | "mg" | "mw" | "my" | "mv" | "ml" | "mt" | "mh" | "mq" | "mr" | "mu" | "yt" | "mx" | "fm" | "md" | "mc" | "mn" | "me" | "ms" | "ma" | "mz" | "mm" | "na" | "nr" | "np" | "nl" | "an" | "nc" | "nz" | "ni" | "ne" | "ng" | "nu" | "nf" | "mp" | "no" | "om" | "pk" | "pw" | "ps" | "pa" | "pg" | "py" | "pe" | "ph" | "pn" | "pl" | "pt" | "pr" | "qa" | "re" | "ro" | "ru" | "rw" | "sh" | "kn" | "lc" | "pm" | "vc" | "ws" | "sm" | "st" | "sa" | "sn" | "rs" | "sc" | "sl" | "sg" | "sk" | "si" | "sb" | "so" | "za" | "gs" | "es" | "lk" | "sd" | "sr" | "sj" | "sz" | "se" | "ch" | "sy" | "tw" | "tj" | "tz" | "th" | "tl" | "tg" | "tk" | "to" | "tt" | "tn" | "tr" | "tm" | "tc" | "tv" | "ug" | "ua" | "ae" | "gb" | "us" | "um" | "uy" | "uz" | "vu" | "ve" | "vn" | "vg" | "vi" | "wf" | "eh" | "ye" | "zm" | "zw")`
>
> Country code from the complete provider-documented enum; empty uses the Actor's US default.
>
> **languageCode** `string ("" | "af" | "sq" | "sm" | "ar" | "az" | "eu" | "be" | "bn" | "bh" | "bs" | "bg" | "ca" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "en" | "eo" | "et" | "fo" | "fi" | "fr" | "fy" | "gl" | "ka" | "de" | "el" | "gu" | "iw" | "hi" | "hu" | "is" | "id" | "ia" | "ga" | "it" | "ja" | "jw" | "kn" | "ko" | "la" | "lv" | "lt" | "mk" | "ms" | "ml" | "mt" | "mr" | "ne" | "no" | "nn" | "oc" | "fa" | "pl" | "pt-BR" | "pt-PT" | "pa" | "ro" | "ru" | "gd" | "sr" | "si" | "sk" | "sl" | "es" | "su" | "sw" | "sv" | "tl" | "ta" | "te" | "th" | "ti" | "tr" | "uk" | "ur" | "uz" | "vi" | "cy" | "xh" | "zu")`
>
> Google interface language from the complete provider-documented enum; empty uses the Actor default.
>
> **mobileResults** `boolean`
>
> Use mobile rather than desktop organic search results.
>
> **maxPagesPerQuery** `integer`
>
> Maximum ordinary Google result pages per query; each page has about ten results.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.50 when supplied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Google Images
>
> **Slug:** `APIFY_SEARCH_GOOGLE_IMAGES`
>
> Search Google Images with hooli/google-images-scraper, requesting up to 20 queries and 100 images per query, with image and source-page information when available. Runs may incur charges; managed calls require an explicit result limit and use a shorter timeout.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.003 per image
>
> **Discount:** 37
>
> #### Input Parameters
>
> **queries** `array` *required*
>
> One to twenty Google Images search queries.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **maxResultsPerQuery** `integer`
>
> Maximum image results returned for each query.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Google News
>
> **Slug:** `APIFY_SEARCH_GOOGLE_NEWS`
>
> Search Google News by keyword, predefined topic, or custom topic URL with data\_xplorer/google-news-scraper-fast. maxArticles sets the requested limit per source; zero requests unlimited mode with a charge cap, but managed calls require an explicit positive limit and runs may incur charges.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.004 per article
>
> **Discount:** 75
>
> #### Input Parameters
>
> **topics** `array`
>
> Predefined Google News topics.
>
> **keywords** `array`
>
> Google News keyword queries. Search operators such as site:, OR, quotes, and exclusions are supported.
>
> **timeframe** `string ("1h" | "1d" | "7d" | "30d" | "1y" | "all")`
>
> Publication window for keyword searches; topic feeds provide their own curated window.
>
> **topicUrls** `array`
>
> Google News topic or section URLs for custom topic feeds.
>
> **decodeUrls** `boolean`
>
> Resolve Google News redirects to publisher URLs; this increases run time.
>
> **maxArticles** `integer`
>
> Maximum articles per keyword, topic, or topic URL. Zero requests the Actor's documented unlimited mode.
>
> **extractImages** `boolean`
>
> Fetch article images, including publisher og:image fallbacks.
>
> **regionLanguage** `string ("US:en" | "SK:sk" | "AU:en" | "BW:en" | "CA:en" | "ET:en" | "GH:en" | "IN:en" | "ID:en" | "IE:en" | "IL:en" | "KE:en" | "LV:en" | "MY:en" | "NA:en" | "NZ:en" | "NG:en" | "PK:en" | "PH:en" | "SG:en" | "ZA:en" | "TZ:en" | "UG:en" | "GB:en" | "ZW:en" | "ID:id" | "CZ:cs" | "DE:de" | "AT:de" | "CH:de" | "AR:es-419" | "CL:es-419" | "CO:es-419" | "CU:es-419" | "ES:es" | "US:es-419" | "MX:es-419" | "PE:es-419" | "VE:es-419" | "BE:fr" | "CA:fr" | "FR:fr" | "MA:fr" | "SN:fr" | "CH:fr" | "IT:it" | "LV:lv" | "LT:lt" | "HU:hu" | "BE:nl" | "NL:nl" | "NO:no" | "PL:pl" | "BR:pt-419" | "PT:pt-150" | "RO:ro" | "SI:sl" | "SE:sv" | "VN:vi" | "TR:tr" | "GR:el" | "BG:bg" | "RU:ru" | "UA:ru" | "RS:sr" | "UA:uk" | "IL:he" | "AE:ar" | "SA:ar" | "LB:ar" | "EG:ar" | "IN:mr" | "IN:hi" | "BD:bn" | "IN:bn" | "IN:ta" | "IN:te" | "IN:ml" | "TH:th" | "CN:zh-Hans" | "TW:zh-Hant" | "HK:zh-Hant" | "JP:ja" | "KR:ko")`
>
> Actor-supported region and language pair such as US:en, FR:fr, or JP:ja.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **proxyConfiguration** `object`
>
> Apify Proxy configuration used by the Actor.
>
> **extractDescriptions** `boolean`
>
> Fetch article-page descriptions; this increases run time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Google Shopping
>
> **Slug:** `APIFY_SEARCH_GOOGLE_SHOPPING`
>
> Search localized Google Shopping products and offers with burbn/google-shopping-scraper. Request one page numbered 1–100 with a product limit between 10 and 100; fewer results may be returned and runs may incur charges.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.005 per product
>
> #### Input Parameters
>
> **page** `integer`
>
> Google Shopping page to fetch.
>
> **limit** `integer`
>
> Maximum products to return from the requested page.
>
> **onSale** `boolean`
>
> Only include products currently on sale.
>
> **sortBy** `string ("BEST_MATCH" | "LOWEST_PRICE" | "HIGHEST_PRICE" | "TOP_RATED")`
>
> Optional result ordering.
>
> **stores** `string`
>
> Optional comma-separated store names to include.
>
> **country** `string`
>
> ISO 3166-1 alpha-2 country code for localized results.
>
> **language** `string`
>
> ISO 639-1 language code for localized results.
>
> **maxPrice** `number`
>
> Optional maximum product price.
>
> **minPrice** `number`
>
> Optional minimum product price.
>
> **freeReturns** `boolean`
>
> Only include offers with free returns.
>
> **searchQuery** `string` *required*
>
> Product name, brand, or keywords to search on Google Shopping.
>
> **freeShipping** `boolean`
>
> Only include free-shipping offers.
>
> **productCondition** `string ("ANY" | "NEW" | "USED" | "REFURBISHED")`
>
> Optional product condition filter.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Instagram
>
> **Slug:** `APIFY_SEARCH_INSTAGRAM`
>
> Discover Instagram places, profiles, hashtags, or popular reels by keyword. Use the focused post, profile, or hashtag-feed scrapers after discovery when deeper records are needed. This starts a paid run: Free-plan pricing is \$2.70 per 1,000 results and Starter pricing is \$2.30 per 1,000 (about 12,600 results with the included monthly usage); the headline rate starts at \$1.50 per 1,000. The event price includes Actor compute; later dataset storage and reads can consume account usage. Results are capped at 250 per search term and all charges count against monthly Apify usage. Apify limits the API to 250,000 requests per minute globally and reports the current per-resource limit in the X-RateLimit-Limit response header.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per result
>
> **Discount:** 25
>
> #### Input Parameters
>
> **search** `string` *required*
>
> Keyword to search. Separate multiple terms with commas; searchLimit applies independently to each term.
>
> **liveSearch** `boolean`
>
> Use live Instagram search instead of standard indexed sources. Live results can have a slightly different shape.
>
> **searchType** `string ("place" | "user" | "hashtag" | "popular")` *required*
>
> Result family: places, profiles, hashtags, or popular reels.
>
> **searchLimit** `integer`
>
> Maximum results per comma-separated search term. Instagram returns at most 250 per term; each returned item is chargeable.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **enhanceUserSearchWithFacebookPage** `boolean`
>
> For the first ten profile results, also extract Facebook page data that can contain business contact details. Use only where collection is lawful.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Jobs Across Sites
>
> **Slug:** `APIFY_SEARCH_JOBS_ACROSS_SITES`
>
> Search public employer-hosted jobs across Greenhouse, Lever, and Ashby with agentx/all-jobs-scraper. Pricing is \$0.00350 per result on Free, \$0.00315 Bronze, \$0.00280 Silver, and \$0.00263 Gold or higher, plus a \$0.01 Actor-start event per GB (minimum one). A 100-result Free run with one minimum start costs about \$0.36. Charges consume monthly credits; in-run compute is event-priced, while retained datasets and later reads consume platform storage usage. Each call creates a paid run and dataset. maxResults is capped at 100 per selected platform and contacts are omitted from this action's typed contract. Source filters can yield fewer results or duplicates. Apify's global API rate limit is 250,000 requests/minute; synchronous waiting ends after 300 seconds and paid POSTs are not safely retryable.
>
> #### Input Parameters
>
> **country** `string ("Algeria" | "Angola" | "Argentina" | "Australia" | "Austria" | "Azerbaijan" | "Bahrain" | "Bangladesh" | "Belgium" | "Bosnia and Herzegovina" | "Brazil" | "Bulgaria" | "Cameroon" | "Canada" | "Chile" | "China" | "Colombia" | "Costa Rica" | "Croatia" | "Cyprus" | "Czechia" | "Denmark" | "Dominican Republic" | "Ecuador" | "Egypt" | "El Salvador" | "Estonia" | "Finland" | "France" | "Germany" | "Ghana" | "Greece" | "Guatemala" | "Hong Kong" | "Hungary" | "India" | "Indonesia" | "Iraq" | "Ireland" | "Israel" | "Italy" | "Ivory Coast" | "Japan" | "Jordan" | "Kazakhstan" | "Kenya" | "Kuwait" | "Latvia" | "Lebanon" | "Libya" | "Lithuania" | "Luxembourg" | "Malaysia" | "Malta" | "Mexico" | "Morocco" | "Mozambique" | "Netherlands" | "New Zealand" | "Nigeria" | "Norway" | "Oman" | "Pakistan" | "Panama" | "Peru" | "Philippines" | "Poland" | "Portugal" | "Puerto Rico" | "Qatar" | "Romania" | "Russia" | "Saudi Arabia" | "Senegal" | "Serbia" | "Singapore" | "Slovakia" | "Slovenia" | "South Africa" | "South Korea" | "Spain" | "Sweden" | "Switzerland" | "Taiwan" | "Thailand" | "Tunisia" | "Turkey" | "Uganda" | "Ukraine" | "United Arab Emirates" | "United Kingdom" | "United States" | "Uruguay" | "Uzbekistan" | "Venezuela" | "Vietnam" | "Yemen" | "Zambia")` *required*
>
> Country from the Actor's complete documented 98-country enum.
>
> **keyword** `string` *required*
>
> Job title, skill, or company query.
>
> **job\_type** `string ("all" | "fulltime" | "parttime" | "internship" | "contract")`
>
> Employment-type filter where supported.
>
> **location** `string`
>
> Optional city, area, or postal code.
>
> **platforms** `array` *required*
>
> Employer-hosted ATS platforms to search; limited to Greenhouse, Lever, and Ashby.
>
> **max\_results** `integer`
>
> Maximum job rows returned from each selected platform.
>
> **remote\_only** `boolean`
>
> Request remote-only jobs where the selected platform supports it.
>
> **posted\_since** `string`
>
> Optional absolute date or relative interval such as 24h, where supported.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search LinkedIn Companies
>
> **Slug:** `APIFY_SEARCH_LINKEDIN_COMPANIES`
>
> Search public LinkedIn companies in short mode with harvestapi/linkedin-company-search, without LinkedIn cookies. This paid call creates a run and dataset; maxItems and takePages bound results, maxTotalChargeUsd provides an additional charge limit, and managed calls require an explicitly supplied positive maxItems.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per company
>
> **Discount:** 50
>
> #### Input Parameters
>
> **maxItems** `integer`
>
> Maximum short company records to return across all searched pages.
>
> **locations** `array`
>
> LinkedIn company locations to include.
>
> **startPage** `integer`
>
> First one-based LinkedIn company search page to scrape.
>
> **takePages** `integer`
>
> Maximum number of LinkedIn company search pages to scrape.
>
> **industryIds** `array`
>
> LinkedIn industry IDs to include.
>
> **searchQuery** `string` *required*
>
> Company name or keywords to search for on LinkedIn.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search LinkedIn Jobs
>
> **Slug:** `APIFY_SEARCH_LINKEDIN_JOBS`
>
> Search LinkedIn jobs and return job, application, salary, and company details without LinkedIn credentials. This paid call creates a run and dataset; maxTotalChargeUsd sets a run charge limit, and managed calls also require an explicitly supplied positive maxItems.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.001 per job
>
> #### Input Parameters
>
> **page** `integer`
>
> Search page at which to start; each page contains 25 jobs.
>
> **geoIds** `array`
>
> LinkedIn geographic IDs to include.
>
> **salary** `array`
>
> Minimum annual salary thresholds.
>
> **sortBy** `string ("date" | "relevance")`
>
> Sort newest first or by relevance.
>
> **company** `array`
>
> Company names or full LinkedIn company URLs to include.
>
> **maxItems** `integer`
>
> Maximum jobs for each job-title and location input; 0 requests all available pages, up to 40 pages.
>
> **easyApply** `boolean`
>
> Only jobs supporting LinkedIn Easy Apply.
>
> **jobTitles** `array`
>
> LinkedIn job-search queries; each query runs separately and supports Boolean operators.
>
> **locations** `array`
>
> LinkedIn locations applied to every job-title query.
>
> **industryIds** `array`
>
> LinkedIn industry IDs to include.
>
> **postedLimit** `string ("1h" | "24h" | "week" | "month")`
>
> Only jobs posted within this interval.
>
> **workplaceType** `array`
>
> Remote, hybrid, or on-site workplace filters.
>
> **employmentType** `array`
>
> Employment-type filters.
>
> **experienceLevel** `array`
>
> LinkedIn experience-level filters.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.002 when supplied.
>
> **under10Applicants** `boolean`
>
> Only jobs showing fewer than ten applicants.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search LinkedIn Posts
>
> **Slug:** `APIFY_SEARCH_LINKEDIN_POSTS`
>
> Search public LinkedIn posts with harvestapi/linkedin-post-search, optionally requesting comments and reactions as separately charged records and nested post fields. This paid Actor run requires an explicitly supplied positive maxPosts on managed calls, which do not permit comment or reaction scraping.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per post
>
> **Discount:** 25
>
> #### Input Parameters
>
> **sortBy** `string ("relevance" | "date")`
>
> Sort by query relevance or newest date.
>
> **maxPosts** `integer`
>
> Maximum posts per query; 0 requests all available posts. LinkedIn generally exposes at most 400-500 posts per query. Use maxTotalChargeUsd separately to cap total run charges.
>
> **authorUrls** `array`
>
> LinkedIn profile or company URLs whose authors posted or reposted the content.
>
> **maxComments** `integer`
>
> Maximum comments per post when comment scraping is enabled.
>
> **postedLimit** `string ("1h" | "24h" | "week" | "month" | "3months" | "6months" | "year")`
>
> Only return posts no older than this documented interval.
>
> **maxReactions** `integer`
>
> Maximum reactions per post when reaction scraping is enabled.
>
> **searchQueries** `array` *required*
>
> One to ten LinkedIn search queries. Each query is limited to 500 characters and five Boolean operators.
>
> **scrapeComments** `boolean`
>
> Scrape comments. Each comment is charged as a separate result.
>
> **postedLimitDate** `string`
>
> Inclusive oldest date as a JavaScript-compatible date-time string or millisecond timestamp.
>
> **scrapeReactions** `boolean`
>
> Scrape reactions. Each reaction is charged as a separate result.
>
> **authorsCompanies** `array`
>
> LinkedIn company names where post authors work.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search LinkedIn Profiles
>
> **Slug:** `APIFY_SEARCH_LINKEDIN_PROFILES`
>
> Run HarvestAPI's broad LinkedIn people search. Free/Bronze pricing is \$0.10 per search page (up to 25 short profiles), plus \$0.004 per full profile; paid tiers discount those events. Email-search mode is intentionally omitted because its output contract is not strongly documented. Actor compute is included; later dataset retention and reads affect storage usage, and charges consume monthly credits. LinkedIn normally limits one query to 2,500 profiles and 100 pages, while automatic segmentation supports larger bounded workloads. Creates a paid run and dataset; use maxItems, takePages, or maxTotalChargeUsd to bound exposure.
>
> #### Input Parameters
>
> **schools** `array`
>
> LinkedIn schools to include.
>
> **maxItems** `integer`
>
> Maximum profiles across all queries; 0 requests all available records, normally at most 2,500 per query.
>
> **lastNames** `array`
>
> Last names to include; use the dedicated name action for exact person lookup.
>
> **locations** `array`
>
> Current LinkedIn locations to include.
>
> **startPage** `integer`
>
> First LinkedIn search page to scrape.
>
> **takePages** `integer`
>
> Search pages per query or per automatic segment; each page has up to 25 profiles.
>
> **firstNames** `array`
>
> First names to include; use the dedicated name action for exact person lookup.
>
> **functionIds** `array`
>
> LinkedIn function IDs, such as 8 for Engineering.
>
> **industryIds** `array`
>
> LinkedIn industry IDs, such as 4 for Software Development.
>
> **searchQuery** `string`
>
> Fuzzy LinkedIn people-search query; LinkedIn Boolean operators are supported.
>
> **pastCompanies** `array`
>
> Past-company LinkedIn URLs to include.
>
> **pastJobTitles** `array`
>
> Exact past job titles to include.
>
> **excludeSchools** `array`
>
> LinkedIn schools to exclude.
>
> **companyHeadcount** `array`
>
> Current-company headcount bands A-I, from self-employed through 10,001+.
>
> **currentCompanies** `array`
>
> Current-company LinkedIn URLs to include.
>
> **currentJobTitles** `array`
>
> Exact current job titles to include.
>
> **excludeLocations** `array`
>
> Current locations to exclude.
>
> **profileLanguages** `array`
>
> LinkedIn profile-language filters.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.10 when supplied.
>
> **seniorityLevelIds** `array`
>
> LinkedIn seniority IDs from trainee through owner/partner.
>
> **excludeFunctionIds** `array`
>
> LinkedIn function IDs to exclude.
>
> **excludeIndustryIds** `array`
>
> LinkedIn industry IDs to exclude.
>
> **profileScraperMode** `string ("Short" | "Full")`
>
> Return short search records or full typed profiles. Email-search mode is omitted because its output contract is not documented strongly enough.
>
> **recentlyChangedJobs** `boolean`
>
> Only profiles that changed jobs in the last 90 days.
>
> **excludePastCompanies** `array`
>
> Past-company LinkedIn URLs to exclude.
>
> **excludePastJobTitles** `array`
>
> Past job titles to exclude.
>
> **yearsOfExperienceIds** `array`
>
> LinkedIn experience bands: 1=\<1 year through 5=>10 years.
>
> **autoQuerySegmentation** `boolean`
>
> Split broad searches into smaller queries to exceed LinkedIn's 2,500-result query cap.
>
> **excludeCurrentCompanies** `array`
>
> Current-company LinkedIn URLs to exclude.
>
> **excludeCurrentJobTitles** `array`
>
> Current job titles to exclude.
>
> **excludeSeniorityLevelIds** `array`
>
> LinkedIn seniority IDs to exclude.
>
> **recentlyPostedOnLinkedIn** `boolean`
>
> Only profiles that posted on LinkedIn in the last 30 days.
>
> **yearsAtCurrentCompanyIds** `array`
>
> LinkedIn current-company tenure bands: 1=\<1 year through 5=>10 years.
>
> **autoQuerySegmentationLevels** `array`
>
> Country, state, seniority, or industry segmentation levels.
>
> **companyHeadquarterLocations** `array`
>
> Current-company headquarters locations to include.
>
> **excludeCompanyHeadquarterLocations** `array`
>
> Current-company headquarters locations to exclude.
>
> **autoQuerySegmentationTargetCountries** `array`
>
> Countries on which automatic query segmentation should focus.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search LinkedIn Profiles by Name
>
> **Slug:** `APIFY_SEARCH_LINKEDIN_PROFILES_BY_NAME`
>
> Find LinkedIn profiles by first name, last name, or both, using short or full profile mode. This paid call creates a run and dataset; maxItems, maxPages, and maxTotalChargeUsd can bound exposure, while managed calls require an explicitly supplied positive maxPages and short profile mode.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.004 per search page
>
> **Discount:** 25
>
> #### Input Parameters
>
> **schools** `array`
>
> LinkedIn schools to include.
>
> **lastName** `string`
>
> Person's last name. Supply a last name, a first name, or both; strictSearch requires exact matches for every supplied name.
>
> **maxItems** `integer`
>
> Maximum profiles; 0 requests all available records, up to 1,000 for one name query.
>
> **maxPages** `integer`
>
> Maximum search pages for this name query; each page has up to 10 profiles.
>
> **firstName** `string`
>
> Person's first name. Supply a first name, a last name, or both; strictSearch requires exact matches for every supplied name.
>
> **locations** `array`
>
> Current LinkedIn locations to include.
>
> **industryIds** `array`
>
> LinkedIn industry IDs to include.
>
> **strictSearch** `boolean`
>
> Require exact matches for every supplied name field.
>
> **pastCompanies** `array`
>
> Past-company LinkedIn URLs to include.
>
> **currentCompanies** `array`
>
> Current-company LinkedIn URLs to include.
>
> **currentJobTitles** `array`
>
> Exact current job titles to include.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.004 when supplied.
>
> **profileScraperMode** `string ("Short" | "Full")` *required*
>
> Return short search records or full typed profiles. Email-search mode is omitted because its output contract is not documented strongly enough.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search LinkedIn Profiles by Services
>
> **Slug:** `APIFY_SEARCH_LINKEDIN_PROFILES_BY_SERVICES`
>
> Find LinkedIn profiles by services, keywords, or location, using short or full profile mode. This paid call creates a run and dataset; maxItems, takePages, and maxTotalChargeUsd can bound exposure, while managed calls require an explicitly supplied positive maxItems and short profile mode.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per profile
>
> **Discount:** 50
>
> #### Input Parameters
>
> **search** `string`
>
> Service or keyword query for LinkedIn profile discovery; LinkedIn Boolean operators are supported.
>
> **maxItems** `integer`
>
> Maximum profiles to scrape; 0 requests all available profiles.
>
> **locations** `array`
>
> Current LinkedIn locations to include.
>
> **startPage** `integer`
>
> First search-results page to scrape.
>
> **takePages** `integer`
>
> Number of search pages to scrape. The README says 10 profiles per page, while the current OpenAPI description says 25.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD; this Actor requires at least \$0.01 when supplied.
>
> **profileScraperMode** `string ("Short" | "Full")`
>
> Return short search records or full typed profiles. Email-search mode is omitted because its output contract is not documented strongly enough.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Local Fuel Prices
>
> **Slug:** `APIFY_SEARCH_LOCAL_FUEL_PRICES`
>
> Search crowd-reported local US station fuel prices using the independent johnvc/fuelprices Actor. This paid call starts a run and requires a maximum run charge; in managed mode, error and no-result records are filtered, and no usable results causes an error.
>
> #### Input Parameters
>
> **fuel** `integer ("1" | "2" | "3" | "4" | "5" | "12")`
>
> Documented GasBuddy fuel-type code.
>
> **maxAge** `integer`
>
> Maximum reported-price age in days.
>
> **search** `string` *required*
>
> US ZIP code, city, or public location to search near.
>
> **maxTotalChargeUsd** `number` *required*
>
> Required total run charge cap because this Actor has no input-level result limit.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search TikTok Users
>
> **Slug:** `APIFY_SEARCH_TIK_TOK_USERS`
>
> Search public TikTok creator profiles by keyword using clockworks/tiktok-user-search-scraper. This paid Actor run may continue after a synchronous timeout; managed calls require an explicitly supplied positive profile limit and filter out error or empty results.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.005 per profile
>
> **Discount:** 50
>
> #### Input Parameters
>
> **searchQueries** `array` *required*
>
> Keywords or names to search for in TikTok's public user search.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **maxProfilesPerQuery** `integer`
>
> Maximum public creator profiles to return for each search query.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Tripadvisor Places
>
> **Slug:** `APIFY_SEARCH_TRIPADVISOR_PLACES`
>
> Search public Tripadvisor hotels, restaurants, and attractions with maxcopell/tripadvisor. Pricing per 1,000 places is \$5 Free, \$2.90 Bronze, \$2.50 Silver, \$2 Gold, \$1.50 Platinum, or \$1.25 Diamond, plus a \$0.00005 start event; 10,000 monthly places cost about \$50/\$29/\$25/\$20/\$15/\$12.50 before start charges. Price offers, AI summaries, photos, lead enrichment, and email verification are disabled by construction. Actor compute and in-run storage are included; retained datasets and later reads can consume platform usage. This is a third-party scrape, not Tripadvisor's official API; preserve id and webUrl. Bound maxItemsPerQuery and maxTotalChargeUsd.
>
> #### Input Parameters
>
> **query** `string`
>
> Tripadvisor place search query.
>
> **currency** `string`
>
> Three-letter display currency.
>
> **language** `string`
>
> Result language code.
>
> **startUrls** `array`
>
> Tripadvisor place or category URLs.
>
> **includeTags** `boolean`
>
> Include public review-topic tags.
>
> **includeHotels** `boolean`
>
> Include hotels.
>
> **maxItemsPerQuery** `integer`
>
> Maximum places per query or URL.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> **includeAttractions** `boolean`
>
> Include attractions.
>
> **includeRestaurants** `boolean`
>
> Include restaurants.
>
> **includeNearbyResults** `boolean`
>
> Include nearby matches.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Upwork Jobs
>
> **Slug:** `APIFY_SEARCH_UPWORK_JOBS`
>
> Search public Upwork jobs with the third-party neatrat/upwork-job-scraper, using keyword and job filters. Paid runs request up to five pages of 10–100 jobs; a run may continue after a synchronous timeout.
>
> #### Input Parameters
>
> **page** `integer`
>
> First results page to scrape.
>
> **sort** `string ("newest" | "relevance")`
>
> Order jobs by newest posting time or search relevance.
>
> **query** `string` *required*
>
> Keywords to search in Upwork jobs.
>
> **jobType** `array`
>
> Fixed-price or hourly jobs.
>
> **perPage** `integer`
>
> Jobs requested per page; the Actor minimum is ten.
>
> **location** `array`
>
> Upwork regions, subregions, or country names.
>
> **maxJobAge** `object`
>
> Exclude jobs older than this value-and-unit duration.
>
> **clientHistory** `array`
>
> Client hiring-history filters.
>
> **pagesToScrape** `integer`
>
> Number of sequential pages to scrape.
>
> **experienceLevel** `array`
>
> Required experience levels.
>
> **fixedPriceRange** `array`
>
> Minimum and maximum fixed-price budget in USD.
>
> **hourlyRateRange** `array`
>
> Minimum and maximum hourly rate in USD.
>
> **paymentVerified** `boolean`
>
> Optionally require or exclude clients with verified payment.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Yandex Market Products
>
> **Slug:** `APIFY_SEARCH_YANDEX_MARKET_PRODUCTS`
>
> Search public Yandex Market listings using zen-studio/yandex-market-scraper-parser, with reviews and product enrichment disabled. Managed runs require an explicitly supplied positive maxItems and are subject to a \$2 charge cap; results are third-party scraped observations.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.005 per product
>
> **Discount:** 30
>
> #### Input Parameters
>
> **query** `string` *required*
>
> Product query or Yandex Market URL.
>
> **region** `string ("2" | "54" | "213" | "202" | "43" | "56" | "62" | "66" | "65" | "39" | "172" | "35" | "16" | "47" | "38" | "51")`
>
> Documented Yandex Market region ID.
>
> **sortBy** `string ("dpop" | "aprice" | "dprice" | "rating")`
>
> Sort by popularity, price, or rating.
>
> **priceTo** `integer`
>
> Maximum price in RUB.
>
> **maxItems** `integer`
>
> Maximum products to return.
>
> **priceFrom** `integer`
>
> Minimum price in RUB.
>
> **categoryId** `string`
>
> Yandex Market category ID.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Zillow Properties
>
> **Slug:** `APIFY_SEARCH_ZILLOW_PROPERTIES`
>
> Discover Zillow listings from search URLs using fixed Actor X46xKaa20oUA1fRiP and a selected extraction method. Managed runs require an explicit resultsLimit, cap charges at \$2, and stop the Actor after 50 seconds; an interrupted paid run may still need inspection before retrying.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.002 per listing
>
> **Discount:** 35
>
> #### Input Parameters
>
> **searchUrls** `array` *required*
>
> Zillow search URLs with location and property filters already encoded in searchQueryState.
>
> **resultsLimit** `integer`
>
> Maximum properties per search URL. Omit to collect all results available to the selected method.
>
> **extractionMethod** `string ("PAGINATION_WITH_ZOOM_IN" | "PAGINATION" | "MAP_MARKERS")` *required*
>
> Discovery strategy: complete recursive map zoom, visible pagination, or visible map markers.
>
> **maxTotalChargeUsd** `number`
>
> Maximum total run charge in USD accepted by the Actor run endpoint. Charges already incurred count toward monthly usage; Actor behavior at the cap depends on its pricing implementation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Store Data in Dataset
>
> **Slug:** `APIFY_STORE_DATA_IN_DATASET`
>
> Append a batch of JSON objects to an existing Apify dataset.
>
> #### Input Parameters
>
> **data** `array` *required*
>
> Array of JSON-serializable objects to store in the dataset.
>
> **omit** `string`
>
> Comma-separated list of fields to exclude when storing items.
>
> **fields** `string`
>
> Comma-separated list of fields to include when storing items.
>
> **datasetId** `string` *required*
>
> Dataset ID or name (e.g., 'username/datasetName' or dataset ID).
>
> **deduplicate** `boolean`
>
> If true, deduplicate incoming items by their 'foreignId'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Store Data in Key-Value Store
>
> **Slug:** `APIFY_STORE_DATA_IN_KEY_VALUE_STORE`
>
> Tool to create or update a record in a key-value store. Use after you have the store ID and record key to persist JSON data.
>
> #### Input Parameters
>
> **storeId** `string` *required*
>
> ID of the key-value store where the record will be stored.
>
> **recordKey** `string` *required*
>
> Key under which the record will be stored or updated.
>
> **recordValue** `object` *required*
>
> The JSON object to store. Must be JSON-serializable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of Actors in Store
>
> **Slug:** `APIFY_STORE_GET`
>
> Tool to get list of public Actors from Apify Store. Use when you need to browse or search public Actors available in the store. Supports searching by title, name, description, username, and readme.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of Actors to return (pagination). Default is 10, maximum is 1000.
>
> **offset** `integer`
>
> Number of Actors to skip at the start (pagination). Default is 0.
>
> **search** `string`
>
> Search string to filter Actors by title, name, description, username, and readme. Example: 'web scraper'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Key-Value Store
>
> **Slug:** `APIFY_UPDATE_KEY_VALUE_STORE`
>
> Tool to update a key-value store's properties. Use when renaming or changing access of the store after confirming the store ID.
>
> #### Input Parameters
>
> **name** `string`
>
> New name for the key-value store.
>
> **access** `string ("PRIVATE" | "SHARED")`
>
> Access level for the store. PRIVATE (requires authentication) or SHARED (anyone with ID can read).
>
> **storeId** `string` *required*
>
> Identifier of the key-value store to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Task Input
>
> **Slug:** `APIFY_UPDATE_TASK_INPUT`
>
> Tool to update the input configuration of a specific Actor task. Use when you need to modify a scheduled tasks input before execution.
>
> #### Input Parameters
>
> **input** `object` *required*
>
> The new input configuration object for the task.
>
> **taskId** `string` *required*
>
> ID of the Actor task to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Public User Data
>
> **Slug:** `APIFY_USER_GET`
>
> Get public profile information for a specified Apify user account.
>
> #### Input Parameters
>
> **userId** `string` *required*
>
> User identifier or username to retrieve public information for (e.g., 'apify', 'HGzIk8z78YcAPEB').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current User Account Data
>
> **Slug:** `APIFY_USERS_ME_GET`
>
> Tool to get private user account information. Use when you need to retrieve comprehensive data about the current user identified by the authentication token, including profile, subscription plan, and proxy settings. Note: 'plan', 'email', and 'profile' fields are omitted when accessed from Actor run.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Limits
>
> **Slug:** `APIFY_USERS_ME_LIMITS_GET`
>
> Tool to get a complete summary of account limits and usage. Use when you need to retrieve information about usage cycles, spending caps, compute resources, data transfer quotas, and other account limits. This shows the same information as the Limits page in Apify console.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Account Limits
>
> **Slug:** `APIFY_USERS_ME_LIMITS_PUT`
>
> Tool to update account limits manageable on the Limits page. Use when you need to set or modify the monthly spending cap (maxMonthlyUsageUsd) or data retention period (dataRetentionDays). At least one limit parameter must be provided.
>
> #### Input Parameters
>
> **dataRetentionDays** `integer`
>
> Storage duration for historical data in days. Determines how long data persists before automatic deletion. The platform securely stores your ten most recent Actor runs indefinitely while other storages follow the retention period. Adjustable for subscribed users.
>
> **maxMonthlyUsageUsd** `number`
>
> Monthly spending cap in USD. Controls overage charges by setting a hard limit on monthly platform usage. If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Monthly Usage
>
> **Slug:** `APIFY_USERS_ME_USAGE_MONTHLY_GET`
>
> Tool to get monthly usage summary with daily breakdown. Use when you need detailed usage information including storage, data transfer, and request queue metrics for the current or a specific billing cycle. This shows the same information as the Billing page in Apify console.
>
> #### Input Parameters
>
> **date** `string`
>
> ISO date string to query usage for the billing cycle containing that date. If not provided, returns data for the current usage cycle. Format: YYYY-MM-DD or ISO 8601 date string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Actor Input
>
> **Slug:** `APIFY_VALIDATE_ACTOR_INPUT`
>
> Validate input against an Actor build without starting a run.
>
> #### Input Parameters
>
> **build** `string`
>
> Build tag or build number whose input schema is used. Omit to use the Actor's default build.
>
> **input** `object` *required*
>
> Candidate Actor input JSON object to validate.
>
> **actorId** `string` *required*
>
> Actor ID or owner's username and Actor name separated by a tilde (\~) or forward slash (/).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get list of webhook dispatches
>
> **Slug:** `APIFY_WEBHOOK_DISPATCHES_GET`
>
> Tool to get list of webhook dispatches for the user. Use when you need to retrieve webhook execution history with pagination support.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true, sort by createdAt in descending order. Default is ascending.
>
> **limit** `integer`
>
> Maximum number of records to return (pagination). Default and max is 1000.
>
> **offset** `integer`
>
> Number of records to skip at the start (pagination). Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webhook Dispatch
>
> **Slug:** `APIFY_WEBHOOK_DISPATCH_GET`
>
> Tool to get webhook dispatch object with all details. Use when you need to retrieve information about a specific webhook dispatch including its status, event data, and call history.
>
> #### Input Parameters
>
> **dispatchId** `string` *required*
>
> The unique identifier for the webhook dispatch being queried.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get webhook
>
> **Slug:** `APIFY_WEBHOOK_GET`
>
> Tool to get webhook object with all details. Use when you need to retrieve complete information about a specific webhook by its ID.
>
> #### Input Parameters
>
> **webhookId** `string` *required*
>
> Unique identifier of the webhook to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Webhook
>
> **Slug:** `APIFY_WEBHOOK_PUT`
>
> Tool to update webhook using JSON payload. Only specified properties are updated; others remain unchanged. Use when you need to modify webhook settings like event types, target URL, or other configuration.
>
> #### Input Parameters
>
> **isAdHoc** `boolean`
>
> Whether the webhook is ad-hoc (temporary, single dispatch).
>
> **condition** `object`
>
> Webhook condition specifying which Actor, task, or run the webhook applies to.
>
> **webhookId** `string` *required*
>
> Unique identifier of the webhook to update.
>
> **doNotRetry** `boolean`
>
> Whether to disable automatic retry on webhook delivery failure.
>
> **eventTypes** `array`
>
> List of event types that trigger the webhook (e.g., \['ACTOR.RUN.SUCCEEDED', 'ACTOR.RUN.FAILED']).
>
> **requestUrl** `string`
>
> Target URL to which Apify will POST the webhook payload.
>
> **description** `string`
>
> Human-readable description of the webhook.
>
> **headersTemplate** `string`
>
> JSON-like template for request headers with variable substitution support.
>
> **ignoreSslErrors** `boolean`
>
> Whether to ignore SSL certificate validation errors when delivering the webhook.
>
> **payloadTemplate** `string`
>
> JSON-like template for the POST body with variable substitution support.
>
> **shouldInterpolateStrings** `boolean`
>
> Whether to interpolate variables inside strings in payloadTemplate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Test Webhook
>
> **Slug:** `APIFY_WEBHOOK_TEST_POST`
>
> Tool to test a webhook by creating a test dispatch with a dummy payload. Use when you need to verify webhook configuration before production use.
>
> #### Input Parameters
>
> **webhookId** `string` *required*
>
> The unique identifier of the webhook to test. This webhook will receive a test dispatch with a dummy payload.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get webhook dispatches
>
> **Slug:** `APIFY_WEBHOOK_WEBHOOK_DISPATCHES_GET`
>
> Tool to get list of webhook dispatches for a specific webhook. Use when you need to retrieve dispatch history for a particular webhook with pagination support.
>
> #### Input Parameters
>
> **desc** `boolean`
>
> If true, sort by createdAt in descending order. Default is ascending.
>
> **limit** `integer`
>
> Maximum number of records to return (pagination). Default and max is 1000.
>
> **offset** `integer`
>
> Number of records to skip at the start (pagination). Default is 0.
>
> **webhookId** `string` *required*
>
> Unique identifier of the webhook to retrieve dispatches for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
