Auf dieser Seite finden Sie Informationen zur OpenAPI Programmierschnittstelle der BDO.
Sie sind auf Englisch, damit auch Interessierte aus anderen Ländern bzw. Sprachregionen technisch auf die Daten zugreifen können.

This page displays information about the API of BDO. Since it is an OpenAPI implementation, you might want to visit [http://swagger.io](http://swagger.io) for further information.
It has been created with [https://github.com/nelmio/NelmioApiDocBundle](https://github.com/nelmio/NelmioApiDocBundle).

The available fields represent the same ones as on [the search page](https://bdo.badw.de/suche). Below, you will find a detailed list and descriptions.
There is no field that is required or explicitly mandatory but you have to submit at least one of the followig: *lemma*, *bedeutung*, *beleg*, *wortfamilie*, *sachgruppe*, *etymologie*, *lautung*.
Else, the search results would contain too many entries. For downloading the whole database, please see [this information](https://bdo.badw.de/info#downloads).

By aid of the graphical userinterface, you can also try out accessing the API within this page directly first.
The options can either be set in their representation as single input/select fields, or by setting the particular value within the object at the end of the section (which might be an advanced way to most users and hence more comfortable for programmers).
Setting both, the single fields and the object, the latter overwrites values of the single fields.
For a description and examples of the contents of the object, please see the particular area of the single field. For instance, if you want to know the impact of the option _exact_, see the information given in its parameter description.

__Formats__

As default, XML is chosen as output format. It contains the unmodified data as stored to the database.
If you prefer JSON as format, however, the XML will be converted completely into a valid JSON file by representing the particular attributes by the key _@attributes_. This solution is considered best practise among programmers. Else, JSON would loose the XML attributes.
Further, multiple results will be iterable as array objects whereas a single result will directly be put into the output. Thus, your code should check the type of the main object before processing to avoid errors.

__Terms of Service__

The API can be accessed without registration, free of charge and without limitations. There is no logging. In order to prevent and also analyze (attempts of) attacks, the IP and the time of access will be stored on the server itself for seven days. For further information, please visit the [data privacy statement](https://badw.de/data/footer-navigation/datenschutz.html) of the Bavarian Academy of Sciences and Humanities.

We therefore kindly ask you to **limit** your requests to 1 per second.

__Contact__

Please see [https://bdo.badw.de/kontakt](https://bdo.badw.de/kontakt) and use "Technik" as recipient for contacting the developer.