calendar

Get immutable schedule versions for an event

Returns accepted versions and their source, capture and documentary evidence. The archive event ID remains stable when its scheduled time changes; existing calendar_event_id values on the current calendar retain their original meaning. Reuse checkpoint and cursor to continue an export. Requires an active API key.

get/v1/calendar/{currency}/events/{archive_event_id}/versions

Request

  • Base URL: https://api.fxmacrodata.com
  • URL: https://api.fxmacrodata.com/v1/calendar/{currency}/events/{archive_event_id}/versions
  • 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.

archive_event_idstring required

Required path parameter.

Query parameters

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
archive_event_idstring required
checkpointinteger required
next_cursorstring nullable
versionsobject[] required

Changes

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