Returns the status of your API key.
To retrieve the data, use the following URL.
Please pay attention to capital letters.
The following variables can be used to complete the query and affect the API results.
| Parameter | Explanation | Examples |
|---|---|---|
| api_key required |
Your API key |
?api_key=abc-123-def-456 |
| charset | The desired encoding of the answer. Variants: |
&charset=iso-8859-1 |
| format | The desired output format. Variants: |
&format=xml |
| date_format | The desired date format. Variants: |
&date_format=d.m.Y |
| Parameter | Explanation | Example | |
|---|---|---|---|
| interface | Version of the API | ||
| source | href | URL to data source (website) | |
| description | Name of the data source | ||
| copyright: | href | URL to the copyright owner (website) | |
| description | Designation of the copyright holder | ||
| apiName | Identification of the API | api_key | |
| date | Date of data export | 01.05.2025 | |
| apiKeyStatus | Status of your API key: Options: - active (valid and active) - inactive (the API has not been activated yet) - expired (useful life expired after contract) - invalid key (invalid, unknown key) |
active | |
| apiDateStart | Date Activation of API access | 01.01.2015 | |
| apiDateEnd | Date of end of contract of API access | 31.12.2018 | |
| apiData | |||
| dataPublicHolidays | Scope of holidays subscribed by country Options: - all - ISO country codes, comma-separated |
AT,CH,DE | |
| yearsPublicHolidays | Scope of holidays subscribed by year | 2015,2016,2017,2018 | |
| dataSchoolHolidays | Scope of school holidays subscribed by country Options: |
CH | |
| yearsSchoolHolidays | Scope of school holidays subscribed by year | 2015,2016,2017,2018 | |
| apiList | api | List of all APIs activated for you |
| Place of issue | Error message | Explanation |
|---|---|---|
| apiStatus: description | invalid usage | The use of this API is not intended for you. Please contact our support. |
| apiStatus: description | invalid key | Invalid API key. Please check your API key. |
| apiStatus: description | invalid referer | Invalid access. Links from websites (front-ends) are not permitted. Set up your query so that it comes from a protected back-end. If necessary, please contact the Feiertagskalender.ch support. |
| apiStatus: description | inactive | The API has not yet been unlocked for use. Please try again later. |
| apiStatus: description | expired | The useful life according to the contract has expired. Please contact the Feiertagskalender.ch Administration for a contract extension. |
Call:
https://feiertagskalender.ch/api/api_key/?api_key=YOUR_API_KEY
Reply in JSON / UTF-8:
{
"interface": "fcal API 2.0",
"source": {
"href": "https://feiertagskalender.ch",
"description": "Feiertagskalender.ch"
},
"copyright": {
"href": "https://psc.ch",
"description": "psc Peter Schuetz Informatik-Dienstleistungen, CH Bern"
},
"apiName": "api_key",
"date": "2019-04-11",
"apiKeyStatus": "active",
"apiDateStart": "2014-06-01",
"apiDateEnd": "2020-05-31",
"apiData": {
"dataPublicHolidays": "AT,CH,DE",
"yearsPublicHolidays": "2015,2016,2017,2018,2019,2020",
"dataSchoolHolidays": "AT,CH,DE",
"yearsSchoolHolidays": "2015,2016,2017,2018,2019,2020"
},
"apiList": [{
"api": "api_key"
}, {
"api": "Data/CH/BFS"
}, {
"api": "Data/CH/Kanton"
}, {
"api": "Data/CH/PLZ"
}, {
"api": "Data/CityId"
}, {
"api": "Data/GeoId"
}, {
"api": "GeoTree/ISO"
}]
}
Call:
https://feiertagskalender.ch/api/api_key/?api_key=YOUR_API_KEY&format=xml
Reply in XML / UTF-8:
<fcal_api> <interface>fcal API 2.0</interface> <source> <href>https://feiertagskalender.ch</href> <description>Feiertagskalender.ch</description> </source> <copyright> <href>https://psc.ch</href> <description>psc Peter Schuetz Informatik-Dienstleistungen, CH Bern</description> </copyright> <date>2019-04-11</date> <apiName>api_key</apiName> <apiKeyStatus>active</apiKeyStatus> <apiDateStart>2014-06-01</apiDateStart> <apiDateEnd>2020-05-31</apiDateEnd> <apiData> <dataPublicHolidays>AT,CH,DE</dataPublicHolidays> <yearsPublicHolidays>2015,2016,2017,2018,2019,2020</yearsPublicHolidays> <dataSchoolHolidays>AT,CH,DE</dataSchoolHolidays> <yearsSchoolHolidays>2015,2016,2017,2018,2019,2020</yearsSchoolHolidays> </apiData> <apiList> <api>api_key</api> <api>Data/CH/BFS</api> <api>Data/CH/Kanton</api> <api>Data/CH/PLZ</api> <api>Data/CityId</api> <api>Data/GeoId</api> <api>GeoTree/ISO</api> </apiList> </fcal_api>
Aufruf:
https://feiertagskalender.ch/api/api_key/?api_key=YOUR_API_KEY&format=csv
Reply in CSV / UTF-8:
"interface";"apiKeyStatus";"apiDateStart";"apiDateEnd";"dataPublicHolidays";"yearsPublicHolidays";"dataSchoolHolidays";"yearsSchoolHolidays";"api" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"api_key" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"Data/CH/BFS" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"Data/CH/Kanton" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"Data/CH/PLZ" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"Data/CityId" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"Data/GeoId" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"GeoTree/ISO"
