| Parameter | Description | Mandatory | Default Value |
|---|---|---|---|
| country | ISO 3166-1 alpha-3 country code or ISO 3166-1 alpha-2 country code | Yes | No default value |
| region | Possible values for New Zealand: ISO 3166-2:NZ codes - auk, bop, can, gis, hkb, mbh, mwt, nsn, ntl, ota, stl, tas, tki, wko, wgn, wtc, cit Possible values for Australia: ISO 3166-2:AU codes - nsw, qld, sa, tas, vic, wa, act, nt Possible values for Canada: ISO 3166-2:CA codes - ab, bc, mb, nb, nl, ns, on, pe, qc, sk, nt, nu, yt Possible values for United States of America: ISO 3166-2:US codes - al, ak, az, ar, ca, co, ct, de, fl, ga, hi, id, il, in, ia, ks, ky, la, me, md, ma, mi, mn, ms, mo, mt, ne, nv, nh, nj, nm, ny, nc, nd, oh, ok, or, pa, ri, sc, sd, tn, tx, ut, vt, va, wa, wv, wi, wy, dc Possible values for Germany: ISO 3166-2:DE codes - bw, by, be, bb, hb, hh, he, mv, ni, nw, rp, sl, sn, st, sh, th Possible values for Great Britain: ISO 3166-2:GB codes - eng, nir, sct, wls | Yes for countries New Zealand, Australia, Canada, United States of America, Germany and Great Britain. | No default value |
| holidayType |
Possible values
| No | ALL |
| date | Date in format dd-mm-yyyy | Yes | No default value |
| jsonp | Name of the JSONP callback function | No | No default value |
[{
"date": {
"day":26,
"month":12,
"year":2022,
"dayOfWeek":1
},
"name": [{
"lang":"fr",
"text":"Saint Etienne"
},
{
"lang":"en",
"text":"Boxing Day"
}],
"note": [{
"lang":"en",
"text":"Observed only in Alsace and Moselle"
}],
"flags": [
"REGIONAL_HOLIDAY"
],
"holidayType":"public_holiday"
}]
| Parameter | Description | Mandatory |
|---|---|---|
| date | Date on which holiday takes place. Parameter dayOfWeek specifies numerical value of week day. Monday=1, Tuesday=2, ..., Saturday=6, Sunday=7. | Yes |
| dateTo | In case holiday takes place on more than 1 day, this is the last day of holiday duration. Previous parameter date is the first day of holiday duration. | No |
| observedOn | Specifies the date on which holiday is observed. If missing holiday is observed on date specified in date parameter. | No |
| name | One or more names for the given holiday. Every name has a ISO 639-1 language code to specify the language. | Yes |
| note | One or more notes for the given holiday. Every note has a ISO 639-1 language code to specify the language. | No |
| flags | One or more flags for the given holiday. Possible flags are:
| No |
| holidayType | Type of the holiday. Possible values are:
| Yes |
{
"isPublicHoliday": true
}
{
"isWorkDay": true
}
[{
"countryCode": "aus",
"regions": [
"act",
"qld",
"nsw",
"nt",
"sa",
"tas",
"vic",
"wa"
],
"holidayTypes": [
"public_holiday"
],
"fullName": "Australia",
"fromDate": {
"day": 1,
"month": 1,
"year": 2011
},
"toDate": {
"day": 31,
"month": 12,
"year": 32767
}
}]
| Parameter | Description | Mandatory |
|---|---|---|
| countryCode | ISO 3166-1 alpha-3 country code. | Yes |
| regions | ISO 3166-2 list of regions in the country. This list can be empty if holiday dates do not differ across country. | Yes |
| holidayTypes | List of holiday types available for this country. Possible values are:
| Yes |
| fullName | Display name of the country. | Yes |
| fromDate | Date from which holidays are available for this country. | Yes |
| toDate | Date to which holidays are available for this country. | Yes |
[{
"countryCode":"can",
"countryFullName":"Canada",
"holidayName": [{
"lang":"en",
"text":"Victoria Day"
},
{
"lang":"fr",
"text":"Fête de la Reine ou Journée nationale des Patriotes"
}]
}]
| Parameter | Description | Mandatory |
|---|---|---|
| countryCode | ISO 3166-1 alpha-3 country code. | Yes |
| countryFullName | Display name of the country. | Yes |
| holidayName | One or more names for the given holiday. Every name has a ISO 639-1 language code to specify the language. | Yes |