jschibberges / Bundestag-API

A python-wrapper for the official Bundestag (German Federal Parliament) API
MIT License
5 stars 1 forks source link

Endpoint for Metadata Only #4

Closed ChristianGeng closed 5 months ago

ChristianGeng commented 1 year ago

Problem

The plenaryprotocol endpoints are designed to obtain plenary protocols containing the entire protocol including the full steno text extracted from the corresnporing pdfs.

This is however not always what you want.

Sometimes you only want to find the Wahlperiode, the document number or the title, but for the entire history of the parliament. When getting all text, this might take a long time, and require more data transfer than really needed.

Possible Solution

add secondary endpoints that do not retrieve the entire text but only metadata.

jschibberges commented 5 months ago

I added a "fulltext"-parameter to those functions searching or retrieving documents and plenary protocols. Default is false, because as you point out, this can lead to a lot of extra data transfered if not set intentionally.