GET/v1/holidays
List holidays
Parameters
| Name | Type | Notes |
|---|---|---|
| year | integer | min 2000, max 2100 |
| type | HolidayType | regularspecial_non_workingspecial_workinglocal |
| status | HolidayStatus | confirmedprojectedpending |
| locality | string | Locality slug, or nationwide.min length 1, max length 100Pro & Business |
| from | string (date) | Inclusive start date. |
| to | string (date) | Inclusive end date. |
| limit | integer | min 1, max 500, default 366 |
Responses
Matching holidays.
| Header | Type | Notes |
|---|---|---|
| Cache-Control | string | Edge-cached; cache on your side too. A Sandbox key gets private, no-store instead. |
| x-pholidays-sandbox | integer | Present only for a Sandbox key. The one year it serves. On every 200 to a Sandbox key, cache HIT included. |
| Deprecation | string | Present only on a call with no key, once a sunset date is announced. RFC 9745: @ followed by Unix seconds, 60 days before Sunset. On a 200 to a call with no key, cache HIT included. |
| Sunset | string | Present only on a call with no key, once a sunset date is announced. RFC 8594 HTTP-date: when calls with no key start to get a 401. On a 200 to a call with no key, cache HIT included. |
| Link | string | Present only on a call with no key, once a sunset date is announced. <https://pholidays.com/pricing>; rel="sunset": where to get a key. On a 200 to a call with no key, cache HIT included. |
Response schema
| Field | Type | Notes |
|---|---|---|
| data | array | |
| id | integer | |
| date | string (date) | |
| weekday | string | |
| year | integer | |
| name | string | |
| type | HolidayType | regularspecial_non_workingspecial_workinglocal |
| status | HolidayStatus | confirmedprojectedpending |
| locality | string | |
| region | string | null | |
| province | string | null | |
| proclamationNumber | string | null | |
| sourceUrl | string | null | |
| isMovable | boolean | |
| notes | string | null | |
| source | string | projectionseedscrapermanual |
| premiumPay | PremiumPay | What an employee earns on the day, as a multiple of the daily wage. |
| unworked | number | Day not worked. |
| worked | number | Day worked (first 8 hours). |
| note | string | |
| updatedAt | string (date-time) | |
| meta | object | |
| lastUpdated | string | null | |
| lastChecked | string | null | |
| coverage | string | |
| officialSource | string | |
| sandbox | object | Present only on a 200 to a Sandbox key.optional |
| year | integer | The one year a Sandbox key serves. |
| requestsPerDay | integer | The daily cap (UTC day). |
| remainingToday | integer | Requests left today after this one. |
| note | string | A reminder of the Sandbox rules and where to buy a Plan. |
| count | integer | How many items data holds. |
| filters | object | The parsed filters that were applied.optional |
Errors: see Errors and limits.