Regional Support
How regional holidays work in JDay — parameter format, supported regions, and validation.
Five countries support regional holidays at launch. Regional queries require a Starter plan or above.
Supported Regions
| Country | Regions |
|---|---|
| AU (Australia) | All 8 states/territories |
| CA (Canada) | All 13 provinces/territories |
| DE (Germany) | All 16 Länder |
| GB (United Kingdom) | ENG, NIR, SCT, WLS |
| US (United States) | All 50 states + DC |
Parameter Format
Use the ISO 3166-2 subdivision suffix only:
?country=US®ion=NY ✅ correct
?country=US®ion=US-NY ❌ rejectedExamples:
US-NYbecomesNYGB-ENGbecomesENGDE-BYbecomesBY
The API accepts case-insensitive input and normalizes to uppercase. Leading and trailing whitespace is ignored.
Validation Order
Region validation follows a fixed order:
- Is
countrya supported country code? →400 invalid_countryif not - Does this country support regions? →
400 invalid_regionif not - Is the supplied region code valid for this country? →
400 invalid_regionif not - Does the caller's plan allow regional queries? →
403 plan_upgrade_requiredif not
This means:
- An unknown country is always rejected before any region logic runs
- A valid region on a Free plan returns
403 plan_upgrade_required, not400 - Sending a region for a country without region support (e.g.,
?country=JP®ion=TK) returns400 invalid_region