Historical Calendar Snapshot
calendar_snapshotReturn persisted economic-event schedules, importance and cancellation states at an explicit historical cutoff. Accepted mode requires actual capture and parser acceptance by the cutoff. Reconstruction additionally admits qualified official notices recovered later; it does not establish historical service availability. Scheduled-date and event filters apply after version selection. Checkpoint and cursor pin subsequent export pages. Empty results do not establish that no events were scheduled. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as_of | Yes | Required ISO 8601 knowledge cutoff with UTC offset or Z. | |
| limit | No | Maximum events per page, default 250. | |
| cursor | No | Opaque next_cursor returned by the previous page. | |
| currency | Yes | 3-letter ISO currency code, case-insensitive. | |
| end_date | No | Inclusive scheduled-date upper bound, YYYY-MM-DD. | |
| checkpoint | No | Checkpoint returned by the first page. | |
| event_kind | No | Scheduled event kind filter. | |
| importance | No | Frozen event importance filter. | |
| start_date | No | Inclusive scheduled-date lower bound, YYYY-MM-DD. | |
| knowledge_mode | No | Archive acceptance replay, or qualified documentary reconstruction. | accepted |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||