timeApe (1.0.0)

API Support: support@timeape.io URL: https://timeape.io

Let someone else think about when the next public holiday is.

Introduction

The API is being continually expanded with new countries and features. We guarantee the data is kept up to date, including last minute holiday changes.

Please get in touch with us at support@timeape.io if you are experiencing difficulties, or would like to request a feature or country.

Errors

The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:

  {
    "message": "Missing required request parameters: [year]"
  }

Authentication

We currently only support API key authentication. Please provide this in each request.

api_key

Security Scheme Type	API Key
Header parameter name:	x-api-key

holidays

getHolidaysForCountry

Returns all the holidays for a given country

Authorizations:

api_key

path Parameters

country

required

string

Country is expected in ISO 3166-1 alpha-2 format. e.g. au for Australia.

query Parameters

year

required

string

Year is expected in YYYY format, e.g. 2020

Responses

200

200 response

400

400 response

500

500 response

get /holidays/{country}

https://api.timeape.io//v1/holidays/{country}

Request samples

cURL

Copy

curl -H 'x-api-key: 123456' \
  "https://api.timeape.io/v1/holidays/au?year=2020"

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"country": "au",
"holiday_date": "2020-06-08",
"holiday_observed": "2020-06-08",
"holiday_type": "public_holiday",
"states": 
["tas",
"nt",
"qld",
"act",
"nsw",
"vic"
],
"title": "Queen's Birthday",
"uuid": "ad97a9f2-f7ee-457b-95df-7325644d4efa",
"year": "2020"
}
]

getHolidaysForState

Returns all the holidays for a given state/province within a country

Authorizations:

api_key

path Parameters

country required	string Country is expected in ISO 3166-1 alpha-2 format. e.g. au for Australia.
state required	string Where possible, we try to stick to the local naming convention for states, territories and provinces of the country.

query Parameters

year

required

string

Year is expected in YYYY format, e.g. 2020

Responses

200

200 response

400

400 response

500

500 response

get /holidays/{country}/{state}

https://api.timeape.io//v1/holidays/{country}/{state}

Request samples

cURL

Copy

curl -H 'x-api-key: 123456' \
  "https://api.timeape.io/v1/holidays/au/vic?year=2020"

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"country": "au",
"holiday_date": "2020-06-08",
"holiday_observed": "2020-06-08",
"holiday_type": "public_holiday",
"states": 
["tas",
"nt",
"qld",
"act",
"nsw",
"vic"
],
"title": "Queen's Birthday",
"uuid": "ad97a9f2-f7ee-457b-95df-7325644d4efa",
"year": "2020"
}
]

Holiday

country	string
holiday_date	string
holiday_observed	string
holiday_type	string
states	Array of strings
title	string
uuid	string
year	integer <int32>

Copy

Expand all Collapse all


{"country": "au",
"holiday_date": "2020-06-08",
"holiday_observed": "2020-06-08",
"holiday_type": "public_holiday",
"states": 
["tas",
"nt",
"qld",
"act",
"nsw",
"vic"
],
"title": "Queen's Birthday",
"uuid": "ad97a9f2-f7ee-457b-95df-7325644d4efa",
"year": "2020"
}

Holidays

Array

country	string
holiday_date	string
holiday_observed	string
holiday_type	string
states	Array of strings
title	string
uuid	string
year	integer <int32>

Copy

Expand all Collapse all


[
{"country": "au",
"holiday_date": "2020-06-08",
"holiday_observed": "2020-06-08",
"holiday_type": "public_holiday",
"states": 
["tas",
"nt",
"qld",
"act",
"nsw",
"vic"
],
"title": "Queen's Birthday",
"uuid": "ad97a9f2-f7ee-457b-95df-7325644d4efa",
"year": "2020"
}
]