API documentation

Function

Enables queries via CityId (ID of Feiertagskalender.ch). Outputs calendar year dates (holidays and school holidays). from 1.01. - 31.12. of a year.

The available CityIds can be found in the API: GeoTree/ISO

Chapters

URL for requests Parameters for requests Return values of the API Error messages Examples

URL for requests

URL

To retrieve the data, use the following URL.
Please pay attention to capital letters.

GET

POST

Parameters for requests

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
cityId required	CityID of the desired location. The CityID of Feiertagskalender.ch is used.	&cityid=88
year or jahr	Year of the desired data. Available according to contract Without specification: current calendar year (= default)	&year= 2027
class or klasse	Scope of the holidays by significance. Variants: 0 = only school holidays 3 = 0 + legally recognized holidays 4 = 0 + 3 + legal and non-recognised holidays (religious, cultural) (=standard) 5 = 0 + 3 + 4 + Event days (e.g. Valentine's Day, Mother's Day, Advent)	&klasse=5
charset	The desired encoding of the answer. 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 formatting of the PHP statement date(). Variants: Y-m-d = YYYY-MM-DD, according to 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	Desired output language. Variants: de (= default) fr it en	&hl=en

Return values of the API

Data

The contents of the API answers result from:
- the dates you subscribe to (countries, holidays, school holidays, calendar years)
- the official known data of the legislators
- availability based on our research (actual situation of our database)

Please note that the output in CSV format differs

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	Data/CityId
apiStatus	description			Description of the API status	active
date				Date of data export	22.01.2026
request:	cityId			CityId according to request	88
	year			Year of the data in the output	2015
	class			Class of the query, concerns scope of data, by significance	4
	charset			Font encoding of the output	utf-8
	format			Data format of the output	json
	date_format			Date format, according to request	d.m.Y
	hl			Output language	de
results	status	description		Output status	ok
	location	description		Name of the geographical unit	Berlin
		cityId		Id of the geographical unit (Id by Feiertagskalender.ch)	88
		iso		ISO country code, 2 digits	DE
		iso-3166-2		Region code according to ISO 3166-2	DE-BE
		events		the calendar events
			description	Name of the holiday, or school holidays	Neujahrstag
			id	Unique ID of the event	1
			dateStart	Start date of the event	01.01.2015
			dateEnd	End date of the event	01.01.2015
			class	Class of the event: 0 = school holidays 1 = legally recognized public holiday (public rest day) 2 = holiday equivalent to Sundays 3 = half, legally recognized holiday (usually from noon) 4 = not legally recognized public holiday (shops, schools, administrations mostly closed), bank holiday; For the purposes of the European Convention on the Calculation of Time Limits, this day is treated as a public holiday (Article 5). 5 = event day # = only partially valid	2
			percent	Percentage of inhabitants / school classes	100
			prov	Flag for provisional data 0 = definitely 1 = provisional	0
			note	Special notes

Error messages

Place of issue	Error message	Explanation
results: status: description	not subscribed	You have not subscribed to the required data. Please contact our support.
results: status: description	unknown location	The requested CityId is not known. Please check the parameter: cityId
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.

Examples

JSON

Call:
https://feiertagskalender.ch/api/Data/CityId/?api_key=YOUR_API_KEY&jahr=2015&date_format=d.m.Y&CityId=88

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": "Data/CityId",
	"apiStatus": {
		"description": "active"
	},
	"date": "04.08.2017",
	"request": {
		"cityId": "88",
		"year": "2015",
		"class": "4",
		"charset": "utf-8",
		"format": "json",
		"hl": "de"
	},
	"results": {
		"status": {
			"description": "ok"
		}, {	
		"location": {
			"description": "Berlin",
			"cityId": "88",
			"iso": "DE",
			"iso-3166-2": "DE-BE",
			"events": [{
				"description": "Neujahrstag",
				"id": "1",
				"dateStart": "01.01.2015",
				"dateEnd": "01.01.2015",
				"class": "1",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Karfreitag",
				"id": "17",
				"dateStart": "03.04.2015",
				"dateEnd": "03.04.2015",
				"class": "1",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Ostern",
				"id": "18",
				"dateStart": "05.04.2015",
				"dateEnd": "05.04.2015",
				"class": "4",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Ostermontag",
				"id": "19",
				"dateStart": "06.04.2015",
				"dateEnd": "06.04.2015",
				"class": "1",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Tag der Arbeit",
				"id": "22",
				"dateStart": "01.05.2015",
				"dateEnd": "01.05.2015",
				"class": "1",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Christi Himmelfahrt",
				"id": "31",
				"dateStart": "14.05.2015",
				"dateEnd": "14.05.2015",
				"class": "1",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Pfingsten",
				"id": "30",
				"dateStart": "24.05.2015",
				"dateEnd": "24.05.2015",
				"class": "4",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Pfingstmontag",
				"id": "35",
				"dateStart": "25.05.2015",
				"dateEnd": "25.05.2015",
				"class": "1",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Tag der Deutschen Einheit",
				"id": "92",
				"dateStart": "03.10.2015",
				"dateEnd": "03.10.2015",
				"class": "1",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Volkstrauertag",
				"id": "216",
				"dateStart": "15.11.2015",
				"dateEnd": "15.11.2015",
				"class": "4",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Weihnachten",
				"id": "23",
				"dateStart": "25.12.2015",
				"dateEnd": "25.12.2015",
				"class": "1",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Zweiter Weihnachtsfeiertag",
				"id": "37",
				"dateStart": "26.12.2015",
				"dateEnd": "26.12.2015",
				"class": "1",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Weihnachtsferien",
				"id": "119140",
				"dateStart": "22.12.2014",
				"dateEnd": "2.01.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Winterferien",
				"id": "119141",
				"dateStart": "2.02.2015",
				"dateEnd": "7.02.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Osterferien",
				"id": "119142",
				"dateStart": "30.03.2015",
				"dateEnd": "11.04.2015",
				"class": "0",
				"percent": "100",

				"prov": "0",
				"note": null
			}, {
				"description": "Ferientag",
				"id": "119143",
				"dateStart": "15.05.2015",
				"dateEnd": "15.05.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Ferientag",
				"id": "119144",
				"dateStart": "15.07.2015",
				"dateEnd": "15.07.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Sommerferien",
				"id": "119145",
				"dateStart": "16.07.2015",
				"dateEnd": "28.08.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Herbstferien",
				"id": "119146",
				"dateStart": "19.10.2015",
				"dateEnd": "31.10.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Weihnachtsferien",
				"id": "119147",
				"dateStart": "23.12.2015",
				"dateEnd": "2.01.2016",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}]
		}
	}
}

XML

Call:
https://feiertagskalender.ch/api/Data/CityId/?api_key=YOUR_API_KEY&jahr=2015&charset=iso-8859-1&date_format=d.m.Y&CityId=88&format=xml

Reply in XML / ISO-8859-1:

<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/CityId</apiName>		
	<date>04.08.2017</date>
	<request>
		<cityId>88</cityId>
		<year>2015</year>
		<class>4</class>
		<charset>utf-8</charset>
		<format>xml</format>
		<hl>de</hl>
	</request>
	<results>
		<status>
			<description>ok</description>
		</status>	
		<location>			
			<description>Berlin</description>
			<cityId>88</cityId>
			<iso>DE</iso>
			<iso-3166-2>DE-BE</iso-3166-2>
			<events>
				<event>
					<description>Neujahrstag</description>
					<id>1</id>
					<dateStart>01.01.2015</dateStart>
					<dateEnd>01.01.2015</dateEnd>
					<class>1</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Karfreitag</description>
					<id>17</id>
					<dateStart>03.04.2015</dateStart>
					<dateEnd>03.04.2015</dateEnd>
					<class>1</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Ostern</description>
					<id>18</id>
					<dateStart>05.04.2015</dateStart>
					<dateEnd>05.04.2015</dateEnd>
					<class>4</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Ostermontag</description>
					<id>19</id>
					<dateStart>06.04.2015</dateStart>
					<dateEnd>06.04.2015</dateEnd>
					<class>1</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Tag der Arbeit</description>
					<id>22</id>
					<dateStart>01.05.2015</dateStart>
					<dateEnd>01.05.2015</dateEnd>
					<class>1</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Christi Himmelfahrt</description>
					<id>31</id>
					<dateStart>14.05.2015</dateStart>
					<dateEnd>14.05.2015</dateEnd>
					<class>1</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Pfingsten</description>
					<id>30</id>
					<dateStart>24.05.2015</dateStart>
					<dateEnd>24.05.2015</dateEnd>
					<class>4</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Pfingstmontag</description>
					<id>35</id>
					<dateStart>25.05.2015</dateStart>
					<dateEnd>25.05.2015</dateEnd>
					<class>1</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Tag der Deutschen Einheit</description>
					<id>92</id>
					<dateStart>03.10.2015</dateStart>
					<dateEnd>03.10.2015</dateEnd>
					<class>1</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Volkstrauertag</description>
					<id>216</id>
					<dateStart>15.11.2015</dateStart>
					<dateEnd>15.11.2015</dateEnd>
					<class>4</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Weihnachten</description>
					<id>23</id>
					<dateStart>25.12.2015</dateStart>
					<dateEnd>25.12.2015</dateEnd>
					<class>1</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Zweiter Weihnachtsfeiertag</description>
					<id>37</id>
					<dateStart>26.12.2015</dateStart>
					<dateEnd>26.12.2015</dateEnd>
					<class>1</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Weihnachtsferien</description>
					<id>119140</id>
					<dateStart>22.12.2014</dateStart>
					<dateEnd>2.01.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Winterferien</description>
					<id>119141</id>
					<dateStart>2.02.2015</dateStart>
					<dateEnd>7.02.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Osterferien</description>
					<id>119142</id>
					<dateStart>30.03.2015</dateStart>
					<dateEnd>11.04.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Ferientag</description>
					<id>119143</id>
					<dateStart>15.05.2015</dateStart>
					<dateEnd>15.05.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Ferientag</description>
					<id>119144</id>
					<dateStart>15.07.2015</dateStart>
					<dateEnd>15.07.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Sommerferien</description>
					<id>119145</id>
					<dateStart>16.07.2015</dateStart>
					<dateEnd>28.08.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Herbstferien</description>
					<id>119146</id>
					<dateStart>19.10.2015</dateStart>
					<dateEnd>31.10.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Weihnachtsferien</description>
					<id>119147</id>
					<dateStart>23.12.2015</dateStart>
					<dateEnd>2.01.2016</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
			</events>
		</location>
	</results>
</fcal_api>

CSV

Call:
https://feiertagskalender.ch/api/Data/CityId/?api_key=YOUR_API_KEY&charset=iso-8859-1&jahr=2015&date_format=d.m.Y&cityId=88&format=csv

Reply in CSV / ISO-8859-1:

"location";"cityId";"iso";"iso-3166-2";"description";"id";"dateStart";"dateEnd";"class";"percent";"prov";"note"
"Berlin";"88";"DE";"DE-BE";"Neujahrstag";"1";"01.01.2015";"01.01.2015";"1";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Karfreitag";"17";"03.04.2015";"03.04.2015";"1";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Ostern";"18";"05.04.2015";"05.04.2015";"4";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Ostermontag";"19";"06.04.2015";"06.04.2015";"1";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Tag der Arbeit";"22";"01.05.2015";"01.05.2015";"1";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Christi Himmelfahrt";"31";"14.05.2015";"14.05.2015";"1";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Pfingsten";"30";"24.05.2015";"24.05.2015";"4";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Pfingstmontag";"35";"25.05.2015";"25.05.2015";"1";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Tag der Deutschen Einheit";"92";"03.10.2015";"03.10.2015";"1";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Volkstrauertag";"216";"15.11.2015";"15.11.2015";"4";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Weihnachten";"23";"25.12.2015";"25.12.2015";"1";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Zweiter Weihnachtsfeiertag";"37";"26.12.2015";"26.12.2015";"1";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Weihnachtsferien";"119140";"22.12.2014";"2.01.2015";"0";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Winterferien";"119141";"2.02.2015";"7.02.2015";"0";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Osterferien";"119142";"30.03.2015";"11.04.2015";"0";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Ferientag";"119143";"15.05.2015";"15.05.2015";"0";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Ferientag";"119144";"15.07.2015";"15.07.2015";"0";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Sommerferien";"119145";"16.07.2015";"28.08.2015";"0";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Herbstferien";"119146";"19.10.2015";"31.10.2015";"0";"100";"0";""
"Berlin";"88";"DE";"DE-BE";"Weihnachtsferien";"119147";"23.12.2015";"2.01.2016";"0";"100";"0";""

Read annual data for 1 location using CityId

API: Data/CityId

URL for requests

Parameters for requests

Return values of the API

Error messages

Examples

Examples

JSON

XML

CSV

Folgen Sie uns auf Facebook

Feiertagskalender.ch

Advertisement

Pages

Partner projects