> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# DataForSEO: Dataforseo Labs Amazon Product Competitors Live

> Find Amazon products that compete with a target ASIN in Amazon search results. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Find Amazon products that compete with a target ASIN in Amazon search results.

> [!NOTE]
>
> Tool ID: `dataforseo_dataforseo_labs_amazon_product_competitors_live`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dataforseo_dataforseo_labs_amazon_product_competitors_live',
  {
    "asin": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute dataforseo_dataforseo_labs_amazon_product_competitors_live --input '{
  "asin": "example"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "version": "example",
  "status_code": 123,
  "status_message": "example",
  "time": "example",
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {}
  ]
}
```

Use `deepline describe dataforseo_dataforseo_labs_amazon_product_competitors_live --json` for the latest machine-readable contract.

## Input reference

This endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. The data can help you identify product competitors for any listing published on Amazon. The returned results are specific to the asin as well as the location and language parameters specified in a POST request.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.asin` | `string` | Yes | — | product ID required field unique product identifier (ASIN) on Amazon. You can receive the asin parameter by making a separate request to the Amazon Products endpoint |
| `payload.location_name` | `string` | No | — | full name of the location required field if don't specify location\_code you can receive the list of available locations with their location\_name by making a separate request to [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) . Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only. example: United States |
| `payload.location_code` | `integer` | No | — | location code required field if don't specify location\_name you can receive the list of available locations with their location\_code by making a separate request to [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) . Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only. example: 2840 |
| `payload.language_name` | `string` | No | — | full name of the language required field if don't specify language\_code you can receive the list of available languages with their language\_name by making a separate request to the [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) example: English |
| `payload.language_code` | `string` | No | — | language code required field if don't specify language\_name you can receive the list of available languages with their language\_code by making a separate request to the [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) example: en |
| `payload.limit` | `integer` | No | — | the maximum number of products in the results array optional field default value: 100 . maximum value: 1000 |
| `payload.filters` | `array` | No | — | array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and , or between the conditions the following operators are supported: regex , not\_regex , \< , \<= , > , >= , = , \<> , in , not\_in , ilike , not\_ilike , like , not\_like , match , not\_match you can use the % operator with like and not\_like , as well as ilike and not\_ilike to match any string of zero or more characters example: See the live schema for the complete constraint. |
| `payload.order_by` | `array` | No | — | results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order you should use a comma to set up a sorting parameter example: \["full\_metrics.amazon\_serp.pos\_1,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: See the live schema for the complete constraint. |
| `payload.offset` | `integer` | No | — | offset in the results array of returned product competitors optional field default value: 0 if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors |
| `payload.tag` | `string` | No | — | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "This endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. The data can help you identify product competitors for any listing published on Amazon. The returned results are specific to the asin as well as the location and language parameters specified in a POST request.",
    "properties": {
      "asin": {
        "type": "string",
        "description": "product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint"
      },
      "location_name": {
        "type": "string",
        "description": "full name of the location required field if don't specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States"
      },
      "location_code": {
        "type": "integer",
        "description": "location code required field if don't specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840"
      },
      "language_name": {
        "type": "string",
        "description": "full name of the language required field if don't specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English"
      },
      "language_code": {
        "type": "string",
        "description": "language code required field if don't specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en"
      },
      "limit": {
        "type": "integer",
        "description": "the maximum number of products in the results array optional field default value: 100 ; maximum value: 1000"
      },
      "filters": {
        "type": "array",
        "description": "array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and , or between the conditions the following operators are supported: regex , not_regex , < , <= , > , >= , = , <> , in , not_in , ilike , not_ilike , like , not_like , match , not_match you can use the % operator with like and not_like , as well as ilike and not_ilike to match any string of zero or more characters example: [\"full_metrics.amazon_serp.pos_1\",\">\", 20] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
        "items": {}
      },
      "order_by": {
        "type": "array",
        "description": "results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order you should use a comma to set up a sorting parameter example: [\"full_metrics.amazon_serp.pos_1,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"] default rule: [\"ranked_serp_element.serp_item.rank_group,asc\"]",
        "items": {}
      },
      "offset": {
        "type": "integer",
        "description": "offset in the results array of returned product competitors optional field default value: 0 if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors"
      },
      "tag": {
        "type": "string",
        "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response"
      }
    },
    "required": [
      "asin"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Top-level response envelope for dataforseo\_dataforseo\_labs\_amazon\_product\_competitors\_live.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.version` | `string` | Yes | — | the current version of the API |
| `result.status_code` | `integer` | Yes | — | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
| `result.status_message` | `string` | Yes | — | general informational message you can find the full list of general informational messages here |
| `result.time` | `string` | Yes | — | execution time, seconds |
| `result.tasks_count` | `integer` | Yes | — | the number of tasks in the tasks array |
| `result.tasks_error` | `integer` | Yes | — | the number of tasks in the tasks array returned with an error |
| `result.tasks` | `array` | Yes | — | array of tasks |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Top-level response envelope for dataforseo_dataforseo_labs_amazon_product_competitors_live.",
    "properties": {
      "version": {
        "type": "string",
        "description": "the current version of the API"
      },
      "status_code": {
        "type": "integer",
        "description": "general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions"
      },
      "status_message": {
        "type": "string",
        "description": "general informational message you can find the full list of general informational messages here"
      },
      "time": {
        "type": "string",
        "description": "execution time, seconds"
      },
      "tasks_count": {
        "type": "integer",
        "description": "the number of tasks in the tasks array"
      },
      "tasks_error": {
        "type": "integer",
        "description": "the number of tasks in the tasks array returned with an error"
      },
      "tasks": {
        "type": "array",
        "description": "array of tasks",
        "items": {}
      }
    },
    "required": [
      "version",
      "status_code",
      "status_message",
      "time",
      "tasks_count",
      "tasks_error",
      "tasks"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.01` per pricing unit.

## Related documentation

* [DataForSEO provider guide](https://deepline.com/docs/providers/dataforseo/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.