Skip to main content
GET
ListRetailerPriceSpreads

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

market_code
string

market_code is the ISO 3166-1 alpha-2 market identifier.

basket_slug
string

basket_slug selects which basket to compare across retailers.

jmespath
string

Optional JMESPath expression applied server-side to project or reduce the JSON response before it is returned (mirrors the MCP jmespath argument). Invalid expressions, expressions larger than 1024 UTF-8 bytes, or projections that exceed the 256 KB output cap return HTTP 400 with a {_jmespath_error, original_keys} envelope. Grammar and worked examples: https://www.worldmonitor.app/docs/mcp-jmespath.

Response

Successful response

ListRetailerPriceSpreadsResponse holds cheapest-basket rankings.

marketCode
string

market_code echoes the requested market.

asOf
string<int64>

as_of is the Unix millisecond timestamp of the snapshot.

basketSlug
string

basket_slug echoes the requested basket.

currencyCode
string

currency_code is the ISO 4217 currency code.

retailers
object[]
spreadPct
number<double>

spread_pct is the percentage difference between cheapest and most expensive retailer.

upstreamUnavailable
boolean

upstream_unavailable is true when the companion service could not be reached.