settlement

Settle a contract template for one release

get/v1/settlement/contracts/{contract_id}

Request

  • Base URL: https://api.fxmacrodata.com
  • URL: https://api.fxmacrodata.com/v1/settlement/contracts/{contract_id}
  • Auth: one of:
    • none
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

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' required
Example:aud_rba_decision

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.

Query parameters

periodstring

Reference date of the release (YYYY-MM-DD), or latest.

Example:2026-09-30

Optional query parameter. Reference date of the release (YYYY-MM-DD), or latest.

strikenumber nullable

Contract strike in the series unit.

Optional query parameter. Contract strike in the series unit.

comparison'above' | 'at_or_above' | 'below' | 'at_or_below' | 'equal'

How the published value is compared with the strike.

Optional query parameter. How the published value is compared with the strike.

currencystring required

Required query parameter.

api_keystring

Your Individual or Business API key

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.

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.