Documentation

Production API Endpoint Documentation

Canonical public reference for the FX macro REST API. Covers announcements, market forecasts and predictions, release calendars, data discovery, COT positioning, precious metals, forex rates, and market sessions.

OpenAPI Schema MCP Docs Changelog

Base URL

https://fxmacrodata.com/api

Authentication

?api_key=YOUR_API_KEY

Append as a query parameter on request URLs

Endpoints

9 endpoints · 3 families

Access model

Always free

Calendar, data catalogue, forex, and market sessions require no API key.

Access model

Pro (USD free)

Announcements are mixed-access: USD is public, while non-USD currencies require a Professional API key.

Access model

Pro key required

COT and commodities require a Professional API key for every request.

On This Page

Page Index

Jump to any section below. Use the sticky bar above to navigate while scrolling.

How-To Guide

Authentication walkthroughs & usage patterns

Macro data and discovery

Fetch normalized macroeconomic indicator series with announcement...

FX market structure and sentiment

Query spot FX pairs and inspect the live global trading-session...

Market positioning and metals

CFTC Commitment of Traders positioning by currency and precious...

Indicator Index

Per-currency detail pages, filterable by indicator

Response Schemas

Representative payload snapshots per endpoint family

Quick Start Guide

How To Use FXMacroData Endpoints and Authentication

Start with one complete walkthrough covering authentication, endpoint families, real request examples, and the fastest way to move from testing USD endpoints to a production multi-currency integration.

Open how-to article Browse all how-to guides

What it covers

Authentication with ?api_key=YOUR_API_KEY
Announcements, predictions/forecasts, release calendar, COT, metals, forex, and sessions
Request patterns for USD-free and pro-key endpoint usage

Endpoint family · 01 of 3

Macro data and discovery

Fetch normalized macroeconomic indicator series with announcement timestamps, browse upcoming release schedules, and discover available indicators per currency.

GET /api/v1/announcements/{currency}/{indicator} Pro key · USD free

Historical macroeconomic indicator series with announcement timestamps.

USD is free without a key. All other currencies require a Professional API key.

Path parameters

Name	Type	Required	Description
`currency`	string	required	3-letter currency code. e.g. usd, eur, gbp, jpy, aud, cad, chf, nzd, cny, sgd, sek, dkk, pln, brl
`indicator`	string	required	Indicator slug. Use /v1/data_catalogue/{currency} to list available slugs per currency. e.g. gdp, inflation, core_inflation, policy_rate, unemployment

Query parameters

Name	Type	Required	Description
`start_date`	string (YYYY-MM-DD)	optional	Earliest date to include. Defaults to 365 days ago. e.g. 2025-01-01
`end_date`	string (YYYY-MM-DD)	optional	Latest date to include. Defaults to today. e.g. 2026-03-01
`api_key`	string	pro/free	Professional API key. Required for non-USD currencies. e.g. YOUR_API_KEY

Response fields

Field	Type	Description
`currency`	string	3-letter currency code.
`indicator`	string	Indicator slug as requested.
`has_official_forecast`	boolean	True if the central bank publishes an official forecast for this indicator.
`start_date`	string	Earliest date in the returned series (YYYY-MM-DD).
`end_date`	string	Latest requested end date (YYYY-MM-DD).
`cb_target`	object \| null	Central bank target metadata (e.g. inflation target range), if applicable.
`data[].date`	string	Observation date (YYYY-MM-DD).
`data[].announcement_id`	string	Stable announcement identifier in the form `{currency}_{indicator}_{date}` — use it to join predictions from /v1/predictions/{currency} and revision history.
`data[].val`	number \| null	Observed value in the indicator's native unit.
`data[].announcement_datetime`	integer \| null	Unix timestamp (UTC) of the official data release.
`data[].pct_change`	number \| null	Period-over-period percentage change.
`data[].pct_change_12m`	number \| null	12-month rolling percentage change.

Example request

GET https://fxmacrodata.com/api/v1/announcements/usd/inflation

Public USD endpoint — no API key needed. Forecasts are served separately by /v1/predictions/{currency}; join via `announcement_id`.

Supported currencies (14)

USD EUR GBP JPY AUD CAD CHF NZD CNY SGD SEK DKK PLN BRL

GET /api/v1/predictions/{currency} Pro key · USD free

Forecasts/predictions linked to announcements via announcement_id (market consensus, central-bank forecasts, IMF WEO, surveys).

USD is free without a key. All other currencies require a Professional API key.

Path parameters

Name	Type	Required	Description
`currency`	string	required	3-letter currency code. e.g. usd, eur, gbp, jpy, aud, cad, chf, nzd

Query parameters

Name	Type	Required	Description
`indicator`	string	optional	Optional indicator slug filter (e.g. inflation, policy_rate). e.g. inflation, policy_rate, unemployment
`prediction_type`	string	optional	Filter by forecast category: market_consensus, market_prediction, survey, central_bank_forecast, imf_weo. e.g. market_consensus, central_bank_forecast, imf_weo
`prediction_source`	string	optional	Filter by source identifier (e.g. philly_fed_spf, ecb_spf, imf_weo, rbnz_mps). e.g. philly_fed_spf, ecb_spf, imf_weo
`start_date`	string (YYYY-MM-DD)	optional	Earliest period date to include. e.g. 2025-01-01
`end_date`	string (YYYY-MM-DD)	optional	Latest period date to include. e.g. 2026-12-31
`api_key`	string	pro/free	Professional API key. Required for non-USD currencies. e.g. YOUR_API_KEY

Response fields

Field	Type	Description
`currency`	string	Currency code as requested.
`indicator`	string \| null	Indicator filter if provided, otherwise null.
`prediction_type`	string \| null	Active prediction-type filter, if any.
`prediction_source`	string \| null	Active prediction-source filter, if any.
`count`	integer	Number of announcement groups returned in data[].
`prediction_count`	integer	Total number of per-source predictions across all announcement groups.
`data[].announcement_id`	string	Identifier of the announcement these forecasts target — matches data[].announcement_id on /v1/announcements/{currency}/{indicator}.
`data[].currency`	string	Currency of the forecasted indicator (lowercase).
`data[].indicator`	string	Indicator slug of the forecasted release.
`data[].date`	string	Reference period date of the forecast (YYYY-MM-DD).
`data[].announcement_datetime`	integer \| null	Unix timestamp (UTC) of the forecasted announcement, when known.
`data[].predictions[].predicted_value`	number	Forecast value in the indicator's native unit.
`data[].predictions[].prediction_type`	string \| null	Forecast category: market_consensus, market_prediction, survey, central_bank_forecast, imf_weo, fxmacrodata.
`data[].predictions[].prediction_source`	string \| null	Stable identifier of the prediction data source.
`data[].predictions[].prediction_source_label`	string \| null	Human-readable name for the prediction source.
`data[].predictions[].generated_at`	integer \| null	Unix timestamp (UTC) when the prediction was generated, when available.

Example request

GET https://fxmacrodata.com/api/v1/predictions/usd?indicator=inflation

Use the announcement_id to join each prediction with the realised observation returned by /v1/announcements/{currency}/{indicator}.

Supported currencies (14)

USD EUR GBP JPY AUD CAD CHF NZD CNY SGD SEK DKK PLN BRL

GET /api/v1/predictions/{currency}/{indicator} Pro key · USD free

All available forecasts for one currency/indicator pair, linked via announcement_id.

USD is free without a key. All other currencies require a Professional API key.

Path parameters

Name	Type	Required	Description
`currency`	string	required	3-letter currency code. e.g. usd, eur, gbp, jpy
`indicator`	string	required	Indicator slug. Use /v1/data_catalogue/{currency} to discover available slugs. e.g. inflation, unemployment, policy_rate

Query parameters

Name	Type	Required	Description
`prediction_type`	string	optional	Filter by forecast category: market_consensus, market_prediction, survey, central_bank_forecast, imf_weo. e.g. imf_weo
`prediction_source`	string	optional	Filter by source identifier. e.g. philly_fed_spf
`start_date`	string (YYYY-MM-DD)	optional	Earliest period date. e.g. 2025-01-01
`end_date`	string (YYYY-MM-DD)	optional	Latest period date. e.g. 2026-12-31
`api_key`	string	pro/free	Professional API key. Required for non-USD currencies. e.g. YOUR_API_KEY

Response fields

Field	Type	Description
`data[].announcement_id`	string	Identifier matching data[].announcement_id on /v1/announcements/{currency}/{indicator}.
`data[].announcement_datetime`	integer \| null	Unix timestamp (UTC) of the forecasted announcement.
`data[].predictions[].predicted_value`	number	Forecast value in the indicator's native unit.
`data[].predictions[].prediction_type`	string \| null	Forecast category.
`data[].predictions[].prediction_source`	string \| null	Stable source identifier.
`data[].predictions[].prediction_source_label`	string \| null	Human-readable name for the prediction source.
`data[].predictions[].generated_at`	integer \| null	Unix timestamp (UTC) when the prediction was generated.

Example request

GET https://fxmacrodata.com/api/v1/predictions/usd/inflation?prediction_source=philly_fed_spf

Join predictions to actuals via the announcement_id field shared with /v1/announcements/{currency}/{indicator}.

Supported currencies (14)

USD EUR GBP JPY AUD CAD CHF NZD CNY SGD SEK DKK PLN BRL

GET /api/v1/calendar/{currency} Free

Upcoming release dates for a currency and optional indicator filter.

Fully public — no API key required.

Path parameters

Name	Type	Required	Description
`currency`	string	required	3-letter currency code or COMM for commodity release schedules. e.g. usd, eur, gbp, jpy, aud, cad, chf, nzd, cny, sgd, sek, dkk, pln, brl, COMM

Query parameters

Name	Type	Required	Description
`indicator`	string	optional	Optional filter to a specific indicator slug (e.g. inflation, gdp). e.g. inflation, gdp, unemployment

Response fields

Field	Type	Description
`currency`	string	Currency code as requested.
`indicator`	string \| null	Indicator filter if provided, otherwise null.
`data[].announcement_datetime`	integer	Unix timestamp (UTC) of the upcoming release.
`data[].release`	string	Indicator slug for this release row (e.g. inflation, policy_rate).
`data[].domain`	string	Present on non-announcement rows (e.g. cot). Identifies the data domain.
`data[].endpoint_family`	string	Endpoint family identifier for non-announcement rows (e.g. cot).
`data[].endpoint_path`	string	Suggested API path to fetch the full release data.
`data[].requires_api_key`	boolean	Whether the linked endpoint requires a Professional API key.
`data[].title`	string	Human-readable title for the release (present on extended domain rows).

Example request

GET https://fxmacrodata.com/api/v1/calendar/usd

Returns all upcoming USD macro release dates. Filter by indicator with ?indicator=inflation.

Supported currencies (19)

USD EUR GBP JPY AUD CAD CHF NZD CNY SGD SEK DKK PLN BRL HKD KRW MXN NOK COMM

GET /api/v1/data_catalogue/{currency} Free

Available indicator metadata for a currency.

Fully public — no API key required.

Path parameters

Name	Type	Required	Description
`currency`	string	required	3-letter currency code. e.g. usd, eur, gbp, jpy, aud, cad, chf, nzd

Query parameters

Name	Type	Required	Description
`include_capabilities`	boolean	optional	If true, adds route and authentication discovery metadata per indicator. e.g. true
`include_coverage`	boolean	optional	If true, adds a per-currency availability grid across all supported currencies. e.g. true

Response fields

Field	Type	Description
`{indicator_slug}`	object	Top-level key is the indicator slug (e.g. gdp, inflation, policy_rate).
`{slug}.name`	string	Human-readable indicator name.
`{slug}.unit`	string	Unit of measurement (e.g. %YoY, %QoQ, %).
`{slug}.frequency`	string	Release frequency (Monthly, Quarterly, Meeting, Daily).
`{slug}.has_official_forecast`	boolean	Whether the central bank publishes an official forecast.

Example request

GET https://fxmacrodata.com/api/v1/data_catalogue/usd

Lists all indicators available for USD with name, unit, and frequency metadata.

Supported currencies (14)

USD EUR GBP JPY AUD CAD CHF NZD CNY SGD SEK DKK PLN BRL

Endpoint family · 02 of 3

FX market structure and sentiment

Query spot FX pairs and inspect the live global trading-session schedule for market-timing workflows.

GET /api/v1/forex/{base}/{quote} Free

Daily FX spot-rate series for a currency pair, with optional technical indicators.

Fully public — no API key required.

Path parameters

Name	Type	Required	Description
`base`	string	required	Base currency 3-letter code. e.g. EUR, GBP, USD, AUD
`quote`	string	required	Quote currency 3-letter code. e.g. USD, JPY, CHF, CAD

Query parameters

Name	Type	Required	Description
`start_date`	string (YYYY-MM-DD)	optional	Start of the date range. Defaults to 365 days ago. e.g. 2025-01-01
`end_date`	string (YYYY-MM-DD)	optional	End of the date range. Defaults to today. e.g. 2026-03-01
`indicators`	string	optional	Comma-separated technical indicator slugs to append to each row (e.g. sma_20,rsi_14). e.g. sma_20,rsi_14

Response fields

Field	Type	Description
`base`	string	Base currency code.
`quote`	string	Quote currency code.
`start_date`	string	Earliest date in the series (YYYY-MM-DD).
`end_date`	string	Latest date in the series (YYYY-MM-DD).
`data[].date`	string	Trading date (YYYY-MM-DD).
`data[].val`	number \| null	Spot rate for the pair on this date.
`indicators.{slug}.{date}`	number \| null	Per-date value for the requested technical indicator (e.g. sma_20, rsi_14). Only present when indicators parameter is supplied. Multi-series indicators (macd, bollinger_bands) return nested dicts.

Example request

GET https://fxmacrodata.com/api/v1/forex/eur/usd

Returns daily EUR/USD spot rates for the past year.

Supported currencies (14)

USD EUR GBP JPY AUD CAD CHF NZD CNY SGD SEK DKK PLN BRL

GET /api/v1/market_sessions Free

Real-time FX market-session and overlap timetable.

Fully public — no API key required.

Query parameters

Name	Type	Required	Description
`at`	string (ISO-8601 UTC)	optional	Optional reference timestamp for scheduling or back-testing. Defaults to current server time. e.g. 2026-03-05T12:00:00Z

Response fields

Field	Type	Description
`now_utc`	string	Current server time in ISO-8601 UTC.
`now_unix`	integer	Current server time as Unix epoch.
`is_market_day`	boolean	False on weekends and major market holidays.
`sessions[].name`	string	Session name (Sydney, Tokyo, London, New York).
`sessions[].display_name`	string	Full descriptive name including region.
`sessions[].description`	string	Brief characterisation of the session.
`sessions[].currencies`	array	Currency codes most active during this session.
`sessions[].timezone`	string	IANA timezone for the session's home market.
`sessions[].open_utc`	string	Today's session open in ISO-8601 UTC.
`sessions[].close_utc`	string	Today's session close in ISO-8601 UTC.
`sessions[].is_open`	boolean	Whether the session is currently open.
`sessions[].seconds_to_open`	integer \| null	Seconds until this session opens (null if already open or closed for the day).
`sessions[].seconds_to_close`	integer \| null	Seconds until this session closes (null if not currently open).
`overlaps[].name`	string	Overlap window name (e.g. London / New York).
`overlaps[].sessions`	array	Session names that form this overlap.
`overlaps[].description`	string	Characterisation of liquidity during this overlap.
`overlaps[].priority`	string	Liquidity priority — high, medium, or low.
`overlaps[].notable_pairs`	array	Most actively traded pairs during this overlap.
`overlaps[].start_utc`	string	Overlap window start in ISO-8601 UTC.
`overlaps[].end_utc`	string	Overlap window end in ISO-8601 UTC.
`overlaps[].is_active`	boolean	Whether the overlap window is currently active.
`overlaps[].duration_hours`	number	Duration of the overlap in hours.

Example request

GET https://fxmacrodata.com/api/v1/market_sessions

Returns a real-time snapshot of all four sessions plus overlap windows. Use ?at=2026-03-05T08:00:00Z for a historical snapshot.

Endpoint family · 03 of 3

Market positioning and metals

CFTC Commitment of Traders positioning by currency and precious metals price series for cross-market analysis.

GET /api/v1/cot/{currency} Pro key required

Weekly CFTC Commitment of Traders positioning by currency.

Always requires a Professional API key.

Path parameters

Name	Type	Required	Description
`currency`	string	required	3-letter currency code. Maps to the corresponding CME FX futures contract. e.g. USD, EUR, GBP, JPY, AUD, CAD, CHF, NZD

Query parameters

Name	Type	Required	Description
`start_date`	string (YYYY-MM-DD)	optional	Start of the date range. Defaults to 52 weeks ago. e.g. 2025-01-01
`end_date`	string (YYYY-MM-DD)	optional	End of the date range. Defaults to today. e.g. 2026-03-01
`api_key`	string	required	Professional API key. e.g. YOUR_API_KEY

Supported currencies

USD EUR GBP JPY AUD CAD CHF NZD

Response fields

Field	Type	Description
`currency`	string	3-letter currency code.
`instrument`	string	Full CFTC instrument name (e.g. JAPANESE YEN - CHICAGO MERCANTILE EXCHANGE).
`fx_overlay.pair`	string	Conventional spot pair label for chart overlays (e.g. USD/JPY, GBP/USD, DXY).
`start_date`	string	Start of the returned series (YYYY-MM-DD).
`end_date`	string	End of the returned series (YYYY-MM-DD).
`data[].date`	string	Tuesday as-of date for the COT snapshot (YYYY-MM-DD).
`data[].announcement_datetime`	integer	Unix timestamp of the Friday 3:30 PM ET CFTC publication for this row.
`data[].open_interest`	integer	Total open interest across all participants.
`data[].noncommercial_long`	integer	Non-commercial (speculative) long positions.
`data[].noncommercial_short`	integer	Non-commercial (speculative) short positions.
`data[].noncommercial_net`	integer	Net speculative positioning (long minus short).
`data[].noncommercial_spread`	integer	Non-commercial spread positions.
`data[].commercial_long`	integer	Commercial (hedger) long positions.
`data[].commercial_short`	integer	Commercial (hedger) short positions.
`data[].commercial_net`	integer	Net commercial positioning (long minus short).
`data[].total_reportable_long`	integer	Total reportable long positions.
`data[].total_reportable_short`	integer	Total reportable short positions.
`data[].nonreportable_long`	integer	Non-reportable (small trader) long positions.
`data[].nonreportable_short`	integer	Non-reportable (small trader) short positions.

Example request

GET https://fxmacrodata.com/api/v1/cot/usd?api_key=YOUR_API_KEY

Returns USD COT history. All COT requests require a Professional API key. Data sourced from the CFTC Legacy Futures-Only report.

GET /api/v1/commodities/{indicator} Pro key required

Precious metals price series for gold, silver, and platinum.

Always requires a Professional API key regardless of indicator.

Path parameters

Name	Type	Required	Description
`indicator`	string	required	Commodity indicator slug. e.g. gold, silver, platinum

Query parameters

Name	Type	Required	Description
`start_date`	string (YYYY-MM-DD)	optional	Start of the date range. Defaults to 365 days ago. e.g. 2025-01-01
`end_date`	string (YYYY-MM-DD)	optional	End of the date range. Defaults to today. e.g. 2026-03-01
`api_key`	string	required	Professional API key. e.g. YOUR_API_KEY

Supported metals indicators (3)

Slug	Name	Unit	Frequency
`gold`	Gold (LBMA PM Fix)	USD/troy oz	Daily
`silver`	Silver (LBMA Fix)	USD/troy oz	Daily
`platinum`	Platinum Spot	USD/troy oz	Daily

Response fields

Field	Type	Description
`currency`	string	Always COMM (commodity namespace).
`indicator`	string	Precious metals slug as requested (e.g. gold, silver, platinum).
`has_official_forecast`	boolean	Always false — precious metals have no official central bank forecast.
`start_date`	string	Earliest date in the returned series (YYYY-MM-DD).
`end_date`	string	Latest requested end date (YYYY-MM-DD).
`data[].date`	string	Observation date (YYYY-MM-DD).
`data[].val`	number \| null	Price or index value in the indicator's native unit.
`data[].announcement_datetime`	integer \| null	Unix timestamp of the official data publication (null for daily prices).
`data[].pct_change`	number \| null	Period-over-period percentage change.
`data[].pct_change_12m`	number \| null	12-month rolling percentage change.

Example request

GET https://fxmacrodata.com/api/v1/commodities/gold?api_key=YOUR_API_KEY

Returns gold LBMA PM Fix daily spot prices for the past year. Replace gold with silver or platinum for the other supported metals.

Indicator coverage

Announcement endpoint index

Per-currency detail pages for every announcement indicator. USD endpoints are free; all others require a Professional subscription.

معیشت (29)

مجموعی گھریلو پیداوار (GDP) نمو

gdp

تمام تیار کردہ اشیاء اور خدمات کی افراط زر کے مطابق قدر میں سہ ماہی تبدیلی کی پیمائش کرتا ہے۔

USD AUD GBP CHF NZD EUR JPY BRL

افراط زر کی شرح (CPI/HICP)

inflation

صارفین کی قیمتوں کے اشاریہ (CPI) میں سال بہ سال فیصد تبدیلی کی پیمائش کرتا ہے۔

USD AUD GBP CHF NZD EUR JPY BRL

بنیادی افراط زر

core_inflation

CPI جس میں خوراک اور توانائی جیسی غیر مستحکم اشیاء شامل نہیں ہیں۔

USD CHF GBP AUD CAD CNY EUR JPY

PCE قیمت انڈیکس

pce

BEA کی طرف سے شائع کردہ ذاتی کھپت کے اخراجات کا اہم قیمت اشاریہ۔

USD

پروڈیوسر پرائس انڈیکس (PPI)

ppi

گھریلو پیداوار کنندگان کو ان کی پیداوار کے لیے موصول ہونے والی فروخت کی قیمتوں میں وقت کے ساتھ اوسط تبدیلی کی پیمائش کرتا ہے۔

GBP USD CHF JPY AUD CAD CNY EUR

تجارتی توازن

trade_balance

کسی ملک کی برآمدات اور درآمدات کی قدر کے درمیان فرق۔

AUD EUR GBP USD CHF JPY NZD BRL

اشیاء کا توازن

balance_on_goods

ادائیگیوں کا توازن: اشیاء کی تجارت۔

EUR

خدمات کا توازن

balance_on_services

ادائیگیوں کا توازن: خدمات کی تجارت۔

EUR

اشیاء اور خدمات کی برآمدات

exports

ABS کی طرف سے رپورٹ کردہ کل برآمدات (AUD ملین)، قومی کھاتوں کی بنیاد پر سہ ماہی۔

AUD CHF GBP

اشیاء اور خدمات کی درآمدات

imports

ABS کی طرف سے رپورٹ کردہ کل درآمدات (AUD ملین)، قومی کھاتوں کی بنیاد پر سہ ماہی۔

AUD CHF GBP

کرنٹ اکاؤنٹ بیلنس

current_account_balance

اشیاء اور خدمات کی تجارت اور آمدنی کے بہاؤ کی پیمائش کرتا ہے۔

EUR GBP USD AUD CHF JPY NZD BRL

ریٹیل سیلز

retail_sales

خوردہ سطح پر فروخت کی کل قدر میں تبدیلی کی پیمائش کرتا ہے۔

GBP USD AUD CAD CHF CNY JPY

صنعتی پیداوار

industrial_production

صنعتی شعبے (مینوفیکچرنگ، کان کنی، یوٹیلیٹیز) کی پیداوار کی پیمائش کرتا ہے۔

USD

پائیدار اشیاء کے آرڈرز

durable_goods_orders

گھریلو مینوفیکچررز کے پاس دیرپا اشیاء کی ترسیل کے لیے دیے گئے نئے آرڈرز کی پیمائش کرتا ہے۔

USD

صارفین کا رجحان

consumer_sentiment

صارفین کے اعتماد کی سطح کا ایک سروے (جائزہ)۔

USD CAD CHF CNY JPY

Trade-Weighted Index (NEER)

trade_weighted_index

Nominal Effective Exchange Rate (NEER) measuring the value of a currency relative to a basket of trading partners'...

AUD BRL CAD CHF CNY DKK EUR GBP

House Price Index

house_price_index

Measures changes in residential property prices over time, reflecting housing market conditions and consumer wealth.

AUD USD

Inflation MoM

inflation_mom

Month-over-month change in the consumer price index, measuring short-term inflationary momentum.

CAD EUR GBP USD DKK PLN

Producer Price Index MoM (PPI)

ppi_mom

Month-over-month change in producer prices, an early indicator of inflationary pressure in the supply chain.

EUR USD

Core Inflation MoM

core_inflation_mom

Month-over-month change in core consumer prices (excluding food and energy), tracking underlying inflation trends.

EUR USD

PCE MoM

pce_mom

Month-over-month change in the Personal Consumption Expenditures price index.

USD

Building Permits

building_permits

Number of new residential construction permits authorized, a leading indicator of future housing activity and...

CAD USD

Housing Starts

housing_starts

Number of new residential construction projects that have begun in a given period, a key indicator of economic...

CAD JPY USD

Government Debt

government_debt

Total outstanding debt obligations of the central government, indicating fiscal sustainability and public sector...

USD

Manufacturing PMI

pmi

Purchasing Managers' Index for the manufacturing sector, a leading indicator of economic activity based on surveys...

USD

Services PMI (NMI)

nmi

Non-Manufacturing Index (NMI) or Services PMI, a leading indicator of economic activity in the services sector. A...

USD

Business Confidence

business_confidence

Survey-based measure of business executives' outlook on economic conditions, production, and investment plans.

CAD CNY

صارفین کا اعتماد

consumer_confidence

KOF لیڈنگ انڈیکیٹر / کنزیومر کانفیڈنس انڈیکس۔

CAD CHF CNY JPY

Business Sentiment

business_sentiment

مالیاتی پالیسی (5)

مرکزی بینک کی پالیسی شرح

policy_rate

مرکزی بینک کی طرف سے مقرر کردہ بنیادی شرح سود۔

AUD EUR GBP JPY NZD USD CHF BRL

رسک فری شرح

risk_free_rate

بینکوں کے درمیان راتوں رات قرض دینے کی شرح۔

AUD CHF EUR GBP JPY NZD USD BRL

Foreign Exchange Reserves

foreign_reserves

Assets held by the central bank in foreign currencies, used to support the exchange rate and manage monetary policy....

AUD CHF CNY JPY USD

Gold Reserves

gold_reserves

Quantity of gold held by the central bank as part of its foreign exchange reserves, measured in value terms.

AUD CHF CNY USD

Central Bank Total Assets

cb_assets

Total assets on the central bank's balance sheet, reflecting the scale of monetary policy operations including...

AUD CHF CNY JPY USD

حکومتی بانڈ کی پیداوار (12)

1 سالہ حکومتی بانڈ کی پیداوار

gov_bond_1y

CHF

2 سالہ حکومتی بانڈ کی پیداوار

gov_bond_2y

AUD CHF EUR JPY NZD USD GBP CNY

3 سالہ حکومتی بانڈ کی پیداوار

gov_bond_3y

AUD CHF EUR JPY NZD USD GBP CNY

4 سالہ حکومتی بانڈ کی پیداوار

gov_bond_4y

CHF

5 سالہ حکومتی بانڈ کی پیداوار

gov_bond_5y

AUD CHF EUR GBP JPY NZD USD CNY

7 سالہ حکومتی بانڈ کی پیداوار

gov_bond_7y

JPY CAD

10 سالہ حکومتی بانڈ کی پیداوار

gov_bond_10y

AUD CHF EUR GBP JPY NZD USD CNY

20 سالہ حکومتی بانڈ کی پیداوار

gov_bond_20y

CHF JPY GBP

30 سالہ حکومتی بانڈ کی پیداوار

gov_bond_30y

CHF JPY CAD

40 سالہ حکومتی بانڈ کی پیداوار

gov_bond_40y

JPY

افراط زر سے منسلک بانڈ کی پیداوار

inflation_linked_bond

AUD GBP NZD USD EUR CAD

10 سالہ بریک ایون افراط زر کی شرح

breakeven_inflation_rate

USD EUR

شرح سود (1)

راتوں رات ڈپازٹ کی شرح

deposit_rates

رجسٹرڈ بینکوں میں راتوں رات ڈپازٹ کی شرح۔ RBNZ یومیہ بینکنگ ریٹس۔

NZD

SNB اشارے (2)

ڈیمانڈ ڈپازٹس

sight_deposits

SNB سائٹ ڈپازٹس (جیرو اکاؤنٹ بیلنس)۔

CHF

SNB بیلنس شیٹ

snb_balance_sheet

trimmed_mean_inflation

انٹیگریشن ٹیسٹ کے ذریعے تصدیق شدہ اشاریہ۔

AUD

اجرت پرائس انڈیکس

wage_price_index

انٹیگریشن ٹیسٹ کے ذریعے تصدیق شدہ اشاریہ۔

AUD

API response structure

Representative payload snapshots

Example field values from the live production contract. Core timestamp semantics are consistent across families; each endpoint adds domain-specific fields on top.

Discovery

USD catalogue metadata

Indicator discovery is not limited to one headline series. The live USD catalogue currently includes growth, inflation, rates, labor, housing, liquidity, and reserve metrics.

/api/v1/data_catalogue/usd

gdp GDP · %QoQ · Quarterly

inflation Inflation CPI · %YoY · Monthly

policy_rate Policy Rate · % · Meeting

Announcement Series

EUR inflation release data

Announcement series return a top-level envelope plus a data array of observations, each stamped with the exact publication timestamp used for event-driven research.

/api/v1/announcements/eur/inflation

currency EUR

indicator inflation

has_official_forecast false

data[0].date 2026-02-28

data[0].val 2.3

data[0].announcement_datetime 1772272800

COT Positioning

GBP speculative positioning

Weekly CFTC COT data tracks net speculative positioning by currency. Includes open interest, long/short splits for commercial, non-commercial, and non-reportable traders.

/api/v1/cot/gbp

currency GBP

instrument BRITISH POUND - CME

fx_overlay.pair GBP/USD

data[0].date 2026-02-24

data[0].open_interest 245,678

data[0].noncommercial_net -8,020

Release Calendar

JPY upcoming releases

The calendar endpoint returns upcoming releases sorted by announcement timestamp. Non-announcement rows (e.g. COT) include routing metadata like endpoint_path.

/api/v1/calendar/jpy

currency JPY

data[0].release policy_rate

data[0].announcement_datetime 1774580400

data[1].endpoint_family cot

data[1].endpoint_path /v1/cot/jpy

data[1].requires_api_key true

Metals

Gold LBMA PM Fix prices

Precious metals series return daily price data from official sources with period-over-period and 12-month change enrichment.

/api/v1/commodities/gold

currency COMM

indicator gold

data[0].date 2026-02-28

data[0].val 2870.00

data[0].pct_change 1.2

data[0].pct_change_12m 30.1

Market Sessions

Live FX session snapshot

The market sessions endpoint returns real-time open/close state for Sydney, Tokyo, London, and New York, plus overlap windows showing peak-liquidity periods.

/api/v1/market_sessions

is_market_day true

sessions[0].name London

sessions[0].is_open true

sessions[0].seconds_to_close 18000

overlaps[0].name London / New York

overlaps[0].priority high

Schema and connectors

OpenAPI schema and MCP reference

The production OpenAPI schema is the authoritative path list. The MCP reference covers remote AI tooling and OAuth connector behavior.

OpenAPI schema MCP docs Indicator index ↑

Endpoint families

Macro data and discovery FX market structure and sentiment Market positioning and metals