Skip to main content
GET
GetUsCpiMonthly

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

history
boolean

When true, return every stored month. When false, return only the latest month.

jmespath
string

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

Successful response

GetUsCpiMonthlyResponse is the CPI basket for the requested window.

months
object[]
unavailable
boolean

True when the seeded series is unavailable. An empty month list is not a zero print.