Keyword Miner API Documentation | Ecommerce Data API

Use the Keyword Miner API for Amazon keyword 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/keywords/miner

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/keywords/miner \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "historyDate": "202507",
  "keyword": "child",
  "marketplace": "US",
  "page": 1,
  "size": 1
}'

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 "Keyword Miner" 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/keywords/miner
Endpoint: POST https://ecommercedataapi.com/v1/amazon/keywords/miner
API key environment variable: ECOMMERCE_DATA_API_KEY

Example request:
{
"historyDate": "202507",
"keyword": "child",
"marketplace": "US",
"page": 1,
"size": 1
}

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/keywords/miner',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      historyDate: '202507',
      keyword: 'child',
      marketplace: 'US',
      page: 1,
      size: 1,
    }),
  }
);

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/keywords/miner",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "historyDate": "202507",
        "keyword": "child",
        "marketplace": "US",
        "page": 1,
        "size": 1,
    },
    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
`amazonChoice`	Boolean	No	Amazon choice.	true
`excludeKeywords`	Array	No	Exclude keywords.	["phone stand"]
`filterRootWord`	Integer	No	Filter root word.	0
`historyDate`	String	No	History date. Date or timestamp value.	202201
`includeKeywords`	Array	No	Include keywords.	["phone stand"]
`keyword`	String	No	Keyword used by the query.	wireless charger
`keywordList`	Array	No	List of keywords used by the query.	["phone stand"]
`marketplace`	String	Yes	Amazon marketplace code. Supported values are listed in the schema.	US
`maxAdProducts`	Integer	No	Max ad products. Maximum value.	345
`maxBid`	Number	No	Max bid. Maximum value.	23.1
`maxMonopolyClickRate`	Number	No	Max monopoly click rate. Maximum value.	53.1
`maxPrice`	Number	No	Max price. Maximum value.	234.2
`maxProducts`	Integer	No	Max products. Maximum value.	324
`maxPurchases`	Integer	No	Max purchases. Maximum value.	34
`maxPurchasesRate`	Number	No	Max purchases rate. Maximum value. Percentage or ratio value as documented.	43
`maxRating`	Number	No	Max rating. Maximum value.	4.9
`maxRatings`	Integer	No	Max ratings. Maximum value.	399
`maxRelevancy`	Number	No	Max relevancy. Maximum value.	1
`maxSPR`	Integer	No	Max SPR. Maximum value.	16
`maxSearch`	Integer	No	Max search. Maximum value.	23453
`maxSearchRank`	Integer	No	Max search rank. Maximum value.	3223
`maxSupplyDemandRatio`	Number	No	Max supply demand ratio. Maximum value.	45.2
`maxTitleDensity`	Integer	No	Max title density. Maximum value.	23
`maxWordCount`	Integer	No	Max word count. Maximum value.	4
`minAdProducts`	Integer	No	Min ad products. Minimum value.	123
`minBid`	Number	No	Min bid. Minimum value.	10.2
`minMonopolyClickRate`	Number	No	Min monopoly click rate. Minimum value.	23.4
`minPrice`	Number	No	Min price. Minimum value.	43.3
`minProducts`	Integer	No	Min products. Minimum value.	54
`minPurchases`	Integer	No	Min purchases. Minimum value.	6
`minPurchasesRate`	Number	No	Min purchases rate. Minimum value. Percentage or ratio value as documented.	3
`minRating`	Number	No	Min rating. Minimum value.	3
`minRatings`	Integer	No	Min ratings. Minimum value.	100
`minRelevancy`	Number	No	Min relevancy. Minimum value.	1
`minSPR`	Integer	No	Min SPR. Minimum value.	2
`minSearch`	Integer	No	Min search. Minimum value.	543
`minSearchRank`	Integer	No	Min search rank. Minimum value.	33
`minSupplyDemandRatio`	Number	No	Min supply demand ratio. Minimum value.	11.2
`minTitleDensity`	Integer	No	Min title density. Minimum value.	2
`minWordCount`	Integer	No	Min word count. Minimum value.	2
`order`	Object	No	Sort definition.	{}
`order.desc`	Boolean	No	Use true for descending order or false for ascending order.	true
`order.field`	String	No	Field used to sort the results.	searches
`page`	Integer	No	Page number starting at 1.	1
`returnFields`	String	No	Optional comma-separated response fields. Omit it to receive the standard payload.	marketplace,keyword,keywordCn
`size`	Integer	No	Number of results per page.	50

Response structure

Field	Type	Description
`request_id`	String	Unique identifier for this request.
`data`	Object	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
`marketplace`	String	Marketplace.	US
`keyword`	String	Keyword.	phone stand for recording
`keywordCn`	String	Keyword cn.	用于录音的电话支架
`keywordJp`	String	Keyword jp.	録音用電話スタンド
`departments`	Array	Departments.	-
`departments.code`	String	Code.	electronics
`departments.label`	String	Label.	Electronics
`month`	String	Month.	2022.01
`supplement`	String	Supplement.	N
`searches`	Integer	Searches.	21582
`purchases`	Integer	Purchases.	1996
`purchaseRate`	Number	Purchase rate. Percentage or ratio value as documented.	0.0925
`monopolyClickRate`	Number	Monopoly click rate. Percentage or ratio value as documented.	0.3
`products`	Integer	Products.	1645
`adProducts`	Integer	Ad products.	34
`supplyDemandRatio`	Number	Supply demand ratio.	13.12
`avgPrice`	Number	Avg price.	36.14
`avgRatings`	Integer	Avg ratings.	12223
`avgRating`	Number	Avg rating.	4.5
`bidMin`	Number	Bid min. Minimum value.	1.34
`bidMax`	Number	Bid max. Maximum value.	3.21
`bid`	Number	Bid.	1.6
`cvsShareRate`	Number	Cvs share rate. Percentage or ratio value as documented.	0.3084
`wordCount`	Integer	Word count.	4
`titleDensity`	Integer	Title density.	42.9
`spr`	Integer	SPR.	6
`relevancy`	Number	Relevancy.	28.6
`amazonChoice`	Boolean	Amazon choice.	false
`searchRank`	Integer	Search rank.	17910
`searchRank.code`	String	Code.	electronics
`searchRank.label`	String	Label.	Electronics
`clicks`	Integer	Clicks.	10
`impressions`	Integer	Impressions.	20

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": {
    "guestId": null,
    "pages": 3070,
    "page": 1,
    "size": 1,
    "total": 3070,
    "took": 0,
    "url": null,
    "order": {
      "field": "",
      "desc": true
    },
    "items": [
      {
        "marketplace": "US",
        "keyword": "child",
        "keywordCn": "孩子",
        "keywordJp": "子供",
        "departments": [
          {
            "code": "hpc",
            "label": "Health, Household & Baby Care"
          }
        ],
        "month": "2025.07",
        "supplement": "N",
        "searches": 17702,
        "purchases": 2436,
        "purchaseRate": 0.1376,
        "monopolyClickRate": 0.6205,
        "products": 364623,
        "adProducts": 36,
        "supplyDemandRatio": 0.05,
        "avgPrice": 17.97,
        "avgRatings": null,
        "avgRating": 4.8,
        "bidMin": 0.91,
        "bidMax": 1.4,
        "bid": 1.26,
        "cvsShareRate": 0,
        "wordCount": 1,
        "titleDensity": 3,
        "spr": 56,
        "relevancy": 100,
        "amazonChoice": false,
        "searchRank": 94289,
        "trends": null
      }
    ],
    "terminal": null,
    "hasNextPage": null,
    "guestVisited": false
  }
}

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/keywords/miner

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/keywords/miner \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "historyDate": "202507",
  "keyword": "child",
  "marketplace": "US",
  "page": 1,
  "size": 1
}'

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 "Keyword Miner" 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/keywords/miner
Endpoint: POST https://ecommercedataapi.com/v1/amazon/keywords/miner
API key environment variable: ECOMMERCE_DATA_API_KEY

Example request:
{
"historyDate": "202507",
"keyword": "child",
"marketplace": "US",
"page": 1,
"size": 1
}

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/keywords/miner',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      historyDate: '202507',
      keyword: 'child',
      marketplace: 'US',
      page: 1,
      size: 1,
    }),
  }
);

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/keywords/miner",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "historyDate": "202507",
        "keyword": "child",
        "marketplace": "US",
        "page": 1,
        "size": 1,
    },
    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
`amazonChoice`	Boolean	No	Amazon choice.	true
`excludeKeywords`	Array	No	Exclude keywords.	["phone stand"]
`filterRootWord`	Integer	No	Filter root word.	0
`historyDate`	String	No	History date. Date or timestamp value.	202201
`includeKeywords`	Array	No	Include keywords.	["phone stand"]
`keyword`	String	No	Keyword used by the query.	wireless charger
`keywordList`	Array	No	List of keywords used by the query.	["phone stand"]
`marketplace`	String	Yes	Amazon marketplace code. Supported values are listed in the schema.	US
`maxAdProducts`	Integer	No	Max ad products. Maximum value.	345
`maxBid`	Number	No	Max bid. Maximum value.	23.1
`maxMonopolyClickRate`	Number	No	Max monopoly click rate. Maximum value.	53.1
`maxPrice`	Number	No	Max price. Maximum value.	234.2
`maxProducts`	Integer	No	Max products. Maximum value.	324
`maxPurchases`	Integer	No	Max purchases. Maximum value.	34
`maxPurchasesRate`	Number	No	Max purchases rate. Maximum value. Percentage or ratio value as documented.	43
`maxRating`	Number	No	Max rating. Maximum value.	4.9
`maxRatings`	Integer	No	Max ratings. Maximum value.	399
`maxRelevancy`	Number	No	Max relevancy. Maximum value.	1
`maxSPR`	Integer	No	Max SPR. Maximum value.	16
`maxSearch`	Integer	No	Max search. Maximum value.	23453
`maxSearchRank`	Integer	No	Max search rank. Maximum value.	3223
`maxSupplyDemandRatio`	Number	No	Max supply demand ratio. Maximum value.	45.2
`maxTitleDensity`	Integer	No	Max title density. Maximum value.	23
`maxWordCount`	Integer	No	Max word count. Maximum value.	4
`minAdProducts`	Integer	No	Min ad products. Minimum value.	123
`minBid`	Number	No	Min bid. Minimum value.	10.2
`minMonopolyClickRate`	Number	No	Min monopoly click rate. Minimum value.	23.4
`minPrice`	Number	No	Min price. Minimum value.	43.3
`minProducts`	Integer	No	Min products. Minimum value.	54
`minPurchases`	Integer	No	Min purchases. Minimum value.	6
`minPurchasesRate`	Number	No	Min purchases rate. Minimum value. Percentage or ratio value as documented.	3
`minRating`	Number	No	Min rating. Minimum value.	3
`minRatings`	Integer	No	Min ratings. Minimum value.	100
`minRelevancy`	Number	No	Min relevancy. Minimum value.	1
`minSPR`	Integer	No	Min SPR. Minimum value.	2
`minSearch`	Integer	No	Min search. Minimum value.	543
`minSearchRank`	Integer	No	Min search rank. Minimum value.	33
`minSupplyDemandRatio`	Number	No	Min supply demand ratio. Minimum value.	11.2
`minTitleDensity`	Integer	No	Min title density. Minimum value.	2
`minWordCount`	Integer	No	Min word count. Minimum value.	2
`order`	Object	No	Sort definition.	{}
`order.desc`	Boolean	No	Use true for descending order or false for ascending order.	true
`order.field`	String	No	Field used to sort the results.	searches
`page`	Integer	No	Page number starting at 1.	1
`returnFields`	String	No	Optional comma-separated response fields. Omit it to receive the standard payload.	marketplace,keyword,keywordCn
`size`	Integer	No	Number of results per page.	50

Response structure

Field	Type	Description
`request_id`	String	Unique identifier for this request.
`data`	Object	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
`marketplace`	String	Marketplace.	US
`keyword`	String	Keyword.	phone stand for recording
`keywordCn`	String	Keyword cn.	用于录音的电话支架
`keywordJp`	String	Keyword jp.	録音用電話スタンド
`departments`	Array	Departments.	-
`departments.code`	String	Code.	electronics
`departments.label`	String	Label.	Electronics
`month`	String	Month.	2022.01
`supplement`	String	Supplement.	N
`searches`	Integer	Searches.	21582
`purchases`	Integer	Purchases.	1996
`purchaseRate`	Number	Purchase rate. Percentage or ratio value as documented.	0.0925
`monopolyClickRate`	Number	Monopoly click rate. Percentage or ratio value as documented.	0.3
`products`	Integer	Products.	1645
`adProducts`	Integer	Ad products.	34
`supplyDemandRatio`	Number	Supply demand ratio.	13.12
`avgPrice`	Number	Avg price.	36.14
`avgRatings`	Integer	Avg ratings.	12223
`avgRating`	Number	Avg rating.	4.5
`bidMin`	Number	Bid min. Minimum value.	1.34
`bidMax`	Number	Bid max. Maximum value.	3.21
`bid`	Number	Bid.	1.6
`cvsShareRate`	Number	Cvs share rate. Percentage or ratio value as documented.	0.3084
`wordCount`	Integer	Word count.	4
`titleDensity`	Integer	Title density.	42.9
`spr`	Integer	SPR.	6
`relevancy`	Number	Relevancy.	28.6
`amazonChoice`	Boolean	Amazon choice.	false
`searchRank`	Integer	Search rank.	17910
`searchRank.code`	String	Code.	electronics
`searchRank.label`	String	Label.	Electronics
`clicks`	Integer	Clicks.	10
`impressions`	Integer	Impressions.	20

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": {
    "guestId": null,
    "pages": 3070,
    "page": 1,
    "size": 1,
    "total": 3070,
    "took": 0,
    "url": null,
    "order": {
      "field": "",
      "desc": true
    },
    "items": [
      {
        "marketplace": "US",
        "keyword": "child",
        "keywordCn": "孩子",
        "keywordJp": "子供",
        "departments": [
          {
            "code": "hpc",
            "label": "Health, Household & Baby Care"
          }
        ],
        "month": "2025.07",
        "supplement": "N",
        "searches": 17702,
        "purchases": 2436,
        "purchaseRate": 0.1376,
        "monopolyClickRate": 0.6205,
        "products": 364623,
        "adProducts": 36,
        "supplyDemandRatio": 0.05,
        "avgPrice": 17.97,
        "avgRatings": null,
        "avgRating": 4.8,
        "bidMin": 0.91,
        "bidMax": 1.4,
        "bid": 1.26,
        "cvsShareRate": 0,
        "wordCount": 1,
        "titleDensity": 3,
        "spr": 56,
        "relevancy": 100,
        "amazonChoice": false,
        "searchRank": 94289,
        "trends": null
      }
    ],
    "terminal": null,
    "hasNextPage": null,
    "guestVisited": false
  }
}

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

Keyword Miner

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

Keyword Miner

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