Product Competitors API Documentation

Use the Product Competitors API for Amazon product research. Review request parameters, response fields, and runnable examples.

Availability: Available

This endpoint is active in the v1 gateway, OpenAPI, and subscription catalog. A successful call consumes 1 billing unit.

POST /v1/amazon/products/competitors

The request and response fields below match the current public contract.

Quick call

First create an API key, then store it in a server-side environment variable:

export ECOMMERCE_DATA_API_KEY="your_api_key"

curl --request POST \
  --url https://ecommercedataapi.com/v1/amazon/products/competitors \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "marketplace": "US",
  "asin": "B07Z82895W",
  "size": 20
}'

Integrate with an AI CLI

Copy for your AI CLI

Paste this task into Codex, Claude Code, Gemini CLI, or another coding agent.

Integrate the "Product Competitors" endpoint from Ecommerce Data API into the current repository. Make the changes directly instead of only returning sample code.

API documentation: https://ecommercedataapi.com/en/docs/amazon/products/competitors
Endpoint: POST https://ecommercedataapi.com/v1/amazon/products/competitors
API key environment variable: ECOMMERCE_DATA_API_KEY

Example request:
{
"marketplace": "US",
"asin": "B07Z82895W",
"size": 20
}

Requirements:
1. Read the API documentation first, then inspect the repository's language, framework, HTTP client, directory structure, and environment-variable conventions.
2. Reuse the existing API client and error-handling patterns. If none exist, add the smallest reusable Ecommerce Data API client and an endpoint-specific wrapper.
3. Read the key from the server-side ECOMMERCE_DATA_API_KEY environment variable and send Content-Type: application/json plus the X-API-Key header. Never write a real key into source code, browser code, logs, test snapshots, or Git.
4. If the environment variable is missing, tell me to configure ECOMMERCE_DATA_API_KEY myself. Do not request, print, or invent the real key, and continue implementing code and tests that do not require a live request.
5. Implement request and response types from the documentation. Handle non-2xx responses, request_id, error.code, error.message, and 429 rate limits.
6. Add a minimal usage example or test that follows the repository's conventions. Run one minimal live request only when the key is already configured and external requests are allowed; otherwise use mocks or static validation.
7. Run the relevant formatter, type checker, and tests. Report changed files, usage, verification results, and any environment variable I still need to configure.

Need an API key?Create API key

Open this request in Postman

Download the preconfigured collection for this endpoint, then import it into Postman.

Download Postman config

Set the apiKey collection variable after import.Create API key

Node.js example

const response = await fetch(
  'https://ecommercedataapi.com/v1/amazon/products/competitors',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      marketplace: 'US',
      asin: 'B07Z82895W',
      size: 20,
    }),
  }
);

const result = await response.json();

if (!response.ok) {
  throw new Error(`${result.error?.code}: ${result.error?.message}`);
}

console.log(result.data);

Python example

import os
import requests

response = requests.post(
    "https://ecommercedataapi.com/v1/amazon/products/competitors",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "marketplace": "US",
        "asin": "B07Z82895W",
        "size": 20,
    },
    timeout=30,
)

response.raise_for_status()
print(response.json()["data"])

Request body

Send the fields below directly in the JSON body without an extra wrapper. Undefined fields are rejected.

Field	Type	Required	Description	Example
`marketplace`	String	No	Amazon marketplace code. Supported values are listed in the schema.	US
`asin`	String	Yes	Amazon Standard Identification Number.	B08GHW4TBS
`size`	Integer	No	Number of results per page.	20

Response structure

Field	Type	Description
`request_id`	String	Unique identifier for this request.
`data`	Array	Endpoint business data.

The fields below are inside data. For array endpoints they describe one array item; for paginated endpoints they describe one record in items[].

Response fields

Field	Type	Description	Example
`asin`	String	ASIN.	B078J8VPVW
`brand`	String	Brand.	Pampers
`brandUrl`	String	Brand URL.	https://www.amazon.com/s?k=HP
`imageUrl`	String	Image URL.	https://images-na.ssl-images-amazon.com/images/I/51axlzme6aL .AC_US200.jpg
`title`	String	Title.	Diapers Size ……
`parent`	String	Parent.	B081RGNL17
`nodeId`	Integer	Node ID.	3741281
`nodeIdPath`	String	Node ID path.	2619525011:3741271:3741281
`nodeLabelPath`	String	Node label path.	Baby Products:Diapering:Disposable Diapers
`symbol`	String	Symbol.	Y
`bsrId`	String	BSR ID.	office-products
`bsr`	Integer	BSR.	1
`bsrCr`	Number	BSR change rate. Percentage or ratio value as documented.	926.67
`bsrCv`	Integer	BSR change value.	10
`units`	Integer	Units.	26289
`unitsGr`	Number	Units gr. Percentage or ratio value as documented.	-46.3
`amzUnit`	Integer	Amazon unit.	4000
`amzSales`	Number	Amazon sales.	235000
`amzUnitDate`	Integer	Amazon unit date. Date or timestamp value.	1.70248E+12
`revenue`	Number	Revenue.	1693537.4
`price`	Number	Price.	64.42
`primePrice`	Number	Prime price.	42
`profit`	Number	Profit. Percentage or ratio value as documented.	63.92
`fba`	Number	FBA.	13.58
`ratings`	Integer	Ratings.	32004
`ratingsRate`	Number	Ratings rate. Percentage or ratio value as documented.	40.57
`rating`	Number	Rating.	4.8
`ratingsCv`	Integer	Ratings change value.	10666
`ratingDelta`	Integer	Rating delta.	0
`lqs`	Number	Listing quality score.	-
`availableDate`	Integer	Available date. Date or timestamp value.	1.45408E+12
`fulfillment`	String	Fulfillment.	AMZ or FBA or FBM
`variations`	Integer	Variations.	7
`sellers`	Integer	Sellers.	7
`sellerId`	String	Seller ID.	A1Y8BVAASXO4R7
`sellerName`	String	Seller name.	Amazon
`sellerNation`	String	Seller nation.	见表 1.5
`badge`	Object	Badge.	包括了下面 5 个标识
`badge.bestSeller`	String	Best seller.	Y / N
`badge.amazonChoice`	String	Amazon choice.	Y / N
`badge.newRelease`	String	New release.	Y / N
`badge.ebc`	String	A+ content.	Y / N
`badge.video`	String	Video.	Y / N
`weight`	String	Weight.	8.88 pounds
`dimension`	String	Dimension.	13.3 x 15.8 x 10.6 inches
`dimensionsType`	String	Dimensions type.	ST,0V
`pkgDimensions`	String	Pkg dimensions.	14.3 x 16.8 x 12.6 inches
`pkgDimensionType`	String	Pkg dimension type.	-
`pkgWeight`	String	Pkg weight.	18.88 pounds
`sku`	String	Sku.	["Color: Beige","Size: 47 inches"]
`subcategories`	Array	Subcategories.	-
`subcategories.code`	String	Code.	1063242
`subcategories.rank`	Integer	Rank.	1
`subcategories.label`	String	Label.	Bath Rugs
`deliveryPrice`	Number	Delivery price.	4

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": [
    {
      "asin": "B0DGVP84B5",
      "brand": "Apple",
      "brandUrl": "https://www.amazon.com/s?k=Apple",
      "imageUrl": "https://images-na.ssl-images-amazon.com/images/I/61886B78v4L._AC_US200_.jpg",
      "title": "Apple Watch Series 10 [GPS + Cellular 46mm] with Natural Titanium Case with Stone Grey Sport Band - S/M. Fitness Tracker, ECG App, Always-On Retina Display, Water Resistant with AppleCare+ (2 Years)",
      "parent": "B0FH2CCLPX",
      "nodeLabelPath": null,
      "nodeIdPath": null,
      "nodeId": null,
      "bsrId": null,
      "bsr": 4,
      "bsrCv": -3,
      "bsrCr": -300,
      "amzUnit": null,
      "amzUnitDate": null,
      "amzSales": null,
      "units": 167539,
      "unitsGr": null,
      "revenue": 123276872,
      "price": 728.99,
      "averagePrice": 735.81,
      "primePrice": -1,
      "profit": 98.52,
      "fba": 10.75,
      "ratings": 8707,
      "ratingsRate": 0.66,
      "rating": 4.7,
      "ratingsCv": 1103,
      "ratingDelta": 0,
      "availableDate": 1726012800000,
      "fulfillment": "AMZ",
      "variations": 84,
      "sellers": 1,
      "sellerName": "Amazon",
      "sellerId": null,
      "sellerNation": "US",
      "lqs": null,
      "weight": "4.8 ounces",
      "dimension": "24 x 7.7 x 3 inches",
      "pkgDimensions": null,
      "pkgDimensionType": null,
      "pkgWeight": null,
      "sku": "Color: Natural Titanium Case with Stone Grey Sport Band | Size: 46mm case + Small/Medium band | Style: GPS + Cellular | Configuration: With AppleCare+ (2 Years)",
      "dimensionsType": "LB",
      "deliveryPrice": -1,
      "badge": {
        "bestSeller": "#1 Best Seller in Smartwatches",
        "amazonChoice": "N",
        "newRelease": "N",
        "ebc": "Y",
        "video": "Y"
      },
      "subcategories": [
        {
          "code": "14130292011",
          "rank": 1,
          "label": "Smartwatches"
        }
      ]
    }
  ]
}

See Errors and rate limits for error payloads, request tracing, and rate-limit headers.

Availability: Available

This endpoint is active in the v1 gateway, OpenAPI, and subscription catalog. A successful call consumes 1 billing unit.

POST /v1/amazon/products/competitors

The request and response fields below match the current public contract.

Quick call

First create an API key, then store it in a server-side environment variable:

export ECOMMERCE_DATA_API_KEY="your_api_key"

curl --request POST \
  --url https://ecommercedataapi.com/v1/amazon/products/competitors \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "marketplace": "US",
  "asin": "B07Z82895W",
  "size": 20
}'

Integrate with an AI CLI

Copy for your AI CLI

Paste this task into Codex, Claude Code, Gemini CLI, or another coding agent.

Integrate the "Product Competitors" endpoint from Ecommerce Data API into the current repository. Make the changes directly instead of only returning sample code.

Example request:
{
"marketplace": "US",
"asin": "B07Z82895W",
"size": 20
}

Need an API key?Create API key

Open this request in Postman

Download the preconfigured collection for this endpoint, then import it into Postman.

Download Postman config

Set the apiKey collection variable after import.Create API key

Node.js example

const response = await fetch(
  'https://ecommercedataapi.com/v1/amazon/products/competitors',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      marketplace: 'US',
      asin: 'B07Z82895W',
      size: 20,
    }),
  }
);

const result = await response.json();

if (!response.ok) {
  throw new Error(`${result.error?.code}: ${result.error?.message}`);
}

console.log(result.data);

Python example

import os
import requests

response = requests.post(
    "https://ecommercedataapi.com/v1/amazon/products/competitors",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "marketplace": "US",
        "asin": "B07Z82895W",
        "size": 20,
    },
    timeout=30,
)

response.raise_for_status()
print(response.json()["data"])

Request body

Send the fields below directly in the JSON body without an extra wrapper. Undefined fields are rejected.

Field	Type	Required	Description	Example
`marketplace`	String	No	Amazon marketplace code. Supported values are listed in the schema.	US
`asin`	String	Yes	Amazon Standard Identification Number.	B08GHW4TBS
`size`	Integer	No	Number of results per page.	20

Response structure

Field	Type	Description
`request_id`	String	Unique identifier for this request.
`data`	Array	Endpoint business data.

The fields below are inside data. For array endpoints they describe one array item; for paginated endpoints they describe one record in items[].

Response fields

Field	Type	Description	Example
`asin`	String	ASIN.	B078J8VPVW
`brand`	String	Brand.	Pampers
`brandUrl`	String	Brand URL.	https://www.amazon.com/s?k=HP
`imageUrl`	String	Image URL.	https://images-na.ssl-images-amazon.com/images/I/51axlzme6aL .AC_US200.jpg
`title`	String	Title.	Diapers Size ……
`parent`	String	Parent.	B081RGNL17
`nodeId`	Integer	Node ID.	3741281
`nodeIdPath`	String	Node ID path.	2619525011:3741271:3741281
`nodeLabelPath`	String	Node label path.	Baby Products:Diapering:Disposable Diapers
`symbol`	String	Symbol.	Y
`bsrId`	String	BSR ID.	office-products
`bsr`	Integer	BSR.	1
`bsrCr`	Number	BSR change rate. Percentage or ratio value as documented.	926.67
`bsrCv`	Integer	BSR change value.	10
`units`	Integer	Units.	26289
`unitsGr`	Number	Units gr. Percentage or ratio value as documented.	-46.3
`amzUnit`	Integer	Amazon unit.	4000
`amzSales`	Number	Amazon sales.	235000
`amzUnitDate`	Integer	Amazon unit date. Date or timestamp value.	1.70248E+12
`revenue`	Number	Revenue.	1693537.4
`price`	Number	Price.	64.42
`primePrice`	Number	Prime price.	42
`profit`	Number	Profit. Percentage or ratio value as documented.	63.92
`fba`	Number	FBA.	13.58
`ratings`	Integer	Ratings.	32004
`ratingsRate`	Number	Ratings rate. Percentage or ratio value as documented.	40.57
`rating`	Number	Rating.	4.8
`ratingsCv`	Integer	Ratings change value.	10666
`ratingDelta`	Integer	Rating delta.	0
`lqs`	Number	Listing quality score.	-
`availableDate`	Integer	Available date. Date or timestamp value.	1.45408E+12
`fulfillment`	String	Fulfillment.	AMZ or FBA or FBM
`variations`	Integer	Variations.	7
`sellers`	Integer	Sellers.	7
`sellerId`	String	Seller ID.	A1Y8BVAASXO4R7
`sellerName`	String	Seller name.	Amazon
`sellerNation`	String	Seller nation.	见表 1.5
`badge`	Object	Badge.	包括了下面 5 个标识
`badge.bestSeller`	String	Best seller.	Y / N
`badge.amazonChoice`	String	Amazon choice.	Y / N
`badge.newRelease`	String	New release.	Y / N
`badge.ebc`	String	A+ content.	Y / N
`badge.video`	String	Video.	Y / N
`weight`	String	Weight.	8.88 pounds
`dimension`	String	Dimension.	13.3 x 15.8 x 10.6 inches
`dimensionsType`	String	Dimensions type.	ST,0V
`pkgDimensions`	String	Pkg dimensions.	14.3 x 16.8 x 12.6 inches
`pkgDimensionType`	String	Pkg dimension type.	-
`pkgWeight`	String	Pkg weight.	18.88 pounds
`sku`	String	Sku.	["Color: Beige","Size: 47 inches"]
`subcategories`	Array	Subcategories.	-
`subcategories.code`	String	Code.	1063242
`subcategories.rank`	Integer	Rank.	1
`subcategories.label`	String	Label.	Bath Rugs
`deliveryPrice`	Number	Delivery price.	4

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": [
    {
      "asin": "B0DGVP84B5",
      "brand": "Apple",
      "brandUrl": "https://www.amazon.com/s?k=Apple",
      "imageUrl": "https://images-na.ssl-images-amazon.com/images/I/61886B78v4L._AC_US200_.jpg",
      "title": "Apple Watch Series 10 [GPS + Cellular 46mm] with Natural Titanium Case with Stone Grey Sport Band - S/M. Fitness Tracker, ECG App, Always-On Retina Display, Water Resistant with AppleCare+ (2 Years)",
      "parent": "B0FH2CCLPX",
      "nodeLabelPath": null,
      "nodeIdPath": null,
      "nodeId": null,
      "bsrId": null,
      "bsr": 4,
      "bsrCv": -3,
      "bsrCr": -300,
      "amzUnit": null,
      "amzUnitDate": null,
      "amzSales": null,
      "units": 167539,
      "unitsGr": null,
      "revenue": 123276872,
      "price": 728.99,
      "averagePrice": 735.81,
      "primePrice": -1,
      "profit": 98.52,
      "fba": 10.75,
      "ratings": 8707,
      "ratingsRate": 0.66,
      "rating": 4.7,
      "ratingsCv": 1103,
      "ratingDelta": 0,
      "availableDate": 1726012800000,
      "fulfillment": "AMZ",
      "variations": 84,
      "sellers": 1,
      "sellerName": "Amazon",
      "sellerId": null,
      "sellerNation": "US",
      "lqs": null,
      "weight": "4.8 ounces",
      "dimension": "24 x 7.7 x 3 inches",
      "pkgDimensions": null,
      "pkgDimensionType": null,
      "pkgWeight": null,
      "sku": "Color: Natural Titanium Case with Stone Grey Sport Band | Size: 46mm case + Small/Medium band | Style: GPS + Cellular | Configuration: With AppleCare+ (2 Years)",
      "dimensionsType": "LB",
      "deliveryPrice": -1,
      "badge": {
        "bestSeller": "#1 Best Seller in Smartwatches",
        "amazonChoice": "N",
        "newRelease": "N",
        "ebc": "Y",
        "video": "Y"
      },
      "subcategories": [
        {
          "code": "14130292011",
          "rank": 1,
          "label": "Smartwatches"
        }
      ]
    }
  ]
}

See Errors and rate limits for error payloads, request tracing, and rate-limit headers.

Product Competitors

API data samples

Quick call

Integrate with an AI CLI

Copy for your AI CLI

Open this request in Postman

Node.js example

Python example

Request body

Response structure

Response fields

Response example

On this page

Product Competitors

API data samples

Quick call

Integrate with an AI CLI

Copy for your AI CLI

Open this request in Postman

Node.js example

Python example

Request body

Response structure

Response fields

Response example

On this page