GetConsumerPriceBasketSeries

curl --request GET \
  --url https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series \
  --header 'X-WorldMonitor-Key: <api-key>'

import requests

url = "https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series"

headers = {"X-WorldMonitor-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-WorldMonitor-Key': '<api-key>'}};

fetch('https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-WorldMonitor-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-WorldMonitor-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-WorldMonitor-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "asOf": "1717200000000",
  "basketSlug": "essentials-ae",
  "currencyCode": "USD",
  "essentialsSeries": [
    {
      "date": "2026-01-15",
      "index": 1.5
    }
  ],
  "marketCode": "US"
}

{
  "violations": [
    {
      "field": "<string>",
      "description": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>",
  "code": "subscription_lapsed",
  "requiredTier": 123,
  "currentTier": 123,
  "planKey": "<string>"
}

{
  "message": "<string>"
}

{
  "error": "<string>",
  "code": "renewal_verification_pending",
  "requiredTier": 123
}

{
  "message": "<string>"
}

GET

api

consumer-prices

get-consumer-price-basket-series

GetConsumerPriceBasketSeries

curl --request GET \
  --url https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series \
  --header 'X-WorldMonitor-Key: <api-key>'

import requests

url = "https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series"

headers = {"X-WorldMonitor-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-WorldMonitor-Key': '<api-key>'}};

fetch('https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-WorldMonitor-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-WorldMonitor-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-basket-series")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-WorldMonitor-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "asOf": "1717200000000",
  "basketSlug": "essentials-ae",
  "currencyCode": "USD",
  "essentialsSeries": [
    {
      "date": "2026-01-15",
      "index": 1.5
    }
  ],
  "marketCode": "US"
}

{
  "violations": [
    {
      "field": "<string>",
      "description": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>",
  "code": "subscription_lapsed",
  "requiredTier": 123,
  "currentTier": 123,
  "planKey": "<string>"
}

{
  "message": "<string>"
}

{
  "error": "<string>",
  "code": "renewal_verification_pending",
  "requiredTier": 123
}

{
  "message": "<string>"
}

Authorizations

X-WorldMonitor-Key

string

header

required

User-issued WorldMonitor API key.

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". Unsupported values use "30d".

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

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

object[]

Show child attributes

valueSeries

object[]

Show child attributes

upstreamUnavailable

boolean

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