Skip to main content
GET
/
api
/
consumer-prices
/
v1
/
get-consumer-price-overview
GetConsumerPriceOverview
curl --request GET \
  --url https://api.example.com/api/consumer-prices/v1/get-consumer-price-overview
{
  "marketCode": "<string>",
  "asOf": "<string>",
  "currencyCode": "<string>",
  "essentialsIndex": 123,
  "valueBasketIndex": 123,
  "wowPct": 123,
  "momPct": 123,
  "retailerSpreadPct": 123,
  "coveragePct": 123,
  "freshnessLagMin": 123,
  "topCategories": [
    {
      "slug": "<string>",
      "name": "<string>",
      "wowPct": 123,
      "momPct": 123,
      "currentIndex": 123,
      "sparkline": [
        123
      ],
      "coveragePct": 123,
      "itemCount": 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 (e.g. "ae").

​
basket_slug
string

basket_slug selects which basket to use (e.g. "essentials-ae").

Response

Successful response

GetConsumerPriceOverviewResponse contains headline basket and coverage metrics.

​
marketCode
string

market_code echoes the requested market.

​
asOf
string<int64>

as_of is the Unix millisecond timestamp of the snapshot.

​
currencyCode
string

currency_code is the ISO 4217 currency for price values.

​
essentialsIndex
number<double>

essentials_index is the fixed basket index value (base = 100).

​
valueBasketIndex
number<double>

value_basket_index is the value basket index value (base = 100).

​
wowPct
number<double>

wow_pct is the week-over-week percentage change in the essentials index.

​
momPct
number<double>

mom_pct is the month-over-month percentage change in the essentials index.

​
retailerSpreadPct
number<double>

retailer_spread_pct is the basket cost spread between cheapest and most expensive retailer.

​
coveragePct
number<double>

coverage_pct is the fraction of basket items with current observations.

​
freshnessLagMin
integer<int32>

freshness_lag_min is the average minutes since last observation across all retailers.

​
topCategories
object[]
​
upstreamUnavailable
boolean

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