Skip to main content
GET
Economic calendar events

Authorizations

X-API-Key
string
header
required

Your HayInsights API key (prefixed apk_). Create and manage keys in the HayInsights dashboard (Account → API keys).

Send it in the X-API-Key header on every request to /openapi/v1/*. Which data domains you may access and your request quota are both governed by the subscription plan attached to the key — see the Plans & features and Rate limits guides.

Query Parameters

from
string<date>

Start date, YYYY-MM-DD.

Example:

"2026-09-01"

to
string<date>

End date, YYYY-MM-DD.

Example:

"2026-09-30"

country
enum<string>[]

Filter by country. Comma-separated, e.g. us,jp,vn. An unrecognised value yields an empty list rather than every event.

Available options:
global,
us,
jp,
vn,
eu,
gb,
au,
ca,
nz,
cn,
ch
category
enum<string>[]

Filter by event type. Comma-separated.

Available options:
holiday,
economic,
asset
assetClass
enum<string>[]

Filter by asset class. Comma-separated.

Available options:
stock,
etf,
bond,
crypto,
commodity,
fx
impact
enum<string>[]

Filter by expected market impact. Comma-separated.

Available options:
high,
medium,
low
q
string

Search the event title, local name, or tag.

Example:

"CPI"

includeGlobal
boolean
default:true

Include global events alongside the countries selected.

tz
string

IANA timezone the event times are rendered in.

Example:

"Asia/Tokyo"

preset
enum<string>

Preset filter bundle.

Available options:
global
limit
integer
default:20

Events to return.

Required range: 1 <= x <= 50
offset
integer
default:0

Events to skip, for paging.

Required range: x >= 0

Response

One page of calendar events.

Standard success envelope shared by every endpoint. Each operation's response wrapper extends this (via allOf) and adds a typed data property.

success
boolean
required

Always true for a successful response.

Example:

true

statusCode
integer
required

Mirrors the HTTP status code.

Example:

200

data
object
required

One page of events. total counts every event matching the filters, so a caller told "150 events, 20 returned" can reach the rest with offset.

meta
object

Response metadata. Always present; timestamp is the server time the response was generated.