---
title: "GetConsumerPriceOverview"
method: GET
path: "/api/consumer-prices/v1/get-consumer-price-overview"
tags: ["ConsumerPricesService"]
---

# GetConsumerPriceOverview

`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`

GetConsumerPriceOverview retrieves headline basket indices and coverage metrics.

## Query parameters

- `market_code` string
- `basket_slug` string
- `jmespath` string

## Response `200`

OK

- WorldmonitorConsumerPricesV1GetConsumerPriceOverviewResponse: 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: freshness_lag_min is the average minutes since last observation across all retailers.
  - `topCategories` WorldmonitorConsumerPricesV1CategorySnapshot[]
    - `slug` string: slug is the machine-readable category identifier (e.g. "eggs", "rice").
    - `name` string: name is the human-readable category label.
    - `wowPct` number, double: wow_pct is the week-over-week percentage change.
    - `momPct` number, double: mom_pct is the month-over-month percentage change.
    - `currentIndex` number, double: current_index is the current price index value (base = 100).
    - `sparkline` number[]
    - `coveragePct` number, double: coverage_pct is the percentage of basket items observed for this category.
    - `itemCount` integer: item_count is the number of observed products in this category.
  - `upstreamUnavailable` boolean: upstream_unavailable is true when the companion service could not be reached.

## Other responses

- `400`: Validation error
- `401`: Missing or invalid API key.
- `403`: API access requires an active subscription (the API key's subscription is inactive or expired).
- `429`: Rate limit exceeded.
- `503`: Service unavailable. Billing-verification responses include code and X-Billing-Verification; other gateway infrastructure failures use the generic GatewayError shape.
- `default`: Gateway or handler error response.

---

[API](https://skmtc.dev/worldmonitor/apis/worldmonitor-api.md) · [All operations](https://skmtc.dev/worldmonitor/apis/worldmonitor-api/llms.txt) · [OpenAPI document](https://skmtc.dev/worldmonitor/apis/worldmonitor-api/revisions/e3dc8463a5c9?raw)