Skip to main content
GET
Find the best price for a product across retailers

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
limit
integer
default:10

Max results to return (default 10, min 1, max 50)

Required range: 1 <= x <= 50
strict
boolean
default:false

When true, restrict the comparison to entity-verified listings of the matched product (match_type 'entity' only). Default false also includes title-match rows — useful for broad queries, but may mix product variants.

Response

Best price result

query
string
country
string
currency
string
best_price
object
other_prices
object[]
meta
object