ABA Weekly Research API Documentation

Use the ABA Weekly Research 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/aba/weekly

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/aba/weekly \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "date": "20250802",
  "includeKeywords": "screen protector",
  "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 "ABA Weekly Research" 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/aba-weekly
Endpoint: POST https://ecommercedataapi.com/v1/amazon/keywords/aba/weekly
API key environment variable: ECOMMERCE_DATA_API_KEY

Example request:
{
"date": "20250802",
"includeKeywords": "screen protector",
"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/aba/weekly',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      date: '20250802',
      includeKeywords: 'screen protector',
      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/aba/weekly",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "date": "20250802",
        "includeKeywords": "screen protector",
        "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
`date`	String	No	Data period or reporting date for the query.	20230610，限定为周六的日期）
`departments`	Array	No	Departments.	["automotive","baby-products"]
`excludeKeywords`	String	No	Exclude keywords.	portable
`includeKeywords`	String	No	Include keywords.	Include keywords
`marketplace`	String	Yes	Amazon marketplace code. Supported values are listed in the schema.	US
`maxClicks`	Integer	No	Max clicks. Maximum value.	10000
`maxConversionRate`	Number	No	Max conversion rate. Maximum value. Percentage or ratio value as documented.	1
`maxImpressions`	Integer	No	Max impressions. Maximum value.	20000
`maxMonopolyClickRate`	Number	No	Max monopoly click rate. Maximum value.	1
`maxRankGrowthRate`	Number	No	Max rank growth rate. Maximum value. Percentage or ratio value as documented.	1
`maxSPR`	Integer	No	Max SPR. Maximum value.	1
`maxSearchRank`	Integer	No	Max search rank. Maximum value.	1
`maxSearches`	Integer	No	Max searches. Maximum value.	1
`maxTitleDensity`	Integer	No	Max title density. Maximum value.	1
`maxWordCount`	Integer	No	Max word count. Maximum value.	1
`minClicks`	Integer	No	Min clicks. Minimum value.	1
`minConversionRate`	Number	No	Min conversion rate. Minimum value. Percentage or ratio value as documented.	1
`minImpressions`	Integer	No	Min impressions. Minimum value.	10000
`minMonopolyClickRate`	Number	No	Min monopoly click rate. Minimum value.	1
`minRankGrowthRate`	Number	No	Min rank growth rate. Minimum value. Percentage or ratio value as documented.	1
`minSPR`	Integer	No	Min SPR. Minimum value.	1
`minSearchRank`	Integer	No	Min search rank. Minimum value.	1
`minSearches`	Integer	No	Min searches. Minimum value.	1
`minTitleDensity`	Integer	No	Min title density. Minimum value.	1
`minWordCount`	Integer	No	Min word count. Minimum value.	1
`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
`rankGrowthRate`	Number	No	Rank growth rate. Percentage or ratio value as documented.	1
`rankGrowthValue`	Integer	No	Rank growth value.	1
`returnFields`	String	No	Optional comma-separated response fields. Omit it to receive the standard payload.	marketplace,date,keyword
`searchModel`	Integer	No	Search model.	1
`size`	Integer	No	Number of results per page.	40

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
`date`	String	Date. Date or timestamp value.	20230610，限定为周六的日期
`keyword`	String	Keyword.	portable charger
`keywordCn`	String	Keyword cn.	便携式充电器
`keywordJp`	String	Keyword jp.	-
`departments`	Array	Departments.	["Cell Phones & Accessories"]
`searchRank`	Integer	Search rank.	62
`searchRankCv`	Integer	Search rank change value.	19
`searchRankCr`	Number	Search rank change rate. Percentage or ratio value as documented.	0.2346
`searches`	Integer	Searches.	46147979
`purchases`	Integer	Purchases.	2492
`purchaseRate`	Number	Purchase rate. Percentage or ratio value as documented.	0.0054
`clicks`	Integer	Clicks.	1380
`impressions`	Integer	Impressions.	73560
`titleDensityExact`	Integer	Title density exact.	-
`cprExact`	Integer	Cpr exact.	-
`w1SearchRank`	Integer	W1 search rank.	-
`w1RankGrowthValue`	Integer	W1 rank growth value.	-
`w1RankGrowthRate`	Number	W1 rank growth rate. Percentage or ratio value as documented.	-
`w4SearchRank`	Integer	W4 search rank.	-
`w4RankGrowthValue`	Integer	W4 rank growth value.	-
`w4RankGrowthRate`	Number	W4 rank growth rate. Percentage or ratio value as documented.	-
`w12SearchRank`	Integer	W12 search rank.	-
`w12RankGrowthValue`	Integer	W12 rank growth value.	-
`w12RankGrowthRate`	Number	W12 rank growth rate. Percentage or ratio value as documented.	-
`top3Brands`	Array	Top3 brands.	-
`bid`	Number	Bid.	-
`bidMax`	Number	Bid max. Maximum value.	-
`bidMin`	Number	Bid min. Minimum value.	-
`top3AsinDtoList`	Array	Top3 ASIN dto list.	-
`top3AsinDtoList.asin`	String	ASIN.	-
`top3AsinDtoList.imageUrl`	String	Image URL.	-
`top3AsinDtoList.clickRate`	Number	Click rate.	-
`top3AsinDtoList.conversionRate`	Number	Conversion rate. Percentage or ratio value as documented.	-
`clickShareRate`	Number	Click share rate.	54.2
`cvsShareRate`	Number	Cvs share rate.	43.5

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": {
    "guestId": null,
    "pages": 0,
    "page": 1,
    "size": 1,
    "total": 4835,
    "took": 0,
    "url": null,
    "order": {
      "field": "",
      "desc": true
    },
    "items": [
      {
        "marketplace": "US",
        "date": "20250802",
        "keyword": "screen protector",
        "keywordCn": "屏幕保护器",
        "keywordJp": "スクリーンプロテクター",
        "departments": ["Cell Phones & Accessories"],
        "searchRank": 9038,
        "searchRankCv": -738,
        "searchRankCr": -0.0889,
        "searches": 22012,
        "purchaseRate": 0.04699999839067459,
        "purchases": 1035,
        "clicks": 3403,
        "impressions": 451341,
        "searchRankGrowthValue": -738,
        "searchRankGrowthRate": -0.0889,
        "cvsShareRate": 0.0842,
        "clickShareRate": 0.1489,
        "titleDensityExact": 50,
        "cprExact": 64,
        "w1SearchRank": 8300,
        "w1RankGrowthValue": -738,
        "w1RankGrowthRate": -0.0889,
        "w4SearchRank": 7989,
        "w4RankGrowthValue": -1049,
        "w4RankGrowthRate": -0.1313,
        "w12SearchRank": 8738,
        "w12RankGrowthValue": -300,
        "w12RankGrowthRate": -0.0343,
        "top3Brands": ["Ailun"],
        "bid": 3.36,
        "bidMax": 4.2,
        "bidMin": 2.52,
        "top3AsinDtoList": [
          {
            "asin": "B09CSSP9C1",
            "imageUrl": "https://m.media-amazon.com/images/I/41YKFO7q5TL._AC_SR200,200_.jpg",
            "clickRate": 0.0679,
            "conversionRate": 0.0335
          }
        ]
      }
    ],
    "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/aba/weekly

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/aba/weekly \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "date": "20250802",
  "includeKeywords": "screen protector",
  "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 "ABA Weekly Research" endpoint from Ecommerce Data API into the current repository. Make the changes directly instead of only returning sample code.

Example request:
{
"date": "20250802",
"includeKeywords": "screen protector",
"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/aba/weekly',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      date: '20250802',
      includeKeywords: 'screen protector',
      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/aba/weekly",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "date": "20250802",
        "includeKeywords": "screen protector",
        "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
`date`	String	No	Data period or reporting date for the query.	20230610，限定为周六的日期）
`departments`	Array	No	Departments.	["automotive","baby-products"]
`excludeKeywords`	String	No	Exclude keywords.	portable
`includeKeywords`	String	No	Include keywords.	Include keywords
`marketplace`	String	Yes	Amazon marketplace code. Supported values are listed in the schema.	US
`maxClicks`	Integer	No	Max clicks. Maximum value.	10000
`maxConversionRate`	Number	No	Max conversion rate. Maximum value. Percentage or ratio value as documented.	1
`maxImpressions`	Integer	No	Max impressions. Maximum value.	20000
`maxMonopolyClickRate`	Number	No	Max monopoly click rate. Maximum value.	1
`maxRankGrowthRate`	Number	No	Max rank growth rate. Maximum value. Percentage or ratio value as documented.	1
`maxSPR`	Integer	No	Max SPR. Maximum value.	1
`maxSearchRank`	Integer	No	Max search rank. Maximum value.	1
`maxSearches`	Integer	No	Max searches. Maximum value.	1
`maxTitleDensity`	Integer	No	Max title density. Maximum value.	1
`maxWordCount`	Integer	No	Max word count. Maximum value.	1
`minClicks`	Integer	No	Min clicks. Minimum value.	1
`minConversionRate`	Number	No	Min conversion rate. Minimum value. Percentage or ratio value as documented.	1
`minImpressions`	Integer	No	Min impressions. Minimum value.	10000
`minMonopolyClickRate`	Number	No	Min monopoly click rate. Minimum value.	1
`minRankGrowthRate`	Number	No	Min rank growth rate. Minimum value. Percentage or ratio value as documented.	1
`minSPR`	Integer	No	Min SPR. Minimum value.	1
`minSearchRank`	Integer	No	Min search rank. Minimum value.	1
`minSearches`	Integer	No	Min searches. Minimum value.	1
`minTitleDensity`	Integer	No	Min title density. Minimum value.	1
`minWordCount`	Integer	No	Min word count. Minimum value.	1
`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
`rankGrowthRate`	Number	No	Rank growth rate. Percentage or ratio value as documented.	1
`rankGrowthValue`	Integer	No	Rank growth value.	1
`returnFields`	String	No	Optional comma-separated response fields. Omit it to receive the standard payload.	marketplace,date,keyword
`searchModel`	Integer	No	Search model.	1
`size`	Integer	No	Number of results per page.	40

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
`date`	String	Date. Date or timestamp value.	20230610，限定为周六的日期
`keyword`	String	Keyword.	portable charger
`keywordCn`	String	Keyword cn.	便携式充电器
`keywordJp`	String	Keyword jp.	-
`departments`	Array	Departments.	["Cell Phones & Accessories"]
`searchRank`	Integer	Search rank.	62
`searchRankCv`	Integer	Search rank change value.	19
`searchRankCr`	Number	Search rank change rate. Percentage or ratio value as documented.	0.2346
`searches`	Integer	Searches.	46147979
`purchases`	Integer	Purchases.	2492
`purchaseRate`	Number	Purchase rate. Percentage or ratio value as documented.	0.0054
`clicks`	Integer	Clicks.	1380
`impressions`	Integer	Impressions.	73560
`titleDensityExact`	Integer	Title density exact.	-
`cprExact`	Integer	Cpr exact.	-
`w1SearchRank`	Integer	W1 search rank.	-
`w1RankGrowthValue`	Integer	W1 rank growth value.	-
`w1RankGrowthRate`	Number	W1 rank growth rate. Percentage or ratio value as documented.	-
`w4SearchRank`	Integer	W4 search rank.	-
`w4RankGrowthValue`	Integer	W4 rank growth value.	-
`w4RankGrowthRate`	Number	W4 rank growth rate. Percentage or ratio value as documented.	-
`w12SearchRank`	Integer	W12 search rank.	-
`w12RankGrowthValue`	Integer	W12 rank growth value.	-
`w12RankGrowthRate`	Number	W12 rank growth rate. Percentage or ratio value as documented.	-
`top3Brands`	Array	Top3 brands.	-
`bid`	Number	Bid.	-
`bidMax`	Number	Bid max. Maximum value.	-
`bidMin`	Number	Bid min. Minimum value.	-
`top3AsinDtoList`	Array	Top3 ASIN dto list.	-
`top3AsinDtoList.asin`	String	ASIN.	-
`top3AsinDtoList.imageUrl`	String	Image URL.	-
`top3AsinDtoList.clickRate`	Number	Click rate.	-
`top3AsinDtoList.conversionRate`	Number	Conversion rate. Percentage or ratio value as documented.	-
`clickShareRate`	Number	Click share rate.	54.2
`cvsShareRate`	Number	Cvs share rate.	43.5

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": {
    "guestId": null,
    "pages": 0,
    "page": 1,
    "size": 1,
    "total": 4835,
    "took": 0,
    "url": null,
    "order": {
      "field": "",
      "desc": true
    },
    "items": [
      {
        "marketplace": "US",
        "date": "20250802",
        "keyword": "screen protector",
        "keywordCn": "屏幕保护器",
        "keywordJp": "スクリーンプロテクター",
        "departments": ["Cell Phones & Accessories"],
        "searchRank": 9038,
        "searchRankCv": -738,
        "searchRankCr": -0.0889,
        "searches": 22012,
        "purchaseRate": 0.04699999839067459,
        "purchases": 1035,
        "clicks": 3403,
        "impressions": 451341,
        "searchRankGrowthValue": -738,
        "searchRankGrowthRate": -0.0889,
        "cvsShareRate": 0.0842,
        "clickShareRate": 0.1489,
        "titleDensityExact": 50,
        "cprExact": 64,
        "w1SearchRank": 8300,
        "w1RankGrowthValue": -738,
        "w1RankGrowthRate": -0.0889,
        "w4SearchRank": 7989,
        "w4RankGrowthValue": -1049,
        "w4RankGrowthRate": -0.1313,
        "w12SearchRank": 8738,
        "w12RankGrowthValue": -300,
        "w12RankGrowthRate": -0.0343,
        "top3Brands": ["Ailun"],
        "bid": 3.36,
        "bidMax": 4.2,
        "bidMin": 2.52,
        "top3AsinDtoList": [
          {
            "asin": "B09CSSP9C1",
            "imageUrl": "https://m.media-amazon.com/images/I/41YKFO7q5TL._AC_SR200,200_.jpg",
            "clickRate": 0.0679,
            "conversionRate": 0.0335
          }
        ]
      }
    ],
    "terminal": null,
    "hasNextPage": null,
    "guestVisited": false
  }
}

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

ABA Weekly Research

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

ABA Weekly Research

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