API-Dokumentation

Tagesdaten

Tagesstatus nach Datum auslesen

mittels Geo-ID mittels City-ID Schweiz / Liechtenstein: mittels Postleitzahl

Schweiz / Liechtenstein: mittels BFS-Nummer

API: CheckDate/CH/BFS

Holt Feiertage und Schulferien für ein bestimmtes Datum, basierend auf einer Schweizer Gemeindenummer (BFS).

Funktion

Diese API ermittelt, ob an einem angegebenen Datum an einem bestimmten Ort ein offizieller Feiertag oder Schulferien stattfinden. Erforderliche Parameter sind `api_key` und `bfs`. Der Parameter `date` ist optional – falls er nicht angegeben wird, wird automatisch das heutige Datum verwendet. Zusätzlich kann die Ausgabe über weitere Parameter konfiguriert werden. Die Parameter werden als Query-Parameter in der URL übergeben. Alternativ kann die Autorisierung auch im Header erfolgen.

Interaktive Anleitung und OpenAPI

OpenAPI 3.0 (Swagger) – Interaktive API-Dokumentation

Öffnet die interaktive API-Dokumentation mit Swagger, in der Sie API-Endpunkte testen und erkunden können.

OpenAPI JSON-Spezifikation herunterladen

API-Kapitel

URL für Anfragen
Parameter für Anfragen
Beispiele (URL / PHP / Python / JavaScript)
Rückgabewerte des API
Beispiele (JSON / XML / CSV)
Fehlermeldungen

URL für Anfragen

Zum Abrufen der Daten verwenden Sie folgende URL. Achten Sie bitte auf Gross-Kleinschrift.

POST / GET

https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php

Parameter für Anfragen

Mit den folgenden Variablen können Sie die Abfrage vervollständigen und die API-Ergebnisse steuern.

Parameter	Erläuterung	Beispiele
api_key erforderlich	Ihr API-Schlüssel	api_key=abc-123-def-456
BFS erforderlich	Schweizer Gemeindenummer nach BFS (Bundesamt für Statistik)	BFS=261
date	Das zu prüfende Datum ohne Angabe: heute (= Standard)	date=2025-06-01
class oder klasse	Umfang der Daten Varianten: 0 = nur Schulferien 3 = 0 + gesetzlich anerkannte Feiertage 4 = 0 + 3 + gesetzliche und gesetzlich nicht anerkannte Feiertage (religiöse, kulturelle) (= Standard) 5 = 0 + 3 + 4 + Ereignistage (z.B. Valentinstag, Muttertag, Advent)	klasse=5
charset	Die gewünschte Codierung der Antwort Varianten: UTF-8 (= Standard) ISO-8859-1	charset=iso-8859-1
format	Das gewünschte Ausgabeformat Varianten: JSON (= Standard) XML CSV	format=xml
date_format	Das gewünschte Datumsformat für die Antwort. Standard:`Y-m-d` (z.B., 2025-12-31) Das Format entspricht der Datumsformatierung der PHP-Anweisung date() Varianten: Y-m-d = YYYY-MM-DD (ISO-8601) (= Standard) 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
hl	Gewünschte Sprache der Ausgabe Varianten: de = Deutsch (= Standard) fr = Französisch it = Italienisch en = Englisch	hl=en

Beispiele (URL / PHP / Python / JavaScript)

Beispiele anzeigen

Parameter in der URL

So können Parameter in der URL mitgegeben werden (z.B. über den Browser, oder in Excel):
Hinweis: Der erste Parameter wird mit ? eingeleitet, alle weiteren Parameter werden mit & getrennt.

Wichtig: Dieser Code darf nicht direkt in einer Webseite verwendet werden! API-Schlüssel müssen aus Sicherheitsgründen nur im Backend verarbeitet werden.

https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?api_key=YOUR_API_KEY&bfs=261&date=2025-12-25

Beispiel PHP mit cURL (GET)

$api_url = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?bfs=261&date=2025-12-25";
$api_key = "YOUR_API_KEY";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
   "Authorization: Bearer $api_key",
   "Content-Type: application/json"
]);
$response = curl_exec($ch);
curl_close($ch);

echo $response;

Beispiel PHP mit cURL (POST)

$api_url = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php";
$api_key = "YOUR_API_KEY";

// POST-Daten
$post_data = json_encode([
    "bfs": "261", "date": "2025-12-25"	
]);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer $api_key",
    "Content-Type: application/json"
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Beispiel Python mit requests (GET)

import requests

api_key = "YOUR_API_KEY"
api_url = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?bfs=261&date=2025-12-25"
headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

response = requests.get(api_url, headers=headers)

if response.status_code == 200:
    print(response.json())  # JSON
else:
    print(f"Error: {response.status_code}", response.text)

Beispiel Python mit requests (POST)

import requests

api_key = "YOUR_API_KEY"
api_url = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php"
headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

payload = {
    "bfs": "261", "date": "2025-12-25"	
}

response = requests.post(api_url, headers=headers, json=payload)

if response.status_code == 200:
    print(response.json())  # JSON
else:
    print(f"Error: {response.status_code}", response.text)

Beispiel JavaScript mit Fetch API (GET)

Die Fetch API ist eine moderne Methode, um HTTP-Anfragen in JavaScript durchzuführen. Sie wird in aktuellen Browsern unterstützt.

Wichtig: Dieser Code darf nicht direkt in einer Webseite verwendet werden! API-Schlüssel müssen aus Sicherheitsgründen nur im Backend verarbeitet werden.

const apiUrl = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?bfs=261&date=2025-12-25";
const apiKey = "YOUR_API_KEY";  								
const headers = new Headers({
    "Authorization": "Bearer " + apiKey,
    "Content-Type": "application/json"
});

fetch(apiUrl, { method: "GET", headers })
    .then(response => {
        if (!response.ok) {
            throw new Error(`Error: ${response.status} ${response.statusText}`);
        }
        return response.json();
    })
    .then(data => console.log(data))
    .catch(error => console.error("Error:", error));

Beispiel JavaScript mit Fetch API (POST)

Die Fetch API ist eine moderne Methode, um HTTP-Anfragen in JavaScript durchzuführen. Sie wird in aktuellen Browsern unterstützt.

const apiUrl = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php";
const apiKey = "YOUR_API_KEY";  
const requestData = {
    "bfs": "261", "date": "2025-12-25"	
};

fetch(apiUrl, {
    method: "POST",
    headers: {
        "Authorization": "Bearer " + apiKey,
        "Content-Type": "application/json"
    },
    body: JSON.stringify(requestData)
})
.then(response => {
    if (!response.ok) {
        throw new Error(`Error: ${response.status} ${response.statusText}`);
    }
    return response.json();
})
.then(data => console.log(data))
.catch(error => console.error("Error:", error));

Rückgabewerte des API

Die Inhalte der API-Antworten ergeben sich aus:
- den von Ihnen abonnierten Daten (Länder, Feiertage, Schulferien, Kalenderjahre)
- den offiziell bekannten Daten der Gesetzgeber
- der Verfügbarkeit aufgrund unserer Recherchen (IST-Situation unserer Datenbank)

Beachten Sie bitte, dass die Ausgabe im CSV-Format abweicht.

Array				Erläuterung	Beispiel
interface				Version des API
source:	href			URL zur Datenquelle (Website)
	description			Bezeichnung der Datenquelle
copyright	href			URL zum Inhaber des Copyrights (Website)
	description			Bezeichnung des Copyright-Inhabers
apiName				Identifikation des API	CheckDate/CH/BFS
apiStatus	description			Bezeichnung des API-Status. Für Varianten, siehe unter Fehlermeldungen	active
date				Datum des Datenexports	01.05.2025
request:	bfs			BFS-Gemeindenummer	261
	date			Datum der Daten in der Ausgabe	2019-04-15
	charset			Schriftcodierung der Ausgabe	utf-8
	format			Datenformat der Ausgabe	json
	date_format			Datumformat der Ausgabe	d.m.Y
	hl			Sprache der Ausgabe, gemäss Anfrage	de
results	status	description		Status der Ausgabe. Für Varianten, siehe unter Fehlermeldungen	ok
	location	description		Bezeichnung der geografischen Einheit	Biel
		type		Bezeichnung der Art der geografischen Einheit	Gemeinde
		geoId		Geo-ID der geografischen Einheit.	424
		iso		ISO-Landeskürzel, 2-stellig	CH
		iso-3166-2		Regionencode nach ISO 3166-2	CH-BE
		note		Besondere Hinweise
		date_status		Tagesstatus
			date	Datum	2019-04-15
			total_population	Gesamtzahl der Einwohner	54640
			public_holiday_population	Anzahl Einwohner mit Feiertag	0
			public_holiday_percent	Prozent Einwohner mit Feiertag	0
			public_holiday_description	Bezeichnung des Feiertags
			school_holiday_population	Anzahl Einwohner mit Schulferien	54640
			school_holiday_percent	Prozent Einwohner mit Schulferien	100
			school_holiday_description	Bezeichnung Schulferien	Frühlingsferien
			sum_population	Summe der betroffenen Einwohner	54640
			percent_population	Prozent der betroffenen Einwohner	100

Beispiele (JSON / XML / CSV)

JSON

URL:
https://www.feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?api_key=YOUR_API_KEY&bfs=261&date=2025-12-25

Antwort des APIs:

{
    "interface": "fcal API 2.02",
    "source": {
        "href": "https://feiertagskalender.ch",
        "description": "feiertagskalender.ch"
    },
    "copyright": {
        "href": "https://psc.ch",
        "description": "psc Peter Schuetz Informatik-Dienstleistungen, CH Arch"
    },
    "apiName": "CheckDate/CH/BFS",
    "apiStatus": {
        "description": "active"
    },
    "date": "2025-02-25",
    "request": {
        "bfs": "261",
        "date": "2025-12-25",
        "charset": "utf-8",
        "format": "json",
        "date_format": "Y-m-d",
        "hl": "de"
    },
    "results": {
        "status": {
            "description": "ok"
        },
        "location": {
            "description": "Zürich",
            "type": "Stadt",
            "geoId": "3055",
            "iso": "CH",
            "iso-3166-2": "CH-ZH",
            "note": "",
            "date_status": {
                "date": "2025-12-25",
                "total_population": 433989,
                "public_holiday_population": 433989,
                "public_holiday_percent": 100,
                "public_holiday_description": "Weihnachten",
                "school_holiday_population": 0,
                "school_holiday_percent": 0,
                "school_holiday_description": null,
                "sum_population": 433989,
                "sum_percent": 100
            }
        }
    }
}

XML

URL:
https://www.feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?api_key=YOUR_API_KEY&bfs=261&date=2025-12-25&format=XML

Antwort des APIs:

<fcal_api>
<interface>fcal API 2.01</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>
<apiStatus>
<description>active</description>
</apiStatus>
<apiName>CheckDate/CH/BFS</apiName>
<date>2025-02-25</date>
<request>
<bfs>261</bfs>
<date>2025-12-25</date>
<charset>utf-8</charset>
<format>xml</format>
<date_format>Y-m-d</date_format>
<hl>de</hl>
</request>
<results>
<status>
<description>ok</description>
</status>
<location>
<description>Zürich</description>
<type>Stadt</type>
<geoId>3055</geoId>
<iso>CH</iso>
<iso-3166-2>CH-ZH</iso-3166-2>
<note></note>
<date_status>
<date>2025-12-25</date>
<total_population>433989</total_population>
<public_holiday_population>433989</public_holiday_population>
<public_holiday_percent>100</public_holiday_percent>
<public_holiday_description>Weihnachten</public_holiday_description>
<school_holiday_population>0</school_holiday_population>
<school_holiday_percent>0</school_holiday_percent>
<school_holiday_description></school_holiday_description>
<sum_population>433989</sum_population>
<sum_percent>100</sum_percent>
</date_status>
</location>
</results>
</fcal_api>

CSV

URL:
https://www.feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?api_key=YOUR_API_KEY&bfs=261&date=2025-12-25&format=csv

Antwort des APIs:

"location";"bfs";"iso";"iso-3166-2";"date";"total_population";"public_holiday_population";"public_holiday_percent";"public_holiday_description";"school_holiday_population";"school_holiday_percent";"school_holiday_description";"sum_population";"sum_percent"
"Zürich";"261";"CH";"CH-ZH";"2025-12-25";"433989";"433989";"100";"Weihnachten";"0";"0";"";"433989";"100"

Fehlermeldungen

Art der Ausgabe	Fehlermeldung	Erläuterung
results: status:
results: status: description	not subscribed	Sie haben die gewünschten Daten nicht abonniert.
results: status: description	unknown location	Die angeforderte BFS-Gemeindenummer ist nicht bekannt. Prüfen Sie bitte den Parameter bfs.
apiStatus
apiStatus: description	invalid usage	Die Verwendung dieses API ist für diesen Nutzer nicht freigeschaltet.
apiStatus: description	invalid key	Ungültiger API-Schlüssel.
apiStatus: description	invalid referer	Ungültiger Zugriff. Links ab Webseiten (Front-Ends) sind nicht zulässig.
apiStatus: description	inactive	Das API wurde für noch nicht zur Benutzung freigeschaltet.
apiStatus: description	expired	Die Nutzungsdauer nach Vertrag ist abgelaufen.

Entwickler-Ebene

Tagesdaten

Tagesstatus nach Datum auslesen

API: CheckDate/CH/BFS

Funktion

Interaktive Anleitung und OpenAPI

API-Kapitel

URL für Anfragen

Parameter für Anfragen

Beispiele (URL / PHP / Python / JavaScript)

Rückgabewerte des API

Beispiele (JSON / XML / CSV)

JSON

XML

CSV

Fehlermeldungen

Seiten

mehr von psc Informatik

Feiertagskalender.ch

Feiertagskalender unterstützen