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

Query Parameters

retailer
string

Retailer platform key (e.g., amazon, walmart). A retailer that is not serving-eligible in the country is a free 404 before payment that lists the ones that are. So is one with no serving-eligible products on the taxonomy roots the category or department resolves to: its side of the index would be empty, and error.details.retailer_roots lists the roots it is served on.

country
enum<string>
default:us

Country (us or ca)

Available options:
us,
ca
category
string

Product category in the Shopify product taxonomy. Accepts a display path (e.g. 'Electronics > Computers > Laptops'), its slug form (e.g. 'electronics/computers/laptops'), a single path segment (e.g. 'laptops', 'headphones'), or an everyday shelf name (e.g. 'apparel', 'beauty', 'grocery'); matched against the catalog's category tree (exact node, subtree, or whole path segment). 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'. Some product types are filed under more than one department (e.g. Protein Bars under both Food and Health & Beauty); add include_homes=true to read every home of such a type as one shelf. For analyst endpoints, supply either category or department; both may be supplied to narrow the scope.

Minimum string length: 1
include_homes
boolean
default:false

Optional. true reads a product type filed under more than one department (e.g. Protein Bars under both Food and Health & Beauty) as one shelf, every home included. Absent or false: the shelf the category names, and nothing else.

department
string

A Shopify taxonomy root, e.g. 'Electronics' or 'Food, Beverages & Tobacco'. Case-insensitive; matched against that root and nothing under it. A name that is not a root, including a retired browse department such as 'Grocery' or 'Home & Kitchen', is refused before payment and the response names the roots to send. 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)

publish_id
string

Optional. Pin the answer to a serving publish: pass meta.publish_id from an earlier answer. When the served snapshot has moved on, or cannot be confirmed, the request is answered 409 PUBLISH_CHANGED naming the current publish, before any payment challenge and free. Use it to keep several answers on one snapshot.

Minimum string length: 1
spt
string

A shelf by id, from GET /v1/ontology/resolve (a category match's id). Send it instead of category=, not with it.

Pattern: ^spt:[a-z]{2}(-[0-9]+)*$
gpc
string

A product type by GS1 GPC id, from GET /v1/ontology/resolve (a product_type match's id). Covers EVERY shelf the type is filed under, so a type shelved in two departments is one scope (category=<8 digits> filters by browse-node placement). Send it instead of category= or spt=, not with them.

Pattern: ^gpc:[0-9]{8}$
retailer_id
string

A chain by id, from GET /v1/ontology/resolve (a retailer match's id): the chain (seller_norm) whatever lane its listings were scraped through, never a lane. retailer= matches the scrape lane, so a Shopify store's chain can only be asked for by id (#1090). Send it instead of retailer=, not with it.

Pattern: ^retailer:[a-z0-9]{1,64}$

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