Getting Started

Sections

Theme switcher

Keyword Top Products

Header Parameters

api-keystring

Query Parameters

domainstring Required

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

granularitystring

Time granularity for the returned values

Enum values:
monthlyweekly
start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity, automatically adjusted to the first Sunday of the specified month.

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

metricsarray

Comma-separated list of metrics: amazon_brand, amazon_exclusive, amazons_choice_keyword, asin, average_unit_price, best_seller_category_id, best_seller_category_name, best_seller_rank, brand, category_id, category_name, climate_pledge_friendly, clicks, name, organic_clicks, organic_rank, page_one_rate, paid_clicks, parent_asin, price, price_last_scraped_date, price_value, prime, rating, related_keywords, relevancy, revenue, revenue_in_usd, reviews, small_business, thumbnail, units_sold...

Enum values:
amazon_brandamazon_exclusiveamazons_choice_keywordasinaverage_unit_pricebest_seller_category_idbest_seller_category_namebest_seller_rankbrandcategory_id
... 23 other enums
mtdboolean

When true with weekly granularity, end_date is set to the latest available Saturday. NOT supported for monthly granularity.

keywordstring Required

Search keyword or keyword ID. Can be a plain text keyword (e.g., 'laptop') or a keyword ID if known. Keywords are case-insensitive for matching. Use keyword search or top keywords endpoints to discover available keywords

formatstring

Format in which the reply should be returned

Enum values:
jsonxml
limitinteger

Sets how many results to return.

offsetinteger

Defines the number of results to skip

ascboolean | null

Orders the results by ascending or descending

sortstring

Selects a specific metric to order results by

Response

200
Object

OK

Response Attributes

metaobject

Show child attributes

dataarray | null

Show child attributes

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot