calendar

Get the economic schedule known at a historical time

Selects the latest eligible version of each event at as_of before applying scheduled-date, importance and event-kind filters. Times are UTC; date-only events retain their publisher date without an invented UTC time. Includes explicit cancellations. Use the returned checkpoint and cursor on every subsequent page for a consistent export. Historical reconstruction is an explicit evidence-qualified mode. Coverage is reported separately at /v1/calendar/{currency}/coverage. Requires an active API key.

get/v1/calendar/{currency}/snapshot

Request

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

Path parameters

currency'AUD' | 'BRL' | 'CAD' | 'CHF' | 'CNH' | 'CNY' | 'COMM' | 'DKK' | 'EUR' | 'GBP' | 'HUF' | 'ILS' | 'JPY' | 'KRW' | 'MYR' | 'NGN' | 'NOK' | 'NZD' | 'PEN' | 'SEK' | 'THB' | 'TWD' | 'USD' required
Example:AUD

Required path parameter. Allowed values: AUD, BRL, CAD, CHF, CNH, CNY, COMM, DKK, EUR, GBP, HUF, ILS, JPY, KRW, MYR, NGN, NOK, NZD, PEN, SEK, THB, TWD, USD.

Query parameters

as_ofstring date-time required

Knowledge cutoff, ISO 8601 with UTC offset.

Required query parameter. Knowledge cutoff, ISO 8601 with UTC offset.

start_datestring date nullable

Optional query parameter.

end_datestring date nullable

Optional query parameter.

importance'high' | 'medium' | 'low' | 'unknown' nullable

Optional query parameter.

event_kind'release' | 'speech' | 'meeting' | 'policy_decision' | 'press_conference' | 'other' nullable

Optional query parameter.

knowledge_mode'accepted' | 'reconstruction'

Optional query parameter.

checkpointinteger nullable

Optional query parameter.

cursorstring nullable

Optional query parameter.

limitinteger

Optional 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

currencystring required
as_ofstring required
knowledge_mode'accepted' | 'reconstruction' required
checkpointinteger required
next_cursorstring nullable
eventsobject[] required
evidence_noticestring

Changes

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