Skip to main content
GET
/
api
/
consumer-prices
/
v1
/
get-consumer-price-basket-series
GetConsumerPriceBasketSeries
curl --request GET \
  --url https://api.example.com/api/consumer-prices/v1/get-consumer-price-basket-series
{
  "marketCode": "<string>",
  "basketSlug": "<string>",
  "asOf": "<string>",
  "currencyCode": "<string>",
  "range": "<string>",
  "essentialsSeries": [
    {
      "date": "<string>",
      "index": 123
    }
  ],
  "valueSeries": [
    {
      "date": "<string>",
      "index": 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.

basket_slug
string

basket_slug selects the basket (e.g. "essentials-ae").

range
string

range is one of "7d", "30d", "90d", "180d".

Response

Successful response

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 echoes the requested range.

essentialsSeries
object[]
valueSeries
object[]
upstreamUnavailable
boolean

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