API Dokumentation

Alle Daten auf Open Parliament TV können über unsere Open Data API abgefragt werden. There is currently no limit on requests nor do you need an api key. But please get in touch if you plan to copy our entire dataset. Instead of making millions of api requests you can just get an SQL dump from us.

Endpoint

/api/v1/search/media?

Beispiel Request

(Redebeiträge containing the query "Rente" by Faction SPD from 11.04.2018 until today)

URI

Parameters

Parameter	Validation	Matches	Type
q	min 3 chars	Full Text Search	String
parliament	min 2 chars		String
electoralPeriod	min 1 char	electoralPeriod.data.attributes.number	String
electoralPeriodID	min 1 char	electoralPeriod.data.id	String
sessionID	min 1 char	session.data.id	String
sessionNumber	min 1 char	session.data.attributes.number	String
dateFrom	date in ISO format (ex. "2017-10-28")	dateStart	String
dateTo	date in ISO format (ex. "2017-12-22")	dateStart	String
party	min 1 char	people.data.attributes.party.labelAlternative	String OR Array
partyID	min 1 char	organisations.data.id	String OR Array
faction	min 1 char	people.data.attributes.faction.labelAlternative	String OR Array
factionID	min 1 char	organisations.data.id	String OR Array
person	min 3 chars	people.data.attributes.label	String
personID	Wikidata ID RegEx	people.data.id	String OR Array
abgeordnetenwatchID	min 1 char	people.data.attributes.additionalInformation.abgeordnetenwatchID	String
organisationID	Wikidata ID RegEx	people.data.attributes.party.id, people.data.attributes.faction.id	String
context	min 3 chars	people.data.attributes.context, organisations.data.attributes.context	String
agendaItemID	min 2 chars	agendaItem.data.id	String
documentID	min 1 char	documents.data.id	String
termID	min 1 char	terms.data.id	String
id	min 4 chars	id	String
agendaItemTitle	min 3 chars	agendaItem.data.attributes.title	String
aligned	boolean	Filter by alignment status	Boolean
fragDenStaatID	min 1 char	FragDenStaat ID	String
numberOfTexts	integer	Number of text segments	Integer
organisation	min 3 chars	Organisation name	String
personOriginID	min 1 char	Person origin identifier	String
procedureID	min 1 char	Procedure identifier	String
limit	integer	Maximum number of results to return	Integer
page	integer	Page number for pagination	Integer
sort	date-asc, date-desc, topic-asc, topic-desc, duration-asc, duration-desc, changed-asc, changed-desc	Sort results by date, duration, or last changed timestamp (defaults to relevance)	String
fields	comma-separated values	Return only specified fields (e.g., "id" for ID-only results)	String

Endpoint

/api/v1/search/people?

Beispiel Request

(Personen with name "Michael" in the Party "SPD")

URI

Parameters

Parameter	Validation	Matches	Type
name	min 3 chars	label, firstName, lastName	String
type	"memberOfParliament", "unknown"	type	String
party	min 1 char	organisation.label, organisation.labelAlternative	String OR Array
partyID	Wikidata ID RegEx	partyOrganisationID	String OR Array
faction	min 1 char	organisation.label, organisation.labelAlternative	String OR Array
factionID	Wikidata ID RegEx	factionOrganisationID	String OR Array
organisationID	Wikidata ID RegEx	factionOrganisationID, partyOrganisationID	String
degree	min 1 char	degree	String
gender	"male", "female", "nonbinary", "bi", "queer"	gender	String
originID	min 1 char	originID	String
abgeordnetenwatchID	min 1 char	additionalInformation.abgeordnetenwatchID	String
fragDenStaatID	min 1 char	FragDenStaat ID	String

Please note that in the Open Parliament TV data model parties and factions as well as other types of bodies like companies or NGOs are all "organisations". They can be filtered via the "type" parameter (eg. type=faction or type=party).

Endpoint

/api/v1/search/organisations?

Beispiel Request

(Organisationen with name "Linke")

URI

Parameters

Parameter	Validation	Matches	Type
name	min 3 chars	label, labelAlternative, abstract	String OR Array
type	min 2 chars	type	String

Please note that documents can be official documents ("Drucksachen") as well as law texts and potentially other types of documents, sometimes applying to a specific parliament, sometimes generic, sometimes having a Wikidata ID, sometimes not. This is why the document ID is not based on the official document number or the Wikidata ID but an internal incremental ID. To filter documents of a certain type, use the "type" parameter (eg. type=officialDocument or type=legalDocument).

Endpoint

/api/v1/search/documents?

Beispiel Request

(Dokumente with label "19/5412", returns "Drucksache 19/5412" as well as documents where "19/5412" is mentioned in the titles or abstact)

URI

Parameters

Parameter	Validation	Matches	Type
label	min 3 chars	label, labelAlternative, abstract	String OR Array
type	min 2 chars	type	String
wikidataID	Wikidata ID RegEx	wikidataID	String

Endpoint

/api/v1/search/terms?

Beispiel Request

(Begriffe with label "digital")

URI

Parameters

Parameter	Validation	Matches	Type
label	min 3 chars	label, labelAlternative	String OR Array
type	min 2 chars	type	String
wikidataID	Wikidata ID RegEx	wikidataID	String

Entity URIs are based on the respective platform URL and can be formed by simply adding /api/v1 before the entity part.

Beispiel:
https://de.openparliament.tv/person/Q567
https://de.openparliament.tv/api/v1/person/Q567

GET Redebeitrag

Media IDs contain info about the parliament, electoral period and session. You should however not try to guess those IDs (eg. based on the order of speeches). This might work in some cases, it will not in many others.

Endpoint: /api/v1/media/ID

Beispiel: Redebeitrag

URI

GET Person

Person IDs are always a Wikidata ID.

Endpoint: /api/v1/person/ID

Beispiel: Angela Merkel (Wikidata ID Q567)

URI

GET Organisation

Organisation IDs are always a Wikidata ID.

Endpoint: /api/v1/organisation/ID

Beispiel: Fraktion/Gruppe BÜNDNIS 90/DIE GRÜNEN (Wikidata ID Q1007353)

URI

GET Dokument

Dokument IDs are internal incremental IDs and contain no reference to the document numbers (like "Drucksache 19/1234"). The rationale for this is that documents can be official documents as well as law texts and potentially other types of documents, sometimes applying to a specific parliament, sometimes generic, sometimes having a Wikidata ID, sometimes not. If you want to get a document by its official document number, you can use the document search.

Endpoint: /api/v1/document/ID

Beispiel: Drucksache 19/1184

URI

GET Begriff

Begriff IDs are always a Wikidata ID.

Endpoint: /api/v1/term/ID

URI

GET Wahlperiode

Wahlperiode IDs can safely be referenced by the parliament shortcode plus the respective number.

Endpoint: /api/v1/electoralPeriod/ID

Beispiel: Wahlperiode 19 of the German Bundestag (ID: "DE-019")

URI

GET Sitzung

Sitzung IDs can safely be referenced by the parliament shortcode plus the respective numbers.

Endpoint: /api/v1/session/ID

Beispiel: Sitzung 61 in Wahlperiode 19 of the German Bundestag (ID: "DE-0190061")

URI

GET Tagesordnungspunkt

Tagesordnungspunkt IDs are built of the parliament shortcode and an incremental ID. You should not try to guess those IDs (eg. based on the order of agenda items). This might work in some cases, it will not in many others.

Endpoint: /api/v1/agendaItem/ID

Beispiel: Tagesordnungspunkt "Gesetzliche Rentenversicherung" in Sitzung 61 in Wahlperiode 19 of the German Bundestag (ID: "DE-454")

URI

Statistics endpoints provide aggregated insights into parliamentary data, including speaker activity, word frequency analysis, entity relationships, and political discourse patterns.

Endpoint

/api/v1/statistics/general

Beispiel Request

(General statistics showing speeches, speakers, speaking time, and vocabulary across all parliaments)

URI

Parameters

Parameter	Validation	Description	Type
parliament	Optional, defaults to "de"	Parliament code for multi-parliament support	String

For person entities, this endpoint automatically includes speaker vocabulary statistics (total words, unique words, and top words with usage frequency).

Endpoint

/api/v1/statistics/entity

Beispiel Request

(Statistics for person Angela Merkel, showing associations, trends, and vocabulary)

URI

Parameters

Parameter	Validation	Description	Type
entityType	Required: person, organisation, document, term	Type of entity to analyze	String
entityID	Required: Wikidata ID RegEx or internal ID	ID of specific entity to analyze	String

Endpoint

/api/v1/statistics/word-trends

Beispiel Request

(Word trends for "heute" and "wollen" from 2020 to 2024, optionally filtered by faction)

URI

Parameters

Parameter	Validation	Description	Type
words[]	Required: array of words	Words to track over time	Array
startDate	Optional, defaults to '2020-01-01'	Start date in YYYY-MM-DD format	String
endDate	Optional, defaults to current date	End date in YYYY-MM-DD format	String
parliament	Optional, defaults to 'de'	Parliament code for multi-parliament support	String
factions[]	Optional, array of Wikidata IDs	Filter word trends by specific political factions	Array
separateByFaction	Optional, boolean	Separate results by faction when true	Boolean

Endpoint

/api/v1/statistics/entity-counts

Beispiel Request

(Get counts of all entity types in the database)

URI

Parameters

Parameter	Validation	Description	Type

The API structure is based on the JSON:API Specification. Whether or not we will fully implement the standard (also for PATCH requests / data updates) is to be discussed.

Paths

API Dokumentation
/api

API Endpoint Base URL
/api/v1

API Responses

Responses MUST include the following properties for any request (GET and POST):

{
  "meta": {
	"api": {
	  "version": "1.0",
	  "documentation": "https://de.openparliament.tv/api",
	  "license": {
		"label": "ODC Open Database License (ODbL) v1.0",
		"link": "https://opendatacommons.org/licenses/odbl/1-0/"
	  }
	},
	"requestStatus": "success" // OR "error"
  },
  "data": [], // {} OR []
  "errors": [], // EITHER "data" OR "errors"
  "links": {
	"self": "https://de.openparliament.tv/api/v1/search/media?q=Rente" // request URL
  }
}

Successful requests MUST include the following properties:

{
  "meta": {
	"api": {
	  "version": "1.0",
	  "documentation": "https://de.openparliament.tv/api",
	  "license": {
		"label": "ODC Open Database License (ODbL) v1.0",
		"link": "https://opendatacommons.org/licenses/odbl/1-0/"
	  }
	},
	"requestStatus": "success"
  },
  "data": {},
  "links": {
	"self": "https://de.openparliament.tv/api/v1/search/media?q=Rente" // request URL
  }
}

Errors MUST include the following properties:

{
  "meta": {
	"api": {
	  "version": "1.0",
	  "documentation": "https://de.openparliament.tv/api",
	  "license": {
		"label": "ODC Open Database License (ODbL) v1.0",
		"link": "https://opendatacommons.org/licenses/odbl/1-0/"
	  }
	},
	"requestStatus": "error"
  },
  "errors": [
	{
	  "meta": {
		"domSelector": "" // optional
	  },
	  "status": "422", // HTTP Status   
	  "code": "3", 
	  "title":  "Invalid Attribute",
	  "detail": "First name must contain at least three characters."
	}
  ],
  "links": {
	"self": "https://de.openparliament.tv/api/v1/search/media?q=Rente" // request URL
  }
}

Data Objects

Data Objects MUST always include the properties:

id
type
attributes (data item specific properties)

Additionally Data Objects CAN include the properties:

links ("self" = link to the respective API request URL)
relationships (properties derived from other data items)

Depending on the context, the attributes object can only include a subset of all properties. The full set can then be retrieved via an API request to links > self.

This principle SHOULD be applied on all levels of the data structure.

Examples

Example for an Entity Response:

{
  "meta": {
	"api": {
	  "version": "1.0",
	  "documentation": "https://de.openparliament.tv/api",
	  "license": {
		"label": "ODC Open Database License (ODbL) v1.0",
		"link": "https://opendatacommons.org/licenses/odbl/1-0/"
	  }
	},
	"requestStatus": "success"
  },
  "data": {
	"type": "media",
	"id": "DE-198765837",
	"attributes": {},
	"relationships": {
	  "documents": {
		"data": [
		  {
			"type": "document",
			"id": "201",
			"attributes": {},
			"links": {
			  "self": "https://de.openparliament.tv/api/v1/document/201"
			}
		  }
		],
		"links": {
		  "self": "https://de.openparliament.tv/api/v1/searchAnnotations?mediaID=DE-198765837&type=document"
		}
	  }
	},
	"links": {
	  "self": "https://de.openparliament.tv/api/v1/media/DE-198765837"
	}
  }
}

Example for a Search Response:

{
  "meta": {
	"api": {
	  "version": "1.0",
	  "documentation": "https://de.openparliament.tv/api",
	  "license": {
		"label": "ODC Open Database License (ODbL) v1.0",
		"link": "https://opendatacommons.org/licenses/odbl/1-0/"
	  }
	},
	"requestStatus": "success",
	"results": {
	  "count": 25,
	  "total": 128,
	  "rangeStart": 51,
	  "rangeEnd": 75,
	  "maxScore": 4.7654785 /* float or null */
	}
  },
  "data": [],
  "links": {
	"self": "https://de.openparliament.tv/api/v1/search/people?party=CDU&page[number]=3&page[size]=25",
	"first": "https://de.openparliament.tv/api/v1/search/people?party=CDU&page[number]=1&page[size]=25",
	"prev": "https://de.openparliament.tv/api/v1/search/people?party=CDU&page[number]=2&page[size]=25",
	"next": "https://de.openparliament.tv/api/v1/search/people?party=CDU&page[number]=4&page[size]=25",
	"last": "https://de.openparliament.tv/api/v1/search/people?party=CDU&page[number]=13&page[size]=25"
  }
}