{"openapi":"3.1.0","info":{"title":"FX Macrodata API","description":"...","version":"1.0.0"},"paths":{"/v1/data_catalogue/{currency}":{"get":{"tags":["data_catalogue"],"summary":"Get Currently Available Macroeconomic Indicators","description":"Returns the currently available macroeconomic indicators for a specific currency.\n\n    Availability is determined from the Firestore-backed product store rather than\n    the static indicator registry alone, so temporarily unavailable series are\n    excluded until live data is available again. The catalogue is refreshed on a\n    regular schedule.\n\n    This route also replaces the deprecated `/v1/capabilities` and\n    `/v1/coverage_matrix` endpoints. To include that metadata on the same route,\n    call it with `include_capabilities=true` and/or `include_coverage=true`.\n\n    Each entry includes:\n    * **name**: The full descriptive name of the metric.\n    * **unit**: The unit of measurement (e.g., %YoY, Billions of USD).\n    * **frequency**: How often the data is updated (Daily, Monthly, Quarterly).\n    * **has_official_forecast**: Whether the relevant central bank or statistics agency publishes a preliminary, flash, or advance estimate of this indicator before the main/final data release.","operationId":"get_data_catalogue_v1_data_catalogue__currency__get","parameters":[{"name":"currency","in":"path","required":true,"schema":{"type":"string","description":"The 3-letter currency code (e.g., USD, AUD, EUR, GBP, CHF)","examples":["USD"],"title":"Currency","enum":["AUD","BRL","CAD","CHF","CNY","DKK","EUR","GBP","JPY","NZD","PLN","SEK","SGD","USD"],"example":"AUD"},"description":"The 3-letter currency code (e.g., USD, AUD, EUR, GBP, CHF) Allowed values: AUD, BRL, CAD, CHF, CNY, DKK, EUR, GBP, JPY, NZD, PLN, SEK, SGD, USD."},{"name":"include_capabilities","in":"query","required":false,"schema":{"type":"boolean","description":"Include currency-scoped endpoint/auth metadata that replaces the deprecated /v1/capabilities response.","default":false,"title":"Include Capabilities"},"description":"Include currency-scoped endpoint/auth metadata that replaces the deprecated /v1/capabilities response."},{"name":"include_coverage","in":"query","required":false,"schema":{"type":"boolean","description":"Include a currency-scoped coverage list that replaces the deprecated /v1/coverage_matrix response.","default":false,"title":"Include Coverage"},"description":"Include a currency-scoped coverage list that replaces the deprecated /v1/coverage_matrix response."},{"name":"indicator","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional indicator filter when include_coverage=true.","examples":["inflation"],"title":"Indicator","enum":["average_hourly_earnings","balance_on_goods","balance_on_services","boc_business_outlook","breakeven_inflation_rate","broad_money","building_approvals","building_permits","business_confidence","business_sentiment","cb_assets","commodity_price_energy","commodity_price_ex_energy","commodity_price_index","commodity_prices","consumer_confidence","consumer_expectations","consumer_sentiment","core_inflation","core_inflation_median","core_inflation_mom","core_inflation_trim","core_pce","core_pce_mom","credit_growth","current_account_balance","deposit_rates","domestic_credit","durable_goods_orders","employment","exports","foreign_reserves","full_time_employment","fx_reserves","gdp","gdp_quarterly","gold_reserves","gov_bond_10y","gov_bond_1y","gov_bond_20y","gov_bond_2y","gov_bond_30y","gov_bond_3y","gov_bond_40y","gov_bond_4y","gov_bond_5y","gov_bond_7y","government_debt","house_price_index","household_credit","housing_starts","imports","industrial_production","inflation","inflation_expectations","inflation_linked_bond","inflation_mom","initial_jobless_claims","job_openings","kof_barometer","m1","m2","m3","money_supply_currency","money_supply_savings_deposits","money_supply_term_deposits","money_supply_transaction_deposits","monthly_cpi","mortgage_rate","nairu","nmi","non_farm_payrolls","part_time_employment","participation_rate","pmi","policy_rate","ppi","ppi_mom","private_sector_credit","real_exchange_rate","retail_sales","risk_free_rate","sight_deposits","snb_balance_sheet","tankan_capex","terms_of_trade","trade_balance","trade_weighted_index","trimmed_mean_inflation","unemployment","wage_price_index","wages"],"example":"average_hourly_earnings"},"description":"Optional indicator filter when include_coverage=true. Allowed values: average_hourly_earnings, balance_on_goods, balance_on_services, boc_business_outlook, breakeven_inflation_rate, broad_money, building_approvals, building_permits, business_confidence, business_sentiment, cb_assets, commodity_price_energy, commodity_price_ex_energy, commodity_price_index, commodity_prices, consumer_confidence, consumer_expectations, consumer_sentiment, core_inflation, core_inflation_median, core_inflation_mom, core_inflation_trim, core_pce, core_pce_mom, credit_growth, current_account_balance, deposit_rates, domestic_credit, durable_goods_orders, employment, exports, foreign_reserves, full_time_employment, fx_reserves, gdp, gdp_quarterly, gold_reserves, gov_bond_10y, gov_bond_1y, gov_bond_20y, gov_bond_2y, gov_bond_30y, gov_bond_3y, gov_bond_40y, gov_bond_4y, gov_bond_5y, gov_bond_7y, government_debt, house_price_index, household_credit, housing_starts, imports, industrial_production, inflation, inflation_expectations, inflation_linked_bond, inflation_mom, initial_jobless_claims, job_openings, kof_barometer, m1, m2, m3, money_supply_currency, money_supply_savings_deposits, money_supply_term_deposits, money_supply_transaction_deposits, monthly_cpi, mortgage_rate, nairu, nmi, non_farm_payrolls, part_time_employment, participation_rate, pmi, policy_rate, ppi, ppi_mom, private_sector_credit, real_exchange_rate, retail_sales, risk_free_rate, sight_deposits, snb_balance_sheet, tankan_capex, terms_of_trade, trade_balance, trade_weighted_index, trimmed_mean_inflation, unemployment, wage_price_index, wages."}],"responses":{"200":{"description":"Indicator metadata keyed by indicator slug, with optional capability and coverage metadata.","content":{"application/json":{"schema":{},"example":{"gdp":{"name":"GDP","unit":"%QoQ","frequency":"Quarterly","has_official_forecast":true},"inflation":{"name":"Inflation (CPI)","unit":"%YoY","frequency":"Monthly","has_official_forecast":false},"unemployment":{"name":"Unemployment Rate","unit":"%","frequency":"Monthly","has_official_forecast":false},"policy_rate":{"name":"Policy Interest Rate","unit":"%","frequency":"Daily","has_official_forecast":false},"gov_bond_10y":{"name":"10-Year Government Bond Yield","unit":"%","frequency":"Daily","has_official_forecast":false}}}}},"404":{"description":"Currency not found.","content":{"application/json":{"example":{"detail":"Currency 'XYZ' not found."}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-parameter-availability":{"currency":["AUD","BRL","CAD","CHF","CNY","DKK","EUR","GBP","JPY","NZD","PLN","SEK","SGD","USD"],"indicator":["average_hourly_earnings","balance_on_goods","balance_on_services","boc_business_outlook","breakeven_inflation_rate","broad_money","building_approvals","building_permits","business_confidence","business_sentiment","cb_assets","commodity_price_energy","commodity_price_ex_energy","commodity_price_index","commodity_prices","consumer_confidence","consumer_expectations","consumer_sentiment","core_inflation","core_inflation_median","core_inflation_mom","core_inflation_trim","core_pce","core_pce_mom","credit_growth","current_account_balance","deposit_rates","domestic_credit","durable_goods_orders","employment","exports","foreign_reserves","full_time_employment","fx_reserves","gdp","gdp_quarterly","gold_reserves","gov_bond_10y","gov_bond_1y","gov_bond_20y","gov_bond_2y","gov_bond_30y","gov_bond_3y","gov_bond_40y","gov_bond_4y","gov_bond_5y","gov_bond_7y","government_debt","house_price_index","household_credit","housing_starts","imports","industrial_production","inflation","inflation_expectations","inflation_linked_bond","inflation_mom","initial_jobless_claims","job_openings","kof_barometer","m1","m2","m3","money_supply_currency","money_supply_savings_deposits","money_supply_term_deposits","money_supply_transaction_deposits","monthly_cpi","mortgage_rate","nairu","nmi","non_farm_payrolls","part_time_employment","participation_rate","pmi","policy_rate","ppi","ppi_mom","private_sector_credit","real_exchange_rate","retail_sales","risk_free_rate","sight_deposits","snb_balance_sheet","tankan_capex","terms_of_trade","trade_balance","trade_weighted_index","trimmed_mean_inflation","unemployment","wage_price_index","wages"]}}},"/v1/calendar/{currency}":{"get":{"tags":["calendar"],"summary":"Get upcoming economic data release dates","description":"Returns upcoming economic data release dates for a given currency.\n\nRows are served from Firestore-first calendar documents. Announcement rows keep the existing `release` slug mapping to `/v1/announcements/{currency}/{indicator}`, while other domains such as COT may also include additive fields like `domain`, `endpoint_family`, and `endpoint_path`.\n\n**Path Parameters:**\n- `currency`: The 3-letter currency code (e.g., USD).\n\n**Query Parameters:**\n- `indicator`: Optional. Filter to a specific indicator (e.g., gdp, inflation, unemployment, non_farm_payrolls).\n\n**Returns:** List of release rows sorted by date ascending. Core fields remain `announcement_datetime` and `release`; additive routing metadata may also be present.","operationId":"get_release_calendar_v1_calendar__currency__get","parameters":[{"name":"currency","in":"path","required":true,"schema":{"type":"string","description":"3-letter currency code (e.g., USD)","examples":["USD"],"title":"Currency","enum":["AUD","BRL","CAD","CHF","CNY","COMM","DKK","EUR","GBP","HKD","JPY","KRW","MXN","NOK","NZD","PLN","SEK","SGD","USD"],"example":"AUD"},"description":"3-letter currency code (e.g., USD) Allowed values: AUD, BRL, CAD, CHF, CNY, COMM, DKK, EUR, GBP, HKD, JPY, KRW, MXN, NOK, NZD, PLN, SEK, SGD, USD."},{"name":"indicator","in":"query","required":false,"schema":{"type":"string","description":"Filter by indicator name (e.g., gdp, inflation, unemployment)","examples":["inflation"],"title":"Indicator","enum":["average_hourly_earnings","balance_on_goods","balance_on_services","boc_business_outlook","breakeven_inflation_rate","broad_money","building_approvals","building_permits","business_confidence","business_sentiment","cb_assets","commodity_price_energy","commodity_price_ex_energy","commodity_price_index","commodity_prices","consumer_confidence","consumer_expectations","consumer_sentiment","core_inflation","core_inflation_median","core_inflation_mom","core_inflation_trim","core_pce","core_pce_mom","credit_growth","current_account_balance","deposit_rates","domestic_credit","durable_goods_orders","employment","exports","foreign_reserves","full_time_employment","fx_reserves","gdp","gdp_quarterly","gold_reserves","gov_bond_10y","gov_bond_1y","gov_bond_20y","gov_bond_2y","gov_bond_30y","gov_bond_3y","gov_bond_40y","gov_bond_4y","gov_bond_5y","gov_bond_7y","government_debt","house_price_index","household_credit","housing_starts","imports","industrial_production","inflation","inflation_expectations","inflation_linked_bond","inflation_mom","initial_jobless_claims","job_openings","kof_barometer","m1","m2","m3","money_supply_currency","money_supply_savings_deposits","money_supply_term_deposits","money_supply_transaction_deposits","monthly_cpi","mortgage_rate","nairu","nmi","non_farm_payrolls","part_time_employment","participation_rate","pmi","policy_rate","ppi","ppi_mom","private_sector_credit","real_exchange_rate","retail_sales","risk_free_rate","sight_deposits","snb_balance_sheet","tankan_capex","terms_of_trade","trade_balance","trade_weighted_index","trimmed_mean_inflation","unemployment","wage_price_index","wages"],"example":"average_hourly_earnings"},"description":"Filter by indicator name (e.g., gdp, inflation, unemployment) Allowed values: average_hourly_earnings, balance_on_goods, balance_on_services, boc_business_outlook, breakeven_inflation_rate, broad_money, building_approvals, building_permits, business_confidence, business_sentiment, cb_assets, commodity_price_energy, commodity_price_ex_energy, commodity_price_index, commodity_prices, consumer_confidence, consumer_expectations, consumer_sentiment, core_inflation, core_inflation_median, core_inflation_mom, core_inflation_trim, core_pce, core_pce_mom, credit_growth, current_account_balance, deposit_rates, domestic_credit, durable_goods_orders, employment, exports, foreign_reserves, full_time_employment, fx_reserves, gdp, gdp_quarterly, gold_reserves, gov_bond_10y, gov_bond_1y, gov_bond_20y, gov_bond_2y, gov_bond_30y, gov_bond_3y, gov_bond_40y, gov_bond_4y, gov_bond_5y, gov_bond_7y, government_debt, house_price_index, household_credit, housing_starts, imports, industrial_production, inflation, inflation_expectations, inflation_linked_bond, inflation_mom, initial_jobless_claims, job_openings, kof_barometer, m1, m2, m3, money_supply_currency, money_supply_savings_deposits, money_supply_term_deposits, money_supply_transaction_deposits, monthly_cpi, mortgage_rate, nairu, nmi, non_farm_payrolls, part_time_employment, participation_rate, pmi, policy_rate, ppi, ppi_mom, private_sector_credit, real_exchange_rate, retail_sales, risk_free_rate, sight_deposits, snb_balance_sheet, tankan_capex, terms_of_trade, trade_balance, trade_weighted_index, trimmed_mean_inflation, unemployment, wage_price_index, wages."}],"responses":{"200":{"description":"Upcoming release dates for the selected currency and optional indicator filter.","content":{"application/json":{"schema":{},"example":{"currency":"USD","indicator":"inflation","data":[{"announcement_datetime":1773077400,"release":"inflation"},{"announcement_datetime":1773682200,"release":"non_farm_payrolls"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-parameter-availability":{"currency":["AUD","BRL","CAD","CHF","CNY","COMM","DKK","EUR","GBP","HKD","JPY","KRW","MXN","NOK","NZD","PLN","SEK","SGD","USD"],"indicator":["average_hourly_earnings","balance_on_goods","balance_on_services","boc_business_outlook","breakeven_inflation_rate","broad_money","building_approvals","building_permits","business_confidence","business_sentiment","cb_assets","commodity_price_energy","commodity_price_ex_energy","commodity_price_index","commodity_prices","consumer_confidence","consumer_expectations","consumer_sentiment","core_inflation","core_inflation_median","core_inflation_mom","core_inflation_trim","core_pce","core_pce_mom","credit_growth","current_account_balance","deposit_rates","domestic_credit","durable_goods_orders","employment","exports","foreign_reserves","full_time_employment","fx_reserves","gdp","gdp_quarterly","gold_reserves","gov_bond_10y","gov_bond_1y","gov_bond_20y","gov_bond_2y","gov_bond_30y","gov_bond_3y","gov_bond_40y","gov_bond_4y","gov_bond_5y","gov_bond_7y","government_debt","house_price_index","household_credit","housing_starts","imports","industrial_production","inflation","inflation_expectations","inflation_linked_bond","inflation_mom","initial_jobless_claims","job_openings","kof_barometer","m1","m2","m3","money_supply_currency","money_supply_savings_deposits","money_supply_term_deposits","money_supply_transaction_deposits","monthly_cpi","mortgage_rate","nairu","nmi","non_farm_payrolls","part_time_employment","participation_rate","pmi","policy_rate","ppi","ppi_mom","private_sector_credit","real_exchange_rate","retail_sales","risk_free_rate","sight_deposits","snb_balance_sheet","tankan_capex","terms_of_trade","trade_balance","trade_weighted_index","trimmed_mean_inflation","unemployment","wage_price_index","wages"]}}},"/v1/announcements/{currency}/{indicator}":{"get":{"tags":["statistics_releases"],"summary":"Get macroeconomic indicator data","description":"Fetches historical data for a given macroeconomic indicator of a currency.\n\n**Path Parameters:**\n- `currency`: The 3-letter currency code (USD, AUD, EUR, GBP, CHF).\n- `indicator`: The indicator name (e.g., inflation, unemployment).\n\n**Query Parameters:**\n- `start_date`: Optional. Start date in YYYY-MM-DD format. Defaults to 12 months for monthly indicators, 18 months for quarterly (to ensure 4 quarters).\n- `end_date`: Optional. End date in YYYY-MM-DD format. Defaults to today.\n\n**Response fields:**\n- `has_official_forecast`: Whether the relevant central bank or statistics agency publishes a preliminary, flash, or advance estimate of this indicator before the main/final data release.","operationId":"get_indicator_data_v1_announcements__currency___indicator__get","parameters":[{"name":"currency","in":"path","required":true,"schema":{"type":"string","title":"Currency","enum":["AUD","BRL","CAD","CHF","CNY","DKK","EUR","GBP","JPY","NZD","PLN","SEK","SGD","USD"],"example":"AUD"},"description":"Allowed values: AUD, BRL, CAD, CHF, CNY, DKK, EUR, GBP, JPY, NZD, PLN, SEK, SGD, USD."},{"name":"indicator","in":"path","required":true,"schema":{"type":"string","description":"Indicator slug","examples":["inflation"],"title":"Indicator","enum":["average_hourly_earnings","balance_on_goods","balance_on_services","boc_business_outlook","breakeven_inflation_rate","broad_money","building_approvals","building_permits","business_confidence","business_sentiment","cb_assets","commodity_price_energy","commodity_price_ex_energy","commodity_price_index","commodity_prices","consumer_confidence","consumer_expectations","consumer_sentiment","core_inflation","core_inflation_median","core_inflation_mom","core_inflation_trim","core_pce","core_pce_mom","credit_growth","current_account_balance","deposit_rates","domestic_credit","durable_goods_orders","employment","exports","foreign_reserves","full_time_employment","fx_reserves","gdp","gdp_quarterly","gold_reserves","gov_bond_10y","gov_bond_1y","gov_bond_20y","gov_bond_2y","gov_bond_30y","gov_bond_3y","gov_bond_40y","gov_bond_4y","gov_bond_5y","gov_bond_7y","government_debt","house_price_index","household_credit","housing_starts","imports","industrial_production","inflation","inflation_expectations","inflation_linked_bond","inflation_mom","initial_jobless_claims","job_openings","kof_barometer","m1","m2","m3","money_supply_currency","money_supply_savings_deposits","money_supply_term_deposits","money_supply_transaction_deposits","monthly_cpi","mortgage_rate","nairu","nmi","non_farm_payrolls","part_time_employment","participation_rate","pmi","policy_rate","ppi","ppi_mom","private_sector_credit","real_exchange_rate","retail_sales","risk_free_rate","sight_deposits","snb_balance_sheet","tankan_capex","terms_of_trade","trade_balance","trade_weighted_index","trimmed_mean_inflation","unemployment","wage_price_index","wages"],"example":"average_hourly_earnings"},"description":"Indicator slug Allowed values: average_hourly_earnings, balance_on_goods, balance_on_services, boc_business_outlook, breakeven_inflation_rate, broad_money, building_approvals, building_permits, business_confidence, business_sentiment, cb_assets, commodity_price_energy, commodity_price_ex_energy, commodity_price_index, commodity_prices, consumer_confidence, consumer_expectations, consumer_sentiment, core_inflation, core_inflation_median, core_inflation_mom, core_inflation_trim, core_pce, core_pce_mom, credit_growth, current_account_balance, deposit_rates, domestic_credit, durable_goods_orders, employment, exports, foreign_reserves, full_time_employment, fx_reserves, gdp, gdp_quarterly, gold_reserves, gov_bond_10y, gov_bond_1y, gov_bond_20y, gov_bond_2y, gov_bond_30y, gov_bond_3y, gov_bond_40y, gov_bond_4y, gov_bond_5y, gov_bond_7y, government_debt, house_price_index, household_credit, housing_starts, imports, industrial_production, inflation, inflation_expectations, inflation_linked_bond, inflation_mom, initial_jobless_claims, job_openings, kof_barometer, m1, m2, m3, money_supply_currency, money_supply_savings_deposits, money_supply_term_deposits, money_supply_transaction_deposits, monthly_cpi, mortgage_rate, nairu, nmi, non_farm_payrolls, part_time_employment, participation_rate, pmi, policy_rate, ppi, ppi_mom, private_sector_credit, real_exchange_rate, retail_sales, risk_free_rate, sight_deposits, snb_balance_sheet, tankan_capex, terms_of_trade, trade_balance, trade_weighted_index, trimmed_mean_inflation, unemployment, wage_price_index, wages."},{"name":"start_date","in":"query","required":false,"schema":{"type":"string","description":"Start date YYYY-MM-DD","examples":["2025-01-01"],"title":"Start Date"},"description":"Start date YYYY-MM-DD"},{"name":"end_date","in":"query","required":false,"schema":{"type":"string","description":"End date YYYY-MM-DD","examples":["2026-03-01"],"title":"End Date"},"description":"End date YYYY-MM-DD"},{"name":"api_key","in":"query","required":false,"schema":{"type":"string","description":"Your Professional API key","title":"Api Key"},"description":"Your Professional API key"},{"name":"X-Dashboard-Secret","in":"header","required":false,"schema":{"type":"string","title":"X-Dashboard-Secret"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Normalized macro series for one currency and indicator.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementResponse"},"example":{"currency":"USD","indicator":"inflation","has_official_forecast":false,"start_date":"2025-01-01","end_date":"2026-03-01","cb_target":{"description":"Federal Reserve PCE inflation target","source":"Federal Reserve Statement on Longer-Run Goals and Monetary Policy Strategy","current":{"effective_from":"2020-08-27","target":2.0,"notes":"Flexible Average Inflation Targeting (FAIT) adopted"},"history":[{"effective_from":"2012-01-25","target":2.0,"notes":"First explicit 2% PCE inflation target announced by FOMC"},{"effective_from":"2020-08-27","target":2.0,"notes":"Flexible Average Inflation Targeting (FAIT) adopted"}]},"data":[{"date":"2026-01-31","val":2.9,"announcement_datetime":1769754600,"pct_change":0.2},{"date":"2026-02-28","val":3.0,"announcement_datetime":1772433000,"pct_change":0.1}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-parameter-availability":{"currency":["AUD","BRL","CAD","CHF","CNY","DKK","EUR","GBP","JPY","NZD","PLN","SEK","SGD","USD"],"indicator":["average_hourly_earnings","balance_on_goods","balance_on_services","boc_business_outlook","breakeven_inflation_rate","broad_money","building_approvals","building_permits","business_confidence","business_sentiment","cb_assets","commodity_price_energy","commodity_price_ex_energy","commodity_price_index","commodity_prices","consumer_confidence","consumer_expectations","consumer_sentiment","core_inflation","core_inflation_median","core_inflation_mom","core_inflation_trim","core_pce","core_pce_mom","credit_growth","current_account_balance","deposit_rates","domestic_credit","durable_goods_orders","employment","exports","foreign_reserves","full_time_employment","fx_reserves","gdp","gdp_quarterly","gold_reserves","gov_bond_10y","gov_bond_1y","gov_bond_20y","gov_bond_2y","gov_bond_30y","gov_bond_3y","gov_bond_40y","gov_bond_4y","gov_bond_5y","gov_bond_7y","government_debt","house_price_index","household_credit","housing_starts","imports","industrial_production","inflation","inflation_expectations","inflation_linked_bond","inflation_mom","initial_jobless_claims","job_openings","kof_barometer","m1","m2","m3","money_supply_currency","money_supply_savings_deposits","money_supply_term_deposits","money_supply_transaction_deposits","monthly_cpi","mortgage_rate","nairu","nmi","non_farm_payrolls","part_time_employment","participation_rate","pmi","policy_rate","ppi","ppi_mom","private_sector_credit","real_exchange_rate","retail_sales","risk_free_rate","sight_deposits","snb_balance_sheet","tankan_capex","terms_of_trade","trade_balance","trade_weighted_index","trimmed_mean_inflation","unemployment","wage_price_index","wages"],"indicator_by_currency":{"AUD":["broad_money","building_approvals","cb_assets","commodity_prices","core_inflation","credit_growth","current_account_balance","employment","exports","foreign_reserves","full_time_employment","gdp","gold_reserves","gov_bond_10y","gov_bond_2y","gov_bond_3y","gov_bond_5y","house_price_index","imports","inflation","inflation_expectations","inflation_linked_bond","m1","m2","m3","monthly_cpi","mortgage_rate","part_time_employment","participation_rate","policy_rate","ppi","real_exchange_rate","retail_sales","risk_free_rate","terms_of_trade","trade_balance","trade_weighted_index","trimmed_mean_inflation","unemployment","wage_price_index","wages"],"BRL":["current_account_balance","gdp","inflation","inflation_mom","m1","m2","m3","policy_rate","risk_free_rate","trade_balance","trade_weighted_index","unemployment"],"CAD":["boc_business_outlook","building_permits","business_confidence","business_sentiment","commodity_price_energy","commodity_price_ex_energy","commodity_price_index","consumer_confidence","consumer_expectations","consumer_sentiment","core_inflation","core_inflation_median","core_inflation_trim","current_account_balance","employment","full_time_employment","gdp","gdp_quarterly","gov_bond_10y","gov_bond_2y","gov_bond_30y","gov_bond_3y","gov_bond_5y","gov_bond_7y","household_credit","housing_starts","inflation","inflation_linked_bond","inflation_mom","m1","m2","m3","part_time_employment","participation_rate","policy_rate","ppi","retail_sales","risk_free_rate","trade_balance","trade_weighted_index","unemployment"],"CHF":["broad_money","business_sentiment","cb_assets","consumer_confidence","consumer_sentiment","core_inflation","current_account_balance","employment","exports","foreign_reserves","full_time_employment","fx_reserves","gdp","gold_reserves","gov_bond_10y","gov_bond_1y","gov_bond_20y","gov_bond_2y","gov_bond_30y","gov_bond_3y","gov_bond_4y","gov_bond_5y","imports","inflation","inflation_expectations","kof_barometer","m1","m2","m3","part_time_employment","participation_rate","policy_rate","ppi","retail_sales","risk_free_rate","sight_deposits","snb_balance_sheet","trade_balance","trade_weighted_index","unemployment"],"CNY":["business_confidence","business_sentiment","cb_assets","consumer_confidence","consumer_sentiment","core_inflation","foreign_reserves","gdp","gold_reserves","gov_bond_10y","gov_bond_2y","gov_bond_3y","gov_bond_5y","inflation","m1","m2","policy_rate","ppi","retail_sales","risk_free_rate","trade_balance","trade_weighted_index","unemployment"],"DKK":["gdp","gov_bond_10y","inflation","inflation_mom","policy_rate","trade_balance","trade_weighted_index","unemployment"],"EUR":["balance_on_goods","balance_on_services","breakeven_inflation_rate","core_inflation","core_inflation_mom","current_account_balance","employment","full_time_employment","gdp","gov_bond_10y","gov_bond_2y","gov_bond_3y","gov_bond_5y","inflation","inflation_linked_bond","inflation_mom","m1","m2","m3","part_time_employment","participation_rate","policy_rate","ppi","ppi_mom","retail_sales","risk_free_rate","trade_balance","trade_weighted_index","unemployment"],"GBP":["broad_money","core_inflation","current_account_balance","employment","exports","full_time_employment","gdp","gov_bond_10y","gov_bond_20y","gov_bond_2y","gov_bond_3y","gov_bond_5y","imports","inflation","inflation_linked_bond","inflation_mom","m1","m2","m3","part_time_employment","participation_rate","policy_rate","ppi","retail_sales","risk_free_rate","trade_balance","trade_weighted_index","unemployment","wages"],"JPY":["cb_assets","consumer_confidence","consumer_sentiment","core_inflation","current_account_balance","employment","foreign_reserves","full_time_employment","gdp","gov_bond_10y","gov_bond_20y","gov_bond_2y","gov_bond_30y","gov_bond_3y","gov_bond_40y","gov_bond_5y","gov_bond_7y","housing_starts","inflation","m1","m2","m3","part_time_employment","participation_rate","policy_rate","ppi","retail_sales","risk_free_rate","tankan_capex","trade_balance","trade_weighted_index","unemployment"],"NZD":["cb_assets","core_inflation","current_account_balance","deposit_rates","domestic_credit","employment","foreign_reserves","full_time_employment","gdp","gov_bond_10y","gov_bond_2y","gov_bond_3y","gov_bond_5y","inflation","inflation_linked_bond","m1","m2","m3","money_supply_currency","money_supply_savings_deposits","money_supply_term_deposits","money_supply_transaction_deposits","part_time_employment","participation_rate","policy_rate","ppi","private_sector_credit","retail_sales","risk_free_rate","trade_balance","trade_weighted_index","unemployment"],"PLN":["gdp","inflation","inflation_mom","trade_weighted_index","unemployment"],"SEK":["gov_bond_10y","gov_bond_2y","gov_bond_5y","policy_rate","risk_free_rate","trade_weighted_index"],"SGD":["trade_weighted_index"],"USD":["average_hourly_earnings","breakeven_inflation_rate","building_permits","business_sentiment","cb_assets","consumer_sentiment","core_inflation","core_inflation_mom","core_pce","core_pce_mom","current_account_balance","durable_goods_orders","employment","foreign_reserves","full_time_employment","gdp","gold_reserves","gov_bond_10y","gov_bond_2y","gov_bond_3y","gov_bond_5y","government_debt","house_price_index","housing_starts","industrial_production","inflation","inflation_linked_bond","inflation_mom","initial_jobless_claims","job_openings","m1","m2","m3","nairu","nmi","non_farm_payrolls","part_time_employment","participation_rate","pmi","policy_rate","ppi","ppi_mom","retail_sales","risk_free_rate","trade_balance","trade_weighted_index","unemployment"]}}}},"/v1/cot/{currency}":{"get":{"tags":["fx_markets"],"summary":"Get CFTC Commitment of Traders (COT) data","description":"Returns weekly CFTC Legacy Futures-Only COT report data for the specified currency's FX futures contract.\n\n**Supported currencies:** AUD, CAD, CHF, EUR, GBP, JPY, NZD, USD\n\n**Path Parameters:**\n- `currency`: 3-letter currency code (e.g., EUR, GBP, JPY).\n\n**Query Parameters:**\n- `start_date`: Optional. Start date YYYY-MM-DD. Defaults to 52 weeks ago.\n- `end_date`: Optional. End date YYYY-MM-DD. Defaults to today.\n\n**Authentication:** USD data is publicly available. All other currencies require a professional API key supplied via `?api_key=<key>` or the `X-API-Key` header.\n\n**Data source:** CFTC public API — https://publicreporting.cftc.gov/resource/6dca-aqww.json","operationId":"get_cot_data_v1_cot__currency__get","parameters":[{"name":"currency","in":"path","required":true,"schema":{"type":"string","title":"Currency","enum":["AUD","CAD","CHF","EUR","GBP","JPY","NZD","USD"],"example":"AUD"},"description":"Allowed values: AUD, CAD, CHF, EUR, GBP, JPY, NZD, USD."},{"name":"start_date","in":"query","required":false,"schema":{"type":"string","description":"Start date YYYY-MM-DD","examples":["2025-09-01"],"title":"Start Date"},"description":"Start date YYYY-MM-DD"},{"name":"end_date","in":"query","required":false,"schema":{"type":"string","description":"End date YYYY-MM-DD","examples":["2026-03-01"],"title":"End Date"},"description":"End date YYYY-MM-DD"},{"name":"api_key","in":"query","required":false,"schema":{"type":"string","description":"Your Professional API key","title":"Api Key"},"description":"Your Professional API key"},{"name":"X-Dashboard-Secret","in":"header","required":false,"schema":{"type":"string","title":"X-Dashboard-Secret"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"COT report history for the selected futures market.","content":{"application/json":{"schema":{},"example":{"currency":"JPY","instrument":"JAPANESE YEN - CHICAGO MERCANTILE EXCHANGE","fx_overlay":{"pair":"USD/JPY"},"start_date":"2025-09-01","end_date":"2026-03-01","data":[{"date":"2026-02-24","announcement_datetime":1771996800,"open_interest":245678,"noncommercial_long":62400,"noncommercial_short":70420,"noncommercial_net":-8020}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-parameter-availability":{"currency":["AUD","CAD","CHF","EUR","GBP","JPY","NZD","USD"]}}},"/v1/commodities/{indicator}":{"get":{"tags":["commodities"],"summary":"Get commodity indicator data","description":"Returns a time-series of precious metals price data from official sources.\n\n**Supported indicators:** `gold`, `silver`, `platinum`.\n\n**Precious metals** — sourced from The Royal Mint public chart API (https://www.royalmint.com/). No API key required.\n\n- **Gold** (`gold`): LBMA PM Fix, USD/troy oz.\n- **Silver** (`silver`): LBMA Silver Fix, USD/troy oz.\n- **Platinum** (`platinum`): Spot price, USD/troy oz.\n\n**Query Parameters:**\n- `start_date`: Earliest date to include (YYYY-MM-DD). Defaults to 365 days ago.\n- `end_date`: Latest date to include (YYYY-MM-DD). Defaults to today.\n\n**Authentication:** A professional API key is required. Supply it via `?api_key=<key>` or the `X-API-Key` header.","operationId":"get_commodity_indicator_data_v1_commodities__indicator__get","parameters":[{"name":"indicator","in":"path","required":true,"schema":{"type":"string","description":"Commodity indicator slug","examples":["gold"],"title":"Indicator","enum":["gold","platinum","silver"],"example":"gold"},"description":"Commodity indicator slug Allowed values: gold, platinum, silver."},{"name":"start_date","in":"query","required":false,"schema":{"type":"string","description":"Start date YYYY-MM-DD","examples":["2025-01-01"],"title":"Start Date"},"description":"Start date YYYY-MM-DD"},{"name":"end_date","in":"query","required":false,"schema":{"type":"string","description":"End date YYYY-MM-DD","examples":["2026-03-01"],"title":"End Date"},"description":"End date YYYY-MM-DD"},{"name":"api_key","in":"query","required":false,"schema":{"type":"string","description":"Your Professional API key","title":"Api Key"},"description":"Your Professional API key"},{"name":"X-Dashboard-Secret","in":"header","required":false,"schema":{"type":"string","title":"X-Dashboard-Secret"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Time-series data for the requested commodity indicator.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommodityResponse"},"example":{"currency":"COMM","indicator":"gold","has_official_forecast":false,"start_date":"2025-03-15","end_date":"2026-03-15","data":[{"date":"2026-01-31","val":2835.5,"pct_change":1.8,"pct_change_12m":28.5},{"date":"2026-02-28","val":2870.0,"pct_change":1.2,"pct_change_12m":30.1}]}}}},"404":{"description":"Unsupported commodity indicator.","content":{"application/json":{"example":{"detail":"Unsupported commodity indicator (xyz)"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-parameter-availability":{"indicator":["gold","platinum","silver"]}}},"/v1/graphql":{"get":{"summary":"Handle Http Get","operationId":"handle_http_get_v1_graphql_get","responses":{"200":{"description":"The GraphiQL integrated development environment.","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found if GraphiQL or query via GET are not enabled."}}},"post":{"summary":"Handle Http Post","operationId":"handle_http_post_v1_graphql_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/mcp":{"post":{"tags":["mcp"],"summary":"FXMacroData MCP endpoint","description":"Streamable HTTP endpoint for the FXMacroData MCP server. Use this path for MCP tool execution and resource access.","responses":{"200":{"description":"MCP response stream or tool result."}}}}},"components":{"schemas":{"AnnouncementDataPoint":{"properties":{"date":{"type":"string","title":"Date"},"val":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Val"},"announcement_datetime":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Announcement Datetime"},"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pct Change"},"pct_change_12m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pct Change 12M"}},"additionalProperties":true,"type":"object","required":["date"],"title":"AnnouncementDataPoint"},"AnnouncementResponse":{"properties":{"currency":{"type":"string","title":"Currency"},"indicator":{"type":"string","title":"Indicator"},"has_official_forecast":{"type":"boolean","title":"Has Official Forecast"},"start_date":{"type":"string","title":"Start Date"},"end_date":{"type":"string","title":"End Date"},"cb_target":{"anyOf":[{"$ref":"#/components/schemas/CBTargetInfo"},{"type":"null"}]},"data":{"items":{"$ref":"#/components/schemas/AnnouncementDataPoint"},"type":"array","title":"Data"}},"type":"object","required":["currency","indicator","has_official_forecast","start_date","end_date","data"],"title":"AnnouncementResponse"},"Body_oauth_token_oauth_token_post":{"properties":{"grant_type":{"type":"string","title":"Grant Type","examples":["authorization_code"]},"code":{"type":"string","title":"Code","examples":["auth_code_from_authorize_endpoint"]},"redirect_uri":{"type":"string","title":"Redirect Uri","examples":["https://claude.ai/api/mcp/auth_callback"]},"client_id":{"type":"string","title":"Client Id","examples":["claude-connector"]},"code_verifier":{"type":"string","title":"Code Verifier","examples":["pkce-verifier-value"]}},"type":"object","required":["grant_type","code","redirect_uri","client_id"],"title":"Body_oauth_token_oauth_token_post"},"CBTargetEntry":{"properties":{"effective_from":{"type":"string","title":"Effective From"},"target":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Target"},"lower":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower"},"upper":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["effective_from"],"title":"CBTargetEntry","description":"A single central-bank target entry valid from ``effective_from``."},"CBTargetInfo":{"properties":{"description":{"type":"string","title":"Description"},"source":{"type":"string","title":"Source"},"current":{"$ref":"#/components/schemas/CBTargetEntry"},"history":{"items":{"$ref":"#/components/schemas/CBTargetEntry"},"type":"array","title":"History"}},"type":"object","required":["description","source","current","history"],"title":"CBTargetInfo","description":"Central-bank target metadata for an indicator.\n\n``current`` is the entry effective as of the response ``end_date``.\n``history`` contains every known target regime in ascending date order."},"CommodityDataPoint":{"properties":{"date":{"type":"string","title":"Date"},"val":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Val"},"announcement_datetime":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Announcement Datetime"},"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pct Change"},"pct_change_12m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pct Change 12M"}},"additionalProperties":true,"type":"object","required":["date"],"title":"CommodityDataPoint"},"CommodityResponse":{"properties":{"currency":{"type":"string","title":"Currency"},"indicator":{"type":"string","title":"Indicator"},"has_official_forecast":{"type":"boolean","title":"Has Official Forecast"},"start_date":{"type":"string","title":"Start Date"},"end_date":{"type":"string","title":"End Date"},"data":{"items":{"$ref":"#/components/schemas/CommodityDataPoint"},"type":"array","title":"Data"}},"type":"object","required":["currency","indicator","has_official_forecast","start_date","end_date","data"],"title":"CommodityResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"tags":[{"name":"statistics_releases","description":"Primary product: macroeconomic release-series from announcements."},{"name":"calendar","description":"Standalone economic and policy release calendar endpoint spanning statistics releases and central-bank decision timing."},{"name":"commodities","description":"Commodity and energy datasets, including OPEC and planned commodity price endpoints."},{"name":"fx_markets","description":"FX market-state datasets including spot FX, market sessions, risk sentiment, and COT positioning."},{"name":"data_catalogue","description":"Cross-domain metadata index for available indicators."},{"name":"mcp","description":"Model Context Protocol endpoint for FXMacroData tools and resources."}],"servers":[{"url":"/api"}]}