Skip to main content
POST
commerce.prices.compare

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
product
string
required

Product.

Required string length: 1 - 512
country
string

Country.

Required string length: 1 - 512

Response

The result

averagePrice
number
required

Average price.

totalOffers
number

Total offers: how many.

country
string

Country.

details
string

Details.

message
string

Message.

searchQuery
string

Search query.

source
string

Source.