---
title: "GetConsumerPriceBasketSeries"
method: GET
path: "/api/consumer-prices/v1/get-consumer-price-basket-series"
tags: ["ConsumerPricesService"]
---

# GetConsumerPriceBasketSeries

`GET /api/consumer-prices/v1/get-consumer-price-basket-series`

## Request

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

Retrieve consumer price basket index history by market, basket and date range, with dated observations, currency and snapshot time for price trend analysis.

## Query parameters

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

## Response `200`

OK

- WorldmonitorConsumerPricesV1GetConsumerPriceBasketSeriesResponse: GetConsumerPriceBasketSeriesResponse contains the basket index time series.
  - `marketCode` string: market_code echoes the requested market.
  - `basketSlug` string: basket_slug echoes the requested basket.
  - `asOf` string, int64: as_of is the Unix millisecond timestamp of the snapshot.
  - `currencyCode` string: currency_code is the ISO 4217 currency code.
  - `range` string: range is the effective normalized range used for the returned snapshot.
  - `essentialsSeries` WorldmonitorConsumerPricesV1BasketPoint[]
    - `date` string: date is the ISO 8601 date string (YYYY-MM-DD).
    - `index` number, double: index is the basket index value (base = 100).
  - `valueSeries` WorldmonitorConsumerPricesV1BasketPoint[]
    - `date` string: date is the ISO 8601 date string (YYYY-MM-DD).
    - `index` number, double: index is the basket index value (base = 100).
  - `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)