API documentation

Daily data

Read out day status by date

Daily information whether there is a public holiday and/or school holidays on this date.

API: CheckDate/GeoId

Chapters:

API: CheckDate/GeoId

Function

Enables queries by means of Geo-ID (ID from Feiertagskalender.ch) and date. Indicates whether and to what percentage a public holiday applies on this day, or whether there are school holidays.

The available Geo-IDs can be found in the API: GeoTree/ISO

URL for requests

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

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
geoId
required
Geo-ID of the desired locality. The Geo-ID of Feiertagskalender.ch &geoid=88
date

Date of the requested data

without specification: today (= default)

&date=2022-09-17
class
or
klasse

Scope of the data

Variants:
0 = school holidays only
3 = 0 + public holidays recognised by law
4 = 0 + 3 + public and non-statutory holidays (religious, cultural) (= default)
5 = 0 + 3 + 4 + event days (e.g. Valentine's Day, Mother's Day, Advent Sundays)

&klasse=5
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
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
hl

Desired language of the output

Variants:
de = German (= default)
fr = French
it = Italian
en = English

&hl=en

Return values of the API

The contents of the API responses result from:
- the data you have subscribed to (countries, public holidays, school holidays, calendar years)
- the officially known data of the legislators
- the availability based on our research (ACTUAL situation of our database)

Please note that the output in CSV format differs.

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 CheckDate/GeoId
apiStatus description       Designation of the API status. For variants, see the Error messages active
date         Date of the data export 17.08.2022
request: geoId       Geo-ID according to request 410
  date       Date of the data in the output 2019-02-28
  charset       Font coding of the output utf-8
  format       Output data format json
  date_format       Output date format d.m.Y
  hl       Language of issue, according to request en
results status description     Output status. For variants, see the Error messages ok
  location description     Designation of the geographical unit Zurich
    type     Designation of the type of geographical unit Canton
    geoId     Geo-ID of the geographical unit. 2872
    iso     ISO country code, 2 digits CH
    iso-3166-2     Region code according to ISO 3166-2 CH-ZH
    date_status     Day status  
      date   Date 2019-02-28
      total_population   Total number of inhabitants 1502167
      public_holiday_population   Number of inhabitants with public holiday 0
      public_holiday_percent   Percent Inhabitants with public holiday 0
      public_holiday_description   Designation of the public holiday
      school_holiday_population   Number of inhabitants with school holidays 501752
      school_holiday_percent   Percent Inhabitants with school holidays 33.4018787524955
      school_holiday_description   Designation school holidays Sportferien
      sum_population   Total number of inhabitants affected 501752
      percent_population   Percentage of inhabitants affected 33.4018787524955

Error messages

Output location Error message Explanation
results: status:
results: status: description not subscribed You have not subscribed to the desired data.
Please contact our support.
results: status: description unknown location The requested Geo-ID is not known.
Please check the parameter geoId
apiStatus
apiStatus: description invalid usage The use of this API is not activated 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 web pages (front-ends) are not allowed.
Set up your query so that it comes from a protected back-end.
If necessary, contact our support.
apiStatus: description inactive The API has not yet been activated for you to use.
Please try again at a later date.
apiStatus: description expired The period of use according to the contract has expired.
Contact our administration for a contract extension.

Examples

JSON

URL:
https://feiertagskalender.ch/api/CheckDate/GeoId/?api_key=YOUR_API_KEY&geoId=2872&date=2019-02-28

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 Bern"
   },
   "apiName":"CheckDate/GeoId",
   "apiStatus":{
      "description":"active"
   },
   "date":"2022-08-17",
   "request":{
      "geoId":"2872",
      "date":"2019-02-28",
      "charset":"utf-8",
      "format":"json",
      "date_format":"Y-m-d",
      "hl":"de"
   },
   "results":{
      "status":{
         "description":"ok"
      },
      "location":{
         "description":"Zürich",
         "type":"Kanton",
         "geoId":"2872",
         "iso":"CH",
         "iso-3166-2":"CH-ZH",
         "date_status":{
            "date":"2019-02-28",
            "total_population":1502167,
            "public_holiday_population":0,
            "public_holiday_percent":0,
            "public_holiday_description":null,
            "school_holiday_population":501752,
            "school_holiday_percent":33.401878752495563,
            "school_holiday_description":"Sportferien",
            "sum_population":501752,
            "sum_percent":33.401878752495563
         }
      }
   }
}
					

XML

URL:
https://feiertagskalender.ch/api/CheckDate/GeoId/?api_key=YOUR_API_KEY&charset=iso-8859-1&geoId=2872&date=2019-02-28&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>
	<apiStatus>
		<description>active</description>
	</apiStatus>
	<apiName>CheckDate/GeoId</apiName>
	<date>2022-08-17</date>
	<request>
		<geoId>2872</geoId>
		<date>2019-02-28</date>
		<charset>iso-8859-1</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>Kanton</type>
			<geoId>2872</geoId>
			<iso>CH</iso>
			<iso-3166-2>CH-ZH</iso-3166-2>
			<date_status>
				<date>2019-02-28</date>
				<total_population>1502167</total_population>
				<public_holiday_population>0</public_holiday_population>
				<public_holiday_percent>0</public_holiday_percent>
				<public_holiday_description></public_holiday_description>
				<school_holiday_population>501752</school_holiday_population>
				<school_holiday_percent>33.401878752496</school_holiday_percent>
				<school_holiday_description>Sportferien</school_holiday_description>
				<sum_population>501752</sum_population>
				<sum_percent>33.401878752496</sum_percent>
			</date_status>
		</location>
	</results>
</fcal_api>                  

CSV

URL:
https://feiertagskalender.ch/api/Data/GeoId/?api_key=YOUR_API_KEY&charset=iso-8859-1&jahr=2015&date_format=d.m.Y&geoId=410&format=csv

Response from the API:

"location";"geoId";"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";"2872";"CH";"CH-ZH";"2019-02-28";"1502167";"0";"0";"";"501752";"33.401878752496";"Sportferien";"501752";"33.401878752496"
Pages
Partner projects
©2003 - 2022 psc Peter Schütz Informatik Dienstleistungen, CH-Bern