Skip to main content
GET
GetConsumerPriceOverview

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 (e.g. "ae").

basket_slug
string

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

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

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.