Every endpoint and every query parameter, generated from the API's own OpenAPI document. Nothing on this page is typed by hand except the explanatory notes, so it cannot describe a parameter the API does not have.
16 endpoints · generated 2026-07-30 · openapi.json · Back to docs
/v1/calendarCalendar
The endpoint most callers want. One window, up to 20 jurisdictions, inheritance resolved and substitution applied. It is also the only endpoint that takes an arbitrary window, so it is the only one your plan's window limit applies to.
| Parameter | Type | Required | Notes |
|---|---|---|---|
jurisdictions | string | yes | Comma-separated, up to 20 per call. Subdivisions inherit their country's calendar, so DE-BY returns Bavaria's days and Germany's. |
from | string | yes | |
to | string | yes | |
min_assurance | string | — | corroborated excludes compiled rows; verified returns verified rows only. It is a floor, not a quality improvement — raising it removes rows and the ones that remain are unchanged. Every row carries its own assurance anyway, so deciding per row in your own code is usually better than deciding per request. |
tz | string | — | The IANA zone of the caller. Adds UTC bounds for each holiday plus the date it falls on for you. The dates themselves are never shifted: a holiday is a civil date in its own jurisdiction, and 25 December in Tokyo is 25 December wherever you are reading from. |
categories | string | — | Which tradition, not which statute. A caller asking what matters in Jakarta in March needs to tell a Hindu observance from an Islamic one. |
closures_only | boolean | — | Both answers are legitimate. Is the bank open wants this on. Should I schedule the all-hands wants it off — nothing closes for Yom Kippur in London, and it would still empty the room. Default False. |
format | string | — | csv flattens to one row per event. ics is a subscribable iCalendar feed — see Exports. Default json. |
/v1/calendars/overlayCalendar Overlay
One civil date rendered in every calendar system we hold.
A Gregorian date rendered across every parallel calendar system — Coptic / Ethiopic / Julian / Hebrew / Discordian plus the Class-A reckonings (Persian, Maya, Egyptian, Armenian, counters, year-offsets). Computed live; deterministic for any year.
| Parameter | Type | Required | Notes |
|---|---|---|---|
date | string | yes |
/v1/observances/{code}Get Observances
The RULES, not the dates they produce. Ask this when you want to know why a date falls where it does — the rule type, the substitution behaviour, the sources.
| Parameter | Type | Required | Notes |
|---|---|---|---|
code | string | yes | |
include_inherited | boolean | — | On, a subdivision shows its country's observances too. Off, only what it declares itself. Default True. |
assurance | string | — | compiled|corroborated|verified |
/v1/jurisdictionsList Jurisdictions
Every code we hold, with its type and parent. Paged: limit caps at 500 and there are more than 900 jurisdictions, so read total and page through it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
type | string | — | country|state|region|province|territory|municipality |
q | string | — | substring match on name |
limit | integer | — | Default 100. |
offset | integer | — | Default 0. |
/v1/jurisdictions/{code}Get Jurisdiction
| Parameter | Type | Required | Notes |
|---|---|---|---|
code | string | yes |
/v1/tax/{code}Get Tax
Statutory filing and payment deadlines. A conditional rule returns its wording and no computed date — most of these are relative to a fiscal year end ("within 6 months of FY-end"), and the honest answer is the condition, not a fabricated date.
Statutory filing and payment deadlines.
| Parameter | Type | Required | Notes |
|---|---|---|---|
code | string | yes | |
audience | string | — | corporations|individuals|employers — filters applies_to |
/v1/exchangesList Exchanges
No parameters. This endpoint returns the same document every time, which is why it is safe to cache hard.
/v1/exchanges/{mic}Get Exchange
| Parameter | Type | Required | Notes |
|---|---|---|---|
mic | string | yes |
/v1/exchanges/{mic}/calendarExchange Calendar
Trading days and closures for a venue, session days only: the jurisdiction's holidays with the exchange's own exclusions removed and its own closures added.
Resolved trading-calendar closures: jurisdiction holidays (substitution applied, exclusions removed) plus exchange-specific closures, session days only.
| Parameter | Type | Required | Notes |
|---|---|---|---|
mic | string | yes | |
from | string | yes | |
to | string | yes | |
format | string | — | csv flattens to one row per event. ics is a subscribable iCalendar feed — see Exports. Default json. |
/v1/solarSolar
Live compute, no database. Self-clamps at the poles — ask for Longyearbyen in December and you get polar night, not a negative day length.
Daylight duration + approximate sun times for a location/date. Computed LIVE (deterministic, any year) — no DB, no precompute. Duration is exact to ~minutes and self-clamps to 24h/0h at the poles; install `astral` on the host for precise clock times / twilight.
| Parameter | Type | Required | Notes |
|---|---|---|---|
lat | number | yes | |
lon | number | — | Default 0.0. |
date | string | yes | |
tz_offset | number | — | Default 0.0. |
/v1/accountAccount
Your plan, your claimed jurisdictions, your rate limit, and your usage. Never your key — we store a SHA-256 and not the key itself.
What this key is and what it may reach.
No parameters. This endpoint returns the same document every time, which is why it is safe to cache hard.
/v1/catalogCatalog
What this API can answer, as data. The console builds its entire capability menu from this document, which is why new data appears there the day it ships without a UI release.
The menu: every option the API offers — calendars, holidays, tax, market calendars, sun & season — each with a context blurb (who observes it, where it's official) and a `new` flag.
No parameters. This endpoint returns the same document every time, which is why it is safe to cache hard.
/v1/coverageCoverage
How much we hold and at what assurance, per jurisdiction. Published because a coverage number you cannot break down is a marketing claim.
Assurance coverage per country — the honesty dashboard.
No parameters. This endpoint returns the same document every time, which is why it is safe to cache hard.
/v1/healthHealth
No parameters. This endpoint returns the same document every time, which is why it is safe to cache hard.
/version.jsonVersion Json
No parameters. This endpoint returns the same document every time, which is why it is safe to cache hard.
/v1/announcements/{code}Get Announcements
One-off decreed days that no rule predicts: mourning days, election days, royal events, and the exact dates of moon-dependent holidays once a government has announced them. This is the only endpoint with a reason to be polled rather than cached hard.
| Parameter | Type | Required | Notes |
|---|---|---|---|
code | string | yes |