ListRetailerPriceSpreads
ListRetailerPriceSpreads retrieves cheapest-basket comparisons across retailers.
Authorizations
User-issued WorldMonitor API key.
Query Parameters
market_code is the ISO 3166-1 alpha-2 market identifier.
basket_slug selects which basket to compare across retailers.
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.
market_code echoes the requested market.
as_of is the Unix millisecond timestamp of the snapshot.
basket_slug echoes the requested basket.
currency_code is the ISO 4217 currency code.
spread_pct is the percentage difference between cheapest and most expensive retailer.
upstream_unavailable is true when the companion service could not be reached.
