API documentation

API function control

API: api_key

Function

Displays the status of your API key.


Interactive guide and OpenAPI

OpenAPI 3.0 (Swagger) – Interactive API documentation

Opens the interactive API documentation with Swagger, where you can test and explore API endpoints.

Download OpenAPI JSON specification

URL for requests

To retrieve the data, use the following URL. Please pay attention to upper case lower case.

POST / GET
https://feiertagskalender.ch/api/api_key/index.php

Request parameters

With the following variables you can complete the query and control the API results.

Parameter Explanation Examples
api_key
required
Your API Key api_key=abc-123-def-456
charset

The desired coding of the response

Variants:
UTF-8 (= default)
ISO-8859-1

charset=iso-8859-1
format

The desired output format

Variants:
JSON (= default)
XML
CSV

format=xml
date_format

The desired date format for the response. Default: `Y-m-d` (e.g., 2025-12-31)
The format corresponds to the date formatting of the PHP instruction date()

Variants:
Y-m-d = YYYY-MM-DD (ISO-8601) (= default)
d.m.Y = DD.MM.YYYY
Ymd = YYYYMMDD
dmY = DDMMYYYY
d.m.y = DD.MM.YY
j.n.y = D.M.YY

date_format=d.m.Y

Examples (URL / PHP / Python / JavaScript)

Show examples

Return values of the API

Array         Explanation Example
interface         Version of the API  
source: href       URL to the data source (website)  
  description       Name of the data source  
copyright href       URL to the copyright holder (website)  
  description       Designation of the copyright holder  
apiName         Identification of the API api_key
date         Date of the data export 01.05.2025
apiKeyStatus         Output status. For variants, see the Error messages active
apiDateStart         Date of activation of API access 01.01.2015
apiDateEnd         Contract end date of API access 31.12.2018
apiData            
  dataPublicHolidays       Scope of subscribed countries for public holidays

Options
- all
- ISO country code, 2 digits, comma separated
AT,CH,DE
  yearsPublicHolidays       Scope of subscribed years for public holidays 2015,2016,2017,2018
  dataSchoolHolidays      

Scope of subscribed countries for school holidays

Options
- all
- ISO country code, 2 digits, comma separated

CH
  yearsSchoolHolidays       Scope of subscribed years for school holidays 2015,2016,2017,2018
apiList api       List of all APIs enabled for you  

Examples (JSON / XML / CSV)

JSON

URL:
https://www.feiertagskalender.ch/api/api_key/index.php?api_key=YOUR_API_KEY&date_format=Y-m-d

Response from the API:

{
    "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 Arch"
    },
    "apiName": "api_key",
    "date": "2025-02-26",
    "apiKeyStatus": "active",
    "apiDateStart": "2021-03-31",
    "apiDateEnd": "2026-03-31",
    "apiData": {
        "dataPublicHolidays": "AT,CH,DE,LI",
        "yearsPublicHolidays": "2020,2021,2022,2023,2024,2025,2026",
        "dataSchoolHolidays": "AT,CH,DE,LI",
        "yearsSchoolHolidays": "2020,2021,2022,2023,2024,2025,2026"
    },
    "apiList": [
        {
            "api": "api_key"
        },
        {
            "api": "CheckDate/CH/BFS"
        },
        {
            "api": "CheckDate/CH/PLZ"
        },
        {
            "api": "CheckDate/GeoId"
        },
        {
            "api": "Data/Aggreg"
        },
        {
            "api": "Data/CH/BFS"
        },
        {
            "api": "Data/CH/Kanton"
        },
        {
            "api": "Data/CH/PLZ"
        },
        {
            "api": "Data/Country"
        },
        {
            "api": "Data/Country/CH"
        },
        {
            "api": "Data/Country/CH/PLZ"
        },
        {
            "api": "Data/Country/LI"
        },
        {
            "api": "Data/Country/LI/PLZ"
        },
        {
            "api": "Data/GeoId"
        },
        {
            "api": "GeoTree/CH"
        },
        {
            "api": "GeoTree/ISO"
        }
    ]
}

XML

URL:
https://www.feiertagskalender.ch/api/api_key/index.php?api_key=YOUR_API_KEY&date_format=Y-m-d&format=xml

Response from the API:

<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>2025-02-26</date>
<apiName>api_key</apiName>
<apiKeyStatus>active</apiKeyStatus>
<apiDateStart>2021-03-31</apiDateStart>
<apiDateEnd>2026-03-31</apiDateEnd>
<apiData>
<dataPublicHolidays>AT,CH,DE,LI</dataPublicHolidays>
<yearsPublicHolidays>2020,2021,2022,2023,2024,2025,2026</yearsPublicHolidays>
<dataSchoolHolidays>AT,CH,DE,LI</dataSchoolHolidays>
<yearsSchoolHolidays>2020,2021,2022,2023,2024,2025,2026</yearsSchoolHolidays>
</apiData>
<apiList>
<api>api_key</api>
<api>CheckDate/CH/BFS</api>
<api>CheckDate/CH/PLZ</api>
<api>CheckDate/GeoId</api>
<api>Data/Aggreg</api>
<api>Data/CH/BFS</api>
<api>Data/CH/Kanton</api>
<api>Data/CH/PLZ</api>
<api>Data/Country</api>
<api>Data/Country/CH</api>
<api>Data/Country/CH/PLZ</api>
<api>Data/Country/LI</api>
<api>Data/Country/LI/PLZ</api>
<api>Data/GeoId</api>
<api>GeoTree/CH</api>
<api>GeoTree/ISO</api>
</apiList>
</fcal_api>

CSV

Aufruf:
https://www.feiertagskalender.ch/api/api_key/index.php?api_key=YOUR_API_KEY&date_format=Y-m-d&format=csv

Response from the API:

"interface";"apiKeyStatus";"apiDateStart";"apiDateEnd";"dataPublicHolidays";"yearsPublicHolidays";"dataSchoolHolidays";"yearsSchoolHolidays";"api"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"api_key"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"CheckDate/CH/BFS"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"CheckDate/CH/PLZ"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"CheckDate/GeoId"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Aggreg"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/CH/BFS"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/CH/Kanton"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/CH/PLZ"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Country"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Country/CH"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Country/CH/PLZ"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Country/LI"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Country/LI/PLZ"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/GeoId"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"GeoTree/CH"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"GeoTree/ISO"

Error messages

Output location Error message Explanation
apiStatus
apiStatus: description invalid usage The use of this API is not enabled for this user.
apiStatus: description invalid key Invalid API key.
apiStatus: description invalid referer Invalid access. Links from web pages (front-ends) are not allowed.
apiStatus: description inactive The API has not yet been activated for use.
apiStatus: description expired The period of use according to the contract has expired.
© 2003 - 2025 psc Peter Schütz Informatik Dienstleistungen, CH-Arch