Skip to main content
GET
Get price history for a product over time

Query Parameters

q
string

Search query (product name, keyword, or brand + model). Required unless product_uid or entity_uid is supplied.

Minimum string length: 1
product_uid
string

Stable product identifier returned by a prior Syntalic shopper response. When supplied, the endpoint should pin to this listing instead of re-resolving free text.

Minimum string length: 1
entity_uid
string

Stable cross-retailer entity identifier returned by a prior Syntalic shopper response. When supplied, the endpoint should resolve within the same physical-product entity.

Minimum string length: 1
country
enum<string>
default:us

Country (us or ca)

Available options:
us,
ca
retailer
enum<string>

Filter to a specific retailer platform (long-tail specialty stores are also present; any platform key is accepted)

Available options:
amazon,
walmart,
target,
bestbuy,
homedepot,
costco,
ikea,
samsclub,
cvs,
dillards
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

Price history

query
string
country
string
currency
string
product_uid
string
entity_uid
string
product_name
string
retailer
string
condition
string
current_price
number
period_low
number
period_high
number
period_avg
number
is_good_deal
boolean | null
trend
string | null
insufficient_history
boolean
observation_count
integer
scope
enum<string> | null
Available options:
entity,
listing
member_count
integer | null
window
object
observations
object[]
meta
object