API documentation

Annual data

Read out aggregated annual data

Data sets with public holiday/school holiday percentages for each day of a year.

using ISO country code

API: Data/Aggreg

Chapters:

URL for requests Request parameters Return values of the API Error messages Examples

API: Data/Aggreg

Function

Enables queries of aggregated annual data by ISO country code or ISO-3166-2 region code.

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
iso
required		 ISO country code, 2 digits, or
Region code according to ISO 3166-2		 &iso=DE-BW
year
or
jahr

Year of the requested dates

without specification: current calendar year (= default)

 &year= 2024
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
compact

Flag for compact data output

Variants:
0 = Output includes all days of the year, even if no event occurs.
1 = Output only includes days on which school holidays, and/or a public holiday occurs. (= default)

 &compact=0
filter Filter setting for public holidays in percent

Variants:
0 = the output contains all registered holidays
5 = The output only contains public holidays whose share is > 5% (= default)
The filtering works with integer numbers from 0 to 100. 		&filter=0

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 Data/Aggreg
apiStatus description       Designation of the API status. For variants, see the Error messages active
date         Date of the data export 04.10.2023
request: iso       ISO country code, 2 digits DE
  year       Year of the data in the output 2015
  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
  compact       Flag für kompakte Ausgabe, gemäss Anfrage 1
  filter       Filterwert für Unterdrückung der Ausgabe von Feiertagen 0
results status description     Output status. For variants, see the Error messages ok
  location description     Designation of the geographical unit Deutschland
    type     Designation of the type of geographical unit Land
    geoId     Geo-ID of the geographical unit. 3059
    iso     ISO country code, 2 digits DE
    iso-3166-2     Region code according to ISO 3166-2  
    calendar     die Kalenderausgabe  
      date   Datum des Kalenders 2019-01-06
      total_population   Anzahl Einwohner im gewählten Gebiet 81835000
      public_holiday_population   Anzahl Einwohner, betroffen von einem Feiertag 25346076
      public_holiday_percent   Prozentualer Anteil der Einwohner, betroffen von einem Feiertag 30.97217083155129
      public_holiday_description   Bezeichnung Feiertag Heilige drei Könige
      school_holiday_population   Anzahl Einwohner, betroffen von Schulferien 81835000
      school_holiday_percent   Prozentualer Anteil der Einwohner, betroffen von Schulferien 100
      school_holiday_description   Designation school holidays Weihnachtsferien
      sum_population   Summe aus public_holiday_population und school_holiday_population 81835000
      sum_percent   Summe aus public_holiday_percent und school_holiday_percent 100

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 Das angeforderte ISO-Länderkürzel ist nicht bekannt.
Prüfen Sie bitte den Parameter iso
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/Data/Aggreg/?api_key=YOUR_API_KEY&iso=DE&charset=ISO8859-1

Antwort in JSON / ISO8859-1:

{
   "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":"Data/Aggreg",
   "apiStatus":{
      "description":"active"
   },
   "date":"2023-10-04",
   "request":{
      "iso":"DE",
      "year":"2019",
      "charset":"iso8859-1",
      "format":"json",
      "date_format":"Y-m-d",
	   "hl":"de",
      "compact":"1",
      "filter":"5"
   },
   "results":{
      "status":{
         "description":"ok"
      },
      "location":{
         "description":"Deutschland",
         "type":"Land",
         "geoId":"3059",
         "iso":"DE",
         "iso-3166-2":"",
         "calendar":[
            {
               "datum":"2019-01-01",
               "total_population":81835000,
               "public_holiday_population":81835000,
               "public_holiday_percent":100,
               "public_holiday_description":"Neujahr",
               "school_holiday_population":81835000,
               "school_holiday_percent":100,
               "school_holiday_description":"Weihnachtsferien",
               "sum_population":81835000,
               "sum_percent":100
            },
            {
               "datum":"2019-01-02",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":81835000,
               "school_holiday_percent":100,
               "school_holiday_description":"Weihnachtsferien",
               "sum_population":81835000,
               "sum_percent":100
            },
            {
               "datum":"2019-01-03",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":81835000,
               "school_holiday_percent":100,
               "school_holiday_description":"Weihnachtsferien",
               "sum_population":81835000,
               "sum_percent":100
            },
            {
               "datum":"2019-01-04",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":81835000,
               "school_holiday_percent":100,
               "school_holiday_description":"Weihnachtsferien",
               "sum_population":81835000,
               "sum_percent":100
            },
            {
               "datum":"2019-01-05",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":81835000,
               "school_holiday_percent":100,
               "school_holiday_description":"Weihnachtsferien",
               "sum_population":81835000,
               "sum_percent":100
            },
            {
               "datum":"2019-01-06",
               "total_population":81835000,
               "public_holiday_population":25346076,
               "public_holiday_percent":30.972170831551292,
               "public_holiday_description":"Heilige drei Könige",
               "school_holiday_population":81835000,
               "school_holiday_percent":100,
               "school_holiday_description":"Weihnachtsferien",
               "sum_population":81835000,
               "sum_percent":100
            },
            {
               "datum":"2019-01-31",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":8528242,
               "school_holiday_percent":10.421264740025661,
               "school_holiday_description":"Semesterferien",
               "sum_population":8528242,
               "sum_percent":10.421264740025661
            },
            {
               "datum":"2019-02-01",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":10358673,
               "school_holiday_percent":12.657998411437649,
               "school_holiday_description":"Semesterferien",
               "sum_population":10358673,
               "sum_percent":12.657998411437649
            },
            {
               "datum":"2019-02-02",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":18064053,
               "school_holiday_percent":22.073749618134052,
               "school_holiday_description":"Winterferien",
               "sum_population":18064053,
               "sum_percent":22.073749618134052
            },
            {
               "datum":"2019-02-03",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":18064053,
               "school_holiday_percent":22.073749618134052,
               "school_holiday_description":"Winterferien",
               "sum_population":18064053,
               "sum_percent":22.073749618134052
            },
            {
               "datum":"2019-02-04",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":7705380,
               "school_holiday_percent":9.4157512066964024,
               "school_holiday_description":"Winterferien",
               "sum_population":7705380,
               "sum_percent":9.4157512066964024
            },
            {
               "datum":"2019-02-05",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":7705380,
               "school_holiday_percent":9.4157512066964024,
               "school_holiday_description":"Winterferien",
               "sum_population":7705380,
               "sum_percent":9.4157512066964024
            },
            {
               "datum":"2019-02-06",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":7705380,
               "school_holiday_percent":9.4157512066964024,
               "school_holiday_description":"Winterferien",
               "sum_population":7705380,
               "sum_percent":9.4157512066964024
            },
            {
               "datum":"2019-02-07",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":7705380,
               "school_holiday_percent":9.4157512066964024,
               "school_holiday_description":"Winterferien",
               "sum_population":7705380,
               "sum_percent":9.4157512066964024
            },
            {
               "datum":"2019-02-08",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":7705380,
               "school_holiday_percent":9.4157512066964024,
               "school_holiday_description":"Winterferien",
               "sum_population":7705380,
               "sum_percent":9.4157512066964024
            },
            {
               "datum":"2019-02-09",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":12099760,
               "school_holiday_percent":14.785556302315635,
               "school_holiday_description":"Winterferien",
               "sum_population":12099760,
               "sum_percent":14.785556302315635
            },
            {
               "datum":"2019-02-10",
               "total_population":81835000,
               "public_holiday_population":0,
               "public_holiday_percent":0,
               "public_holiday_description":"",
               "school_holiday_population":12099760,
               "school_holiday_percent":14.785556302315635,
               "school_holiday_description":"Winterferien",
               "sum_population":12099760,
               "sum_percent":14.785556302315635
            },
            ...
         ]
      }
   }
}

XML

URL:
https://feiertagskalender.ch/api/Data/Aggreg/?api_key=YOUR_API_KEY&iso=DE&charset=ISO8859-1&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>Data/Aggreg</apiName>
	<date>2023-10-04</date>
	<request>
		<iso>DE</iso>
		<year>2019</year>
		<charset>iso8859-1</charset>
		<format>xml</format>
		<date_format>Y-m-d</date_format>
		<hl>de</hl>
		<compact>1</compact>
		<filter>5</filter>
	</request>
	<results>
		<status>
			<description>ok</description>
		</status>
		<location>
			<description>Deutschland</description>
			<type>Land</type>
			<geoId>3059</geoId>
			<iso>DE</iso>
			<iso-3166-2/>
			<events>
				<day>
					<datum>2019-01-01</datum>
					<total_population>81835000</total_population>
					<public_holiday_population>81835000</public_holiday_population>
					<public_holiday_percent>100</public_holiday_percent>
					<public_holiday_description>Neujahr</public_holiday_description>
					<school_holiday_population>81835000</school_holiday_population>
					<school_holiday_percent>100</school_holiday_percent>
					<school_holiday_description>Weihnachtsferien</school_holiday_description>
					<sum_population>81835000</sum_population>
					<sum_percent>100</sum_percent>
				</day>
				<day>
					<datum>2019-01-02</datum>
					<total_population>81835000</total_population>
					<public_holiday_population>0</public_holiday_population>
					<public_holiday_percent>0</public_holiday_percent>
					<public_holiday_description/>
					<school_holiday_population>81835000</school_holiday_population>
					<school_holiday_percent>100</school_holiday_percent>
					<school_holiday_description>Weihnachtsferien</school_holiday_description>
					<sum_population>81835000</sum_population>
					<sum_percent>100</sum_percent>
				</day>
				<day>
					<datum>2019-01-03</datum>
					<total_population>81835000</total_population>
					<public_holiday_population>0</public_holiday_population>
					<public_holiday_percent>0</public_holiday_percent>
					<public_holiday_description/>
					<school_holiday_population>81835000</school_holiday_population>
					<school_holiday_percent>100</school_holiday_percent>
					<school_holiday_description>Weihnachtsferien</school_holiday_description>
					<sum_population>81835000</sum_population>
					<sum_percent>100</sum_percent>
				</day>
				<day>
					<datum>2019-01-04</datum>
					<total_population>81835000</total_population>
					<public_holiday_population>0</public_holiday_population>
					<public_holiday_percent>0</public_holiday_percent>
					<public_holiday_description/>
					<school_holiday_population>81835000</school_holiday_population>
					<school_holiday_percent>100</school_holiday_percent>
					<school_holiday_description>Weihnachtsferien</school_holiday_description>
					<sum_population>81835000</sum_population>
					<sum_percent>100</sum_percent>
				</day>
				<day>
					<datum>2019-01-05</datum>
					<total_population>81835000</total_population>
					<public_holiday_population>0</public_holiday_population>
					<public_holiday_percent>0</public_holiday_percent>
					<public_holiday_description/>
					<school_holiday_population>81835000</school_holiday_population>
					<school_holiday_percent>100</school_holiday_percent>
					<school_holiday_description>Weihnachtsferien</school_holiday_description>
					<sum_population>81835000</sum_population>
					<sum_percent>100</sum_percent>
				</day>
				<day>
					<datum>2019-01-06</datum>
					<total_population>81835000</total_population>
					<public_holiday_population>25346076</public_holiday_population>
					<public_holiday_percent>30.972170831551</public_holiday_percent>
					<public_holiday_description>Heilige drei Könige</public_holiday_description>
					<school_holiday_population>81835000</school_holiday_population>
					<school_holiday_percent>100</school_holiday_percent>
					<school_holiday_description>Weihnachtsferien</school_holiday_description>
					<sum_population>81835000</sum_population>
					<sum_percent>100</sum_percent>
				</day>
				<day>
					<datum>2019-01-31</datum>
					<total_population>81835000</total_population>
					<public_holiday_population>0</public_holiday_population>
					<public_holiday_percent>0</public_holiday_percent>
					<public_holiday_description/>
					<school_holiday_population>8528242</school_holiday_population>
					<school_holiday_percent>10.421264740026</school_holiday_percent>
					<school_holiday_description>Semesterferien</school_holiday_description>
					<sum_population>8528242</sum_population>
					<sum_percent>10.421264740026</sum_percent>
				</day>
				<day>
					<datum>2019-02-01</datum>
					<total_population>81835000</total_population>
					<public_holiday_population>0</public_holiday_population>
					<public_holiday_percent>0</public_holiday_percent>
					<public_holiday_description/>
					<school_holiday_population>10358673</school_holiday_population>
					<school_holiday_percent>12.657998411438</school_holiday_percent>
					<school_holiday_description>Semesterferien</school_holiday_description>
					<sum_population>10358673</sum_population>
					<sum_percent>12.657998411438</sum_percent>
				</day>
				...
			</events>
		</location>
	</results>
</fcal_api>

CSV

URL:
https://feiertagskalender.ch/api/Data/Aggreg/?api_key=YOUR_API_KEY&iso=DE&format=csv

Antwort in CSV / UTF-8:

"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"
"Deutschland";"3059";"DE";"";"2019-01-01";"81835000";"81835000";"100";"Neujahr";"81835000";"100";"Weihnachtsferien";"81835000";"100"
"Deutschland";"3059";"DE";"";"2019-01-02";"81835000";"0";"0";"";"81835000";"100";"Weihnachtsferien";"81835000";"100"
"Deutschland";"3059";"DE";"";"2019-01-03";"81835000";"0";"0";"";"81835000";"100";"Weihnachtsferien";"81835000";"100"
"Deutschland";"3059";"DE";"";"2019-01-04";"81835000";"0";"0";"";"81835000";"100";"Weihnachtsferien";"81835000";"100"
"Deutschland";"3059";"DE";"";"2019-01-05";"81835000";"0";"0";"";"81835000";"100";"Weihnachtsferien";"81835000";"100"
"Deutschland";"3059";"DE";"";"2019-01-06";"81835000";"25346076";"30.972170831551";"Heilige drei Könige";"81835000";"100";"Weihnachtsferien";"81835000";"100"
"Deutschland";"3059";"DE";"";"2019-01-31";"81835000";"0";"0";"";"8528242";"10.421264740026";"Semesterferien";"8528242";"10.421264740026"
"Deutschland";"3059";"DE";"";"2019-02-01";"81835000";"0";"0";"";"10358673";"12.657998411438";"Semesterferien";"10358673";"12.657998411438"
"Deutschland";"3059";"DE";"";"2019-02-02";"81835000";"0";"0";"";"18064053";"22.073749618134";"Winterferien";"18064053";"22.073749618134"
"Deutschland";"3059";"DE";"";"2019-02-03";"81835000";"0";"0";"";"18064053";"22.073749618134";"Winterferien";"18064053";"22.073749618134"
"Deutschland";"3059";"DE";"";"2019-02-04";"81835000";"0";"0";"";"7705380";"9.4157512066964";"Winterferien";"7705380";"9.4157512066964"
"Deutschland";"3059";"DE";"";"2019-02-05";"81835000";"0";"0";"";"7705380";"9.4157512066964";"Winterferien";"7705380";"9.4157512066964"
"Deutschland";"3059";"DE";"";"2019-02-06";"81835000";"0";"0";"";"7705380";"9.4157512066964";"Winterferien";"7705380";"9.4157512066964"
"Deutschland";"3059";"DE";"";"2019-02-07";"81835000";"0";"0";"";"7705380";"9.4157512066964";"Winterferien";"7705380";"9.4157512066964"
"Deutschland";"3059";"DE";"";"2019-02-08";"81835000";"0";"0";"";"7705380";"9.4157512066964";"Winterferien";"7705380";"9.4157512066964"
"Deutschland";"3059";"DE";"";"2019-02-09";"81835000";"0";"0";"";"12099760";"14.785556302316";"Winterferien";"12099760";"14.785556302316"
"Deutschland";"3059";"DE";"";"2019-02-10";"81835000";"0";"0";"";"12099760";"14.785556302316";"Winterferien";"12099760";"14.785556302316"
"Deutschland";"3059";"DE";"";"2019-02-11";"81835000";"0";"0";"";"6003981";"7.3366909024256";"Winterferien";"6003981";"7.3366909024256"
"Deutschland";"3059";"DE";"";"2019-02-12";"81835000";"0";"0";"";"6003981";"7.3366909024256";"Winterferien";"6003981";"7.3366909024256"
"Deutschland";"3059";"DE";"";"2019-02-13";"81835000";"0";"0";"";"6003981";"7.3366909024256";"Winterferien";"6003981";"7.3366909024256"
"Deutschland";"3059";"DE";"";"2019-02-14";"81835000";"81835000";"100";"Valentinstag";"6003981";"7.3366909024256";"Winterferien";"81835000";"100"
...
Pages
Partner projects
©2003 - 2023 psc Peter Schütz Informatik Dienstleistungen, CH-Bern