Skip to main content
GET
Price index for a specific retailer over time

Query Parameters

retailer
string
required

Retailer platform key (e.g., amazon, walmart)

country
enum<string>
default:us

Country (us or ca)

Available options:
us,
ca
category
string

Product category. Accepts a human-readable name (e.g. 'electronics', 'beauty') or a taxonomy slug path (e.g. 'electronics/headphones'); matched against the catalog's category tree (exact node, subtree, or path substring). Also accepts a GS1 GPC code (exactly 8 digits, e.g. '10001159') to filter by PRODUCT TYPE instead of by shelf placement — the same product type is shelved under different categories by different retailers, so a category filter answers from a fraction of the data while a GPC code spans them. Coarser codes (class/family/segment) match every brick beneath them. Resolve a phrase to a code with /v1/reference/classify?q=... ; when a code is used, resolved.match_source is 'gpc'. For analyst endpoints, supply either category or department; both may be supplied to narrow the scope.

Minimum string length: 1
department
string

Top-level department (root category), e.g. 'Electronics', 'Beauty', 'Home & Kitchen'. Case-insensitive; matched against the category tree's root segment. For analyst endpoints, supply either category or department; both may be supplied to narrow the scope.

Minimum string length: 1
time_window
enum<string>

Historical window preset. Explicit from/to takes precedence and is reported as custom; time_window=custom requires both from and to. Date-only ranges use UTC calendar boundaries with inclusive from and exclusive to.

Available options:
last_30_days,
last_60_days,
last_90_days,
month_to_date,
previous_month,
month_over_month,
quarter_to_date,
custom
from
string<date>

Start date (ISO 8601, defaults to 30 days ago)

to
string<date>

End date (ISO 8601, defaults to now)

Response

Retailer index data

retailer
string
category
string
department
string | null
country
string
currency
string
window
object
sample_threshold
integer
insufficient_sample_points
integer
insufficient_sample
boolean

True when any series point has a basket below sample_threshold.

stable_basket_size
integer | null

Products priced in every period of the series (the basis of stable_avg_price). Null for single-point series.

time_series
object[]
resolved
object
meta
object