Skip to main content
GET
/
api
/
consumer-prices
/
v1
/
list-retailer-price-spreads
ListRetailerPriceSpreads
curl --request GET \
  --url https://api.example.com/api/consumer-prices/v1/list-retailer-price-spreads
{
  "marketCode": "<string>",
  "asOf": "<string>",
  "basketSlug": "<string>",
  "currencyCode": "<string>",
  "retailers": [
    {
      "slug": "<string>",
      "name": "<string>",
      "basketTotal": 123,
      "deltaVsCheapest": 123,
      "deltaVsCheapestPct": 123,
      "itemCount": 123,
      "freshnessMin": 123,
      "currencyCode": "<string>"
    }
  ],
  "spreadPct": 123,
  "upstreamUnavailable": true
}

Documentation Index

Fetch the complete documentation index at: https://worldmonitor.app/docs/llms.txt

Use this file to discover all available pages before exploring further.

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.

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.