Welcome to the Holiday API. We cover over 120 countries and states around the world. We are constantly adding new countries and states. Feel free to send us an email if your country is not included in the list. This document covers how to use our API. Let us know if you have any questions.
You can get started by using one of our SDKs in your project or making your own implementation. It cannot be simpler!
An API key is required for every request to the Holiday API.
Your API key is used to authenticate you with our API, and it should be provided as a api_key URL parameter.
The API key can be retrieved from the dashboard page.
If you don't have an account yet, you can sign up for free!
Once you have your API Key, you should append it to your GET query, as per example:
$ curl -G -d api_key="[ YOUR API KEY HERE]" -d country="US" -d year="2019" "https://holidayapi.pl/v1/holidays"
In other words, you need to make a simple GET request to https://holidayapi.pl/v1/holidays, so in this case:
https://holidayapi.pl/v1/holidays?api_key=[ YOUR API KEY HERE]&country=US&year=2019
Have a look at extra filters that may help you to get exactly the data you need.
The Holiday API is built on REST principles. Authenticated users can interact with any of our URIs by using the specified HTTP request method. We enforce using SSL encryption by issuing requests through HTTPS.
||Get a list of all holiday information for a specific country. Alterable using Filters.||Yes|
Check out possible API Responses. Remember you are obligated to collect full responses in order to report bugs and issues.
RippleUI follows a simple basic structure that is easy to use.
||Validation error. Please refer to
||Authorization error. Check your
||Authentication error. Requested resource/feature/filter is not available for you/in your plan or you've exceeded your monthly requests allowance.|
||You've exceeded rate limit available in your plan.|
||Fatal error at our end. We should get reported automatically but contact us if it'll keep occurring.|
Officially, are currently supporting 88 countries and constantly adding more. Another 70 countries are available to our chosen customers on a beta test basis.
|Country||ISO 3166-1 alpha-2 code|
|Antigua And Barbuda||AG|
|Bosnia And Herzegovina||BA|
|Central African Republic||CF|
|Isle of Man||IM|
|Tanzania, United Republic Of||TZ|
If you would like to help adding your country's holidays to expand the service, please do not hesitate to contact us. To all collaborates we're offering a lifetime Premium Plan.
After Authentication' section
api_key parameter in your GET query, you are able to append more parameters.
Some of them are required some of them are optional, but each of them alter received list of holidays a bit.
Please make yourself comfortable with the list below before you start using our API.
||Yes||ISO 3166-1 alpha-2 country code from Countries section.||
||No||1 or 2 digit month identifier (MM or M)||
||No||1 or 2 digit day identifier (DD or D)||
||No||Return only holidays before given date (default: 0)||
||No||Return only holidays after given date (default: 0)||
||No||Return only public holidays||
||No||Define return data format (available: json, xml)||
||No||Output as human-readable text (default: 0)||
If you'd like to participate in development of new SDKs or you have already made a wrapper in your favourite language, please do let us know. We offer free Premium Plan subscription to authors of all verified SDKs.
We are here to assist you, thank you for report any bug/issue to our email [email protected].
What support includes?
What support doesn't include:
If you already read the documentation and you still need assistance, please send us an email to [email protected] or contact us via any other support channel available in your plan and we'll be glad to help you.