openapi: 3.2.0 info: title: FX Macrodata Settlement API description: Official-source macroeconomic indicators, release calendars, central-bank policy rates, FX reference rates, COT positioning and commodities across 22 currencies. USD data is available without an API key; other currencies and datasets need an `X-API-Key` header. version: 1.0.0 servers: - url: https://api.fxmacrodata.com description: FXMacroData API security: - {} - APIKeyHeader: [] - HTTPBearer: [] tags: - name: Settlement description: 'Settlement records for event contracts on official macro releases: first-print value, latest value, release timing (scheduled, actual release window, ingested, latency from the actual release) and the contract outcome for a strike, with an Ed25519 attestation.' paths: /v1/settlement/contracts: get: tags: - Settlement summary: Contract templates for settling event contracts on official releases operationId: list_settlement_contracts_v1_settlement_contracts_get responses: '200': description: Successful Response content: application/json: schema: additionalProperties: true type: object title: Response List Settlement Contracts V1 Settlement Contracts Get /v1/settlement/keys: get: tags: - Settlement summary: Public keys that verify signed settlement records operationId: settlement_keys_v1_settlement_keys_get responses: '200': description: Successful Response content: application/json: schema: additionalProperties: true type: object title: Response Settlement Keys V1 Settlement Keys Get /v1/settlement/contracts/{contract_id}: get: tags: - Settlement summary: Settle a contract template for one release operationId: settle_contract_v1_settlement_contracts__contract_id__get parameters: - name: contract_id in: path required: true schema: type: string examples: - usd_cpi_yoy title: Contract Id enum: - aud_rba_decision - cad_boc_decision - eur_ecb_decision - eur_hicp_flash_yoy - gbp_boe_decision - gbp_cpi_yoy - jpy_boj_decision - usd_core_cpi_mom - usd_core_cpi_yoy - usd_core_pce_mom - usd_cpi_mom - usd_cpi_yoy - usd_fed_decision - usd_gdp_advance_qoq_saar - usd_initial_jobless_claims - usd_nonfarm_payrolls_change - usd_pce_yoy - usd_unemployment_rate example: aud_rba_decision description: 'Required path parameter. Allowed values: aud_rba_decision, cad_boc_decision, eur_ecb_decision, eur_hicp_flash_yoy, gbp_boe_decision, gbp_cpi_yoy, jpy_boj_decision, usd_core_cpi_mom, usd_core_cpi_yoy, usd_core_pce_mom, usd_cpi_mom, usd_cpi_yoy, usd_fed_decision, usd_gdp_advance_qoq_saar, usd_initial_jobless_claims, usd_nonfarm_payrolls_change, usd_pce_yoy, usd_unemployment_rate.' - name: period in: query required: false schema: type: string description: Reference date of the release (YYYY-MM-DD), or `latest`. examples: - '2026-09-30' default: latest title: Period description: Optional query parameter. Reference date of the release (YYYY-MM-DD), or `latest`. - name: strike in: query required: false schema: anyOf: - type: number - type: 'null' description: Contract strike in the series unit. title: Strike description: Optional query parameter. Contract strike in the series unit. - name: comparison in: query required: false schema: enum: - above - at_or_above - below - at_or_below - equal type: string description: How the published value is compared with the strike. default: above title: Comparison description: Optional query parameter. How the published value is compared with the strike. - name: currency in: query required: true schema: type: string title: Currency description: Required query parameter. - name: api_key in: query required: false schema: type: string description: Your Individual or Business API key title: Api Key description: 'Deprecated: legacy query-string API key. Still accepted so existing integrations keep working, but new integrations must send the key in the X-API-Key header (or Authorization: Bearer). A key is required for non-USD, paid-only, or full-history requests. Responses to requests authenticated this way carry a Deprecation header.' deprecated: true responses: '200': description: Successful Response content: application/json: schema: type: object additionalProperties: true title: Response Settle Contract V1 Settlement Contracts Contract Id Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-parameter-availability: contract_id: - aud_rba_decision - cad_boc_decision - eur_ecb_decision - eur_hicp_flash_yoy - gbp_boe_decision - gbp_cpi_yoy - jpy_boj_decision - usd_core_cpi_mom - usd_core_cpi_yoy - usd_core_pce_mom - usd_cpi_mom - usd_cpi_yoy - usd_fed_decision - usd_gdp_advance_qoq_saar - usd_initial_jobless_claims - usd_nonfarm_payrolls_change - usd_pce_yoy - usd_unemployment_rate /v1/settlement/{currency}/{indicator}: get: tags: - Settlement summary: Settlement record for one release of an announcement series operationId: settle_series_v1_settlement__currency___indicator__get parameters: - name: currency in: path required: true schema: type: string title: Currency enum: - AUD - BRL - CAD - CHF - CNH - CNY - DKK - EUR - GBP - HUF - ILS - JPY - KRW - MYR - NGN - NOK - NZD - PEN - SEK - THB - TWD - USD example: AUD description: 'Required path parameter. Allowed values: AUD, BRL, CAD, CHF, CNH, CNY, DKK, EUR, GBP, HUF, ILS, JPY, KRW, MYR, NGN, NOK, NZD, PEN, SEK, THB, TWD, USD.' - name: indicator in: path required: true schema: type: string examples: - non_farm_payrolls_change title: Indicator enum: - afe_dollar_index - average_hourly_earnings - average_hourly_earnings_mom - balance_on_goods - balance_on_services - bgcr - breakeven_inflation_rate - broad_dollar_index - broad_money - building_approvals - building_permits - business_confidence - capital_account_balance - cb_assets - commodity_price_energy - commodity_price_ex_energy - commodity_price_index - commodity_prices - consumer_confidence - core_inflation - core_inflation_median - core_inflation_mom - core_inflation_trim - core_pce - core_pce_mom - credit_growth - crude_oil_inventories - current_account_balance - dairy_exports - deposit_rates - durable_goods_orders - effr - eme_dollar_index - employment - exports - financial_account_balance - foreign_reserves - full_time_employment - fx_reserves - gdp - gdp_growth_q4_yoy - gold_reserves - gov_bond_10y - gov_bond_15y - gov_bond_1_5m - gov_bond_1m - gov_bond_1y - gov_bond_20y - gov_bond_25y - gov_bond_2m - gov_bond_2y - gov_bond_30y - gov_bond_3m - gov_bond_3y - gov_bond_40y - gov_bond_4m - gov_bond_4y - gov_bond_5y - gov_bond_6m - gov_bond_6y - gov_bond_7y - gov_bond_8y - gov_bond_9y - government_debt - house_price_index - house_prices - household_credit - household_spending - housing_starts - import_prices - imports - industrial_production - inflation - inflation_linked_bond - inflation_mom - initial_jobless_claims - international_assets - international_liabilities - job_openings - m1 - m2 - m3 - nairu - natural_gas_storage - net_foreign_asset_position - non_farm_payrolls - non_farm_payrolls_change - obfr - part_time_employment - participation_rate - pce - pce_mom - policy_rate - policy_rate_midpoint - policy_rate_mlf - policy_rate_mro - policy_rate_target_lower - ppi - primary_income_balance - productivity - real_yield_20y - real_yield_30y - real_yield_5y - real_yield_7y - retail_sales - retail_sales_control_group - retail_sales_ex_autos - retail_sales_ex_autos_and_gas - risk_free_rate - secondary_income_balance - sight_deposits - snb_balance_sheet - sofr_average_180d - sofr_average_30d - sofr_average_90d - sofr_index - terms_of_trade - tgcr - trade_balance - trade_weighted_index - trimmed_mean_inflation - unemployment - wage_price_index - wages example: afe_dollar_index description: 'Required path parameter. Allowed values: afe_dollar_index, average_hourly_earnings, average_hourly_earnings_mom, balance_on_goods, balance_on_services, bgcr, breakeven_inflation_rate, broad_dollar_index, broad_money, building_approvals, building_permits, business_confidence, capital_account_balance, cb_assets, commodity_price_energy, commodity_price_ex_energy, commodity_price_index, commodity_prices, consumer_confidence, core_inflation, core_inflation_median, core_inflation_mom, core_inflation_trim, core_pce, core_pce_mom, credit_growth, crude_oil_inventories, current_account_balance, dairy_exports, deposit_rates, durable_goods_orders, effr, eme_dollar_index, employment, exports, financial_account_balance, foreign_reserves, full_time_employment, fx_reserves, gdp, gdp_growth_q4_yoy, gold_reserves, gov_bond_10y, gov_bond_15y, gov_bond_1_5m, gov_bond_1m, gov_bond_1y, gov_bond_20y, gov_bond_25y, gov_bond_2m, gov_bond_2y, gov_bond_30y, gov_bond_3m, gov_bond_3y, gov_bond_40y, gov_bond_4m, gov_bond_4y, gov_bond_5y, gov_bond_6m, gov_bond_6y, gov_bond_7y, gov_bond_8y, gov_bond_9y, government_debt, house_price_index, house_prices, household_credit, household_spending, housing_starts, import_prices, imports, industrial_production, inflation, inflation_linked_bond, inflation_mom, initial_jobless_claims, international_assets, international_liabilities, job_openings, m1, m2, m3, nairu, natural_gas_storage, net_foreign_asset_position, non_farm_payrolls, non_farm_payrolls_change, obfr, part_time_employment, participation_rate, pce, pce_mom, policy_rate, policy_rate_midpoint, policy_rate_mlf, policy_rate_mro, policy_rate_target_lower, ppi, primary_income_balance, productivity, real_yield_20y, real_yield_30y, real_yield_5y, real_yield_7y, retail_sales, retail_sales_control_group, retail_sales_ex_autos, retail_sales_ex_autos_and_gas, risk_free_rate, secondary_income_balance, sight_deposits, snb_balance_sheet, sofr_average_180d, sofr_average_30d, sofr_average_90d, sofr_index, terms_of_trade, tgcr, trade_balance, trade_weighted_index, trimmed_mean_inflation, unemployment, wage_price_index, wages.' - name: period in: query required: false schema: anyOf: - type: string - type: 'null' description: Reference date of the release (YYYY-MM-DD), or `latest`. examples: - '2026-09-30' title: Period description: Optional query parameter. Reference date of the release (YYYY-MM-DD), or `latest`. - name: announcement_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Canonical announcement id, e.g. `usd_inflation_2026-09-30`. title: Announcement Id description: Optional query parameter. Canonical announcement id, e.g. `usd_inflation_2026-09-30`. - name: strike in: query required: false schema: anyOf: - type: number - type: 'null' description: Contract strike in the series unit. title: Strike description: Optional query parameter. Contract strike in the series unit. - name: comparison in: query required: false schema: enum: - above - at_or_above - below - at_or_below - equal type: string default: above title: Comparison description: Optional query parameter. - name: decimals in: query required: false schema: anyOf: - type: integer maximum: 6 minimum: 0 - type: 'null' description: Published precision used to evaluate the strike. Defaults to the contract template's. title: Decimals description: Optional query parameter. Published precision used to evaluate the strike. Defaults to the contract template's. - name: api_key in: query required: false schema: type: string description: Your Individual or Business API key title: Api Key description: 'Deprecated: legacy query-string API key. Still accepted so existing integrations keep working, but new integrations must send the key in the X-API-Key header (or Authorization: Bearer). A key is required for non-USD, paid-only, or full-history requests. Responses to requests authenticated this way carry a Deprecation header.' deprecated: true responses: '200': description: Successful Response content: application/json: schema: type: object additionalProperties: true title: Response Settle Series V1 Settlement Currency Indicator Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-parameter-availability: currency: - AUD - BRL - CAD - CHF - CNH - CNY - DKK - EUR - GBP - HUF - ILS - JPY - KRW - MYR - NGN - NOK - NZD - PEN - SEK - THB - TWD - USD indicator: - afe_dollar_index - average_hourly_earnings - average_hourly_earnings_mom - balance_on_goods - balance_on_services - bgcr - breakeven_inflation_rate - broad_dollar_index - broad_money - building_approvals - building_permits - business_confidence - capital_account_balance - cb_assets - commodity_price_energy - commodity_price_ex_energy - commodity_price_index - commodity_prices - consumer_confidence - core_inflation - core_inflation_median - core_inflation_mom - core_inflation_trim - core_pce - core_pce_mom - credit_growth - crude_oil_inventories - current_account_balance - dairy_exports - deposit_rates - durable_goods_orders - effr - eme_dollar_index - employment - exports - financial_account_balance - foreign_reserves - full_time_employment - fx_reserves - gdp - gdp_growth_q4_yoy - gold_reserves - gov_bond_10y - gov_bond_15y - gov_bond_1_5m - gov_bond_1m - gov_bond_1y - gov_bond_20y - gov_bond_25y - gov_bond_2m - gov_bond_2y - gov_bond_30y - gov_bond_3m - gov_bond_3y - gov_bond_40y - gov_bond_4m - gov_bond_4y - gov_bond_5y - gov_bond_6m - gov_bond_6y - gov_bond_7y - gov_bond_8y - gov_bond_9y - government_debt - house_price_index - house_prices - household_credit - household_spending - housing_starts - import_prices - imports - industrial_production - inflation - inflation_linked_bond - inflation_mom - initial_jobless_claims - international_assets - international_liabilities - job_openings - m1 - m2 - m3 - nairu - natural_gas_storage - net_foreign_asset_position - non_farm_payrolls - non_farm_payrolls_change - obfr - part_time_employment - participation_rate - pce - pce_mom - policy_rate - policy_rate_midpoint - policy_rate_mlf - policy_rate_mro - policy_rate_target_lower - ppi - primary_income_balance - productivity - real_yield_20y - real_yield_30y - real_yield_5y - real_yield_7y - retail_sales - retail_sales_control_group - retail_sales_ex_autos - retail_sales_ex_autos_and_gas - risk_free_rate - secondary_income_balance - sight_deposits - snb_balance_sheet - sofr_average_180d - sofr_average_30d - sofr_average_90d - sofr_index - terms_of_trade - tgcr - trade_balance - trade_weighted_index - trimmed_mean_inflation - unemployment - wage_price_index - wages indicator_by_currency: AUD: - balance_on_services - broad_money - building_approvals - capital_account_balance - cb_assets - commodity_prices - core_inflation - credit_growth - current_account_balance - employment - exports - financial_account_balance - foreign_reserves - full_time_employment - gdp - gold_reserves - gov_bond_10y - gov_bond_2y - gov_bond_3y - gov_bond_5y - house_price_index - household_spending - imports - inflation - inflation_linked_bond - inflation_mom - international_assets - international_liabilities - m1 - m3 - net_foreign_asset_position - part_time_employment - participation_rate - policy_rate - ppi - primary_income_balance - risk_free_rate - secondary_income_balance - terms_of_trade - trade_balance - trade_weighted_index - trimmed_mean_inflation - unemployment - wage_price_index - wages BRL: - foreign_reserves - gdp - inflation - inflation_mom - policy_rate - ppi - retail_sales - risk_free_rate - trade_weighted_index - unemployment CAD: - building_permits - business_confidence - commodity_price_energy - commodity_price_ex_energy - commodity_price_index - core_inflation - core_inflation_median - core_inflation_trim - current_account_balance - employment - full_time_employment - gdp - gov_bond_10y - gov_bond_2y - gov_bond_30y - gov_bond_3y - gov_bond_5y - gov_bond_7y - household_credit - inflation - inflation_linked_bond - part_time_employment - participation_rate - policy_rate - ppi - retail_sales - risk_free_rate - trade_balance - trade_weighted_index - unemployment - wages CHF: - broad_money - business_confidence - cb_assets - consumer_confidence - 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 - 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 CNH: - business_confidence - cb_assets - core_inflation - current_account_balance - gdp - gov_bond_10y - gov_bond_1y - gov_bond_2y - gov_bond_30y - gov_bond_3y - gov_bond_5y - gov_bond_7y - inflation - policy_rate - ppi - retail_sales - risk_free_rate - trade_weighted_index - unemployment CNY: - business_confidence - cb_assets - core_inflation - current_account_balance - foreign_reserves - gdp - gold_reserves - gov_bond_10y - gov_bond_1y - gov_bond_2y - gov_bond_30y - gov_bond_3y - gov_bond_5y - gov_bond_7y - inflation - m1 - m2 - policy_rate - ppi - retail_sales - risk_free_rate - trade_weighted_index - unemployment DKK: - business_confidence - consumer_confidence - core_inflation - current_account_balance - gdp - gov_bond_10y - house_prices - industrial_production - inflation - inflation_mom - ppi - risk_free_rate - trade_balance - trade_weighted_index - unemployment EUR: - balance_on_goods - balance_on_services - breakeven_inflation_rate - business_confidence - consumer_confidence - core_inflation - core_inflation_mom - current_account_balance - employment - full_time_employment - gdp - gov_bond_10y - gov_bond_1y - gov_bond_20y - gov_bond_2y - gov_bond_30y - gov_bond_3y - gov_bond_4y - gov_bond_5y - gov_bond_7y - inflation - inflation_linked_bond - inflation_mom - m1 - m2 - m3 - part_time_employment - participation_rate - policy_rate - policy_rate_mlf - policy_rate_mro - ppi - retail_sales - risk_free_rate - trade_balance - trade_weighted_index - unemployment - wages GBP: - broad_money - consumer_confidence - core_inflation - current_account_balance - employment - exports - full_time_employment - gdp - 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 - 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 HUF: - inflation - policy_rate - ppi - retail_sales - risk_free_rate - trade_weighted_index - wages ILS: - gdp - gov_bond_10y - gov_bond_2y - gov_bond_3y - gov_bond_5y - inflation - inflation_linked_bond - policy_rate - risk_free_rate - trade_weighted_index JPY: - business_confidence - consumer_confidence - core_inflation - current_account_balance - employment - foreign_reserves - full_time_employment - gdp - gold_reserves - gov_bond_10y - gov_bond_15y - gov_bond_1y - gov_bond_20y - gov_bond_25y - gov_bond_2y - gov_bond_30y - gov_bond_3y - gov_bond_40y - gov_bond_4y - gov_bond_5y - gov_bond_6y - gov_bond_7y - gov_bond_8y - gov_bond_9y - housing_starts - inflation - m1 - m2 - m3 - part_time_employment - participation_rate - policy_rate - ppi - retail_sales - risk_free_rate - trade_balance - trade_weighted_index - unemployment KRW: - business_confidence - consumer_confidence - core_inflation - current_account_balance - employment - gdp - gov_bond_10y - gov_bond_2y - gov_bond_3y - gov_bond_5y - house_price_index - household_credit - inflation - inflation_mom - m1 - m2 - participation_rate - policy_rate - ppi - retail_sales - risk_free_rate - trade_balance - unemployment MYR: - gov_bond_10y - gov_bond_2y - gov_bond_3y - gov_bond_5y - m1 - m2 - m3 - retail_sales NGN: - cb_assets - deposit_rates - foreign_reserves - policy_rate NOK: - business_confidence - core_inflation - current_account_balance - employment - exports - full_time_employment - gdp - gov_bond_10y - gov_bond_2y - gov_bond_3y - gov_bond_5y - gov_bond_7y - house_prices - imports - inflation - m1 - m2 - m3 - part_time_employment - participation_rate - policy_rate - ppi - retail_sales - risk_free_rate - trade_balance - trade_weighted_index - unemployment - wages NZD: - core_inflation - current_account_balance - dairy_exports - deposit_rates - employment - foreign_reserves - gdp - gov_bond_10y - gov_bond_1y - gov_bond_2y - gov_bond_5y - inflation - inflation_linked_bond - participation_rate - policy_rate - risk_free_rate - terms_of_trade - trade_balance - trade_weighted_index - unemployment - wages PEN: - foreign_reserves - gov_bond_10y - risk_free_rate - trade_weighted_index SEK: - employment - gdp - gov_bond_10y - gov_bond_2y - gov_bond_5y - gov_bond_7y - inflation - participation_rate - policy_rate - risk_free_rate - trade_balance - trade_weighted_index - unemployment THB: - core_inflation - current_account_balance - employment - gdp - gov_bond_10y - gov_bond_2y - gov_bond_3y - gov_bond_5y - inflation - m1 - m2 - participation_rate - policy_rate - ppi - trade_balance - unemployment TWD: - employment - foreign_reserves - participation_rate - risk_free_rate - trade_weighted_index - unemployment USD: - afe_dollar_index - average_hourly_earnings - average_hourly_earnings_mom - bgcr - breakeven_inflation_rate - broad_dollar_index - building_permits - business_confidence - cb_assets - consumer_confidence - core_inflation - core_inflation_mom - core_pce - core_pce_mom - crude_oil_inventories - current_account_balance - durable_goods_orders - effr - eme_dollar_index - employment - foreign_reserves - full_time_employment - gdp - gdp_growth_q4_yoy - gold_reserves - gov_bond_10y - gov_bond_1_5m - gov_bond_1m - gov_bond_1y - gov_bond_20y - gov_bond_2m - gov_bond_2y - gov_bond_30y - gov_bond_3m - gov_bond_3y - gov_bond_4m - gov_bond_5y - gov_bond_6m - gov_bond_7y - government_debt - house_price_index - housing_starts - import_prices - industrial_production - inflation - inflation_linked_bond - inflation_mom - initial_jobless_claims - job_openings - m1 - m2 - nairu - natural_gas_storage - non_farm_payrolls - non_farm_payrolls_change - obfr - part_time_employment - participation_rate - pce - pce_mom - policy_rate - policy_rate_midpoint - policy_rate_target_lower - ppi - productivity - real_yield_20y - real_yield_30y - real_yield_5y - real_yield_7y - retail_sales - retail_sales_control_group - retail_sales_ex_autos - retail_sales_ex_autos_and_gas - risk_free_rate - sofr_average_180d - sofr_average_30d - sofr_average_90d - sofr_index - tgcr - trade_balance - trade_weighted_index - unemployment - wages components: schemas: ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-Key description: 'FXMacroData API key. Preferred transport for server-side clients: the key stays out of URLs and access logs.' HTTPBearer: type: http scheme: bearer description: 'FXMacroData API key or OAuth access token supplied as ``Authorization: Bearer ``.' APIKeyQuery: type: apiKey in: query name: api_key x-deprecated: true description: 'Deprecated. FXMacroData API key as a query parameter. Still accepted so existing integrations keep working, but new integrations must use the X-API-Key header (APIKeyHeader) or Authorization: Bearer. The only exception is browser EventSource clients of the live-delivery streams, which cannot set request headers.'