Skip to main content
GET
/
api
/
consumer-prices
/
v1
/
list-consumer-price-categories
ListConsumerPriceCategories
curl --request GET \
  --url https://api.example.com/api/consumer-prices/v1/list-consumer-price-categories
{
  "marketCode": "<string>",
  "asOf": "<string>",
  "range": "<string>",
  "categories": [
    {
      "slug": "<string>",
      "name": "<string>",
      "wowPct": 123,
      "momPct": 123,
      "currentIndex": 123,
      "sparkline": [
        123
      ],
      "coveragePct": 123,
      "itemCount": 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 scope.

range
string

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

Response

Successful response

ListConsumerPriceCategoriesResponse holds category-level price snapshots.

marketCode
string

market_code echoes the requested market.

asOf
string<int64>

as_of is the Unix millisecond timestamp of the snapshot.

range
string

range echoes the requested range.

categories
object[]
upstreamUnavailable
boolean

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