ConsumerPricesService

GetConsumerPriceOverview

GetConsumerPriceOverview retrieves headline basket indices and coverage metrics.

get/api/consumer-prices/v1/get-consumer-price-overview

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-overview
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key

Query parameters

market_codestring

market_code is the ISO 3166-1 alpha-2 market identifier (e.g. "ae").

basket_slugstring

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

jmespathstring

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

OK

marketCodestring

market_code echoes the requested market.

asOfstring int64

as_of is the Unix millisecond timestamp of the snapshot.

currencyCodestring

currency_code is the ISO 4217 currency for price values.

essentialsIndexnumber double

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

valueBasketIndexnumber double

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

wowPctnumber double

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

momPctnumber double

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

retailerSpreadPctnumber double

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

coveragePctnumber double

coverage_pct is the fraction of basket items with current observations.

freshnessLagMininteger

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

upstreamUnavailableboolean

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

Changes

No recorded changes to this operation across all 1 revision of this API.