The easiest way to install the latest stable version from PyPI is by using pip:

pip install bundestagsapy

Alternatively, install directly from the GitHub repository:

pip install git+https://github.com/parobo/BundestagsAPy

To use the API wrapper, simply call the client object with your API key. See https://dip.bundestag.de/%C3%BCber-dip/hilfe/api#content on how to get an API key.

import BundestagsAPy
api_key='XXXXXXXXXXXXXXX'
client = BundestagsAPy.Client(api_key)

The client provides access to all available documents through methods named after the endpoints (bt_{endpoint}). E.g.

client.bt_aktivitaet(max_results=50, id, start_date, end_date, updated_start, updated_end, drucksache, plenaeprotokoll, zuordnung)

The available endpoint are:

• aktivitaet: bt_aktivitaet()
• drucksache: bt_drucksache()
• drucksache-text: bt_drucksache_text()
• person: bt_person()
• plenarprotokoll: bt_plenarprotokoll()
• plenarprotokoll-text: bt_plenarprotokoll_text()
• vorgang: bt_vorgang()
• vorgangsposition: bt_vorgangsposition()

All methods accept max_results as input. It takes either an interger as value, in which case the method returns the first max_results supplied by the API, or False, in which case all available documents are returned. Note that because of the API infrastructure, at least 50 results are always returned.

id can either be an integer (for single document returned) or a list of integers (for multiple).

Most endpoints accept the parameters start_date and end_date, which should be in strings in the format YYYY-mm-dd. Some deviation is allowed, the client tries to parse the date using dateutil and then formats it however necessary for the API.

The client now also accept the parameters updated_start and updated_end, which should be in strings in the format YYYY-mm-ddTHH:MM:SS+ZZ:ZZ. Some deviation is allowed, the client tries to parse the date using dateutil and then formats it however necessary for the API. Default time zone is +02:00.

see https://dip.bundestag.de/documents/informationsblatt_zur_dip_api.pdf for details on other acceptable parameters for each endpoint. For more information on available endpoints and allowed parameters, see also https://search.dip.bundestag.de/api/v1/swagger-ui/.

The results from each request to an endpoint is an object named after the document requested if a single document was requested. Each object has as its attributes all the available data named in the same way as documented on https://dip.bundestag.de/documents/informationsblatt_zur_dip_api.pdf.

If multiple documents were requested, BundestagsAPy returns a list of the documents. E.g.

for result in client.bt_aktivitaet(max_results=False, start_date='2020-01-01',end_date='2020-01-02'):
	print(result.id,result.titel)

for result in client.bt_drucksache(max_results=False, updated_start='2022-01-01T00:00:00+02:00',updated_end='2023-02-01T00:00:00+02:00'):
	print(result.id,result.titel)