Open-API Baustein OpenBoards

Open-API Baustein OpenBoards

Zum Inhalt springen

Der Baustein OpenBoards liefert für eine Liste von Stationen in Deutschland bzw. einen vertrieblichen Umsteigebereich die innerhalb eines Zeitfensters dort ankommenden bzw. abfahrenden öffentlichen Schienenpersonenverkehre (nur "schwere Schiene"/Eisenbahn). 

Für jede Abfahrtstafel bzw. Ankunftstafel werden Plan- und Echtzeitinformationen (sofern vorhanden) geliefert. Darunter unter anderem Informationen wie:

  • Verkehrsmittel (Produktklasse, Fahrtnummer, Linie, Verwaltung, Ziel- und Starthalt, Richtungstexte)
  • Zeiten (Plan und Echtzeit) und Gleise/Bahnsteige (Plan und Echtzeit)
  • Haltausfälle, Zusatzhalte und zurückgenommene Zusatzhalte
  • Störungsinformationen, Kundengründe, Qualitätsabweichungen und Freitexte
  • Via-Halte im weiteren Laufweg
  • Referenzen auf andere Verkehre (Ersatz- bzw. Entlastungsfahrten, Durchbindungen und Vereinigungen)
  • Informationen über Ersatzverkehre
  • und vieles mehr

Details zu OpenAPI, zur Visualisierung der Spezifikation und zur automatisierten Code-Generierung von API-Clients sind im Bereich OpenAPI Technologie beschrieben.

Abfahrtstafeln

Der Endpunkt /departures liefert Abfahrtstafeln für alle Haltestellen in Deutschland an denen Schienenpersonenverkehre abfahren.

Erläuterung der Parameter (für Details siehe OpenAPI Spezifikation):

ParameterErklärung
stopPlaceOrStation

Gibt an, für welchen Bahnhof/welche Haltestelle eine Abfahrts- bzw. Ankunftstafel abgerufen werden soll. Es können verschiedene Schlüssel verwendet werden:

  1. Die ID des Bahnhofs der Deutschen Bahn AG (stada)
  2. Die ID der Haltestelle der Deutschen Bahn AG (evaNumber)
  3. Die ID der Haltestelle gemäß zHV/DELFI (dhid)

Wichtig #1: Standardmäßig erweitert die API die Anfrage auf alle Haltestellen, die im gleichen Umsteigebereich liegen. Fragt man daher z.B. Frankfurt Main Hbf "oben" an, erweitert die API automatisch auf alle Haltestelle innerhalb des Bahnhofs und im bahnhofsnahen Umfeld.

 

Wichtig #2: Die IDs der Bahnhöfe/Haltestellen können im API Baustein OpenStation nachgeschlagen werden.

timeWindowGibt das Zeitfenster an, in welchem Abfahrten/Ankünfte zurückgegeben werden sollen. Standardmäßig werden die nächsten 30 Minuten zurückgegeben.
transportTypesRegelt, welche Produktklassen zurückgegeben werden sollen. Standardmäßig werden alle Produktklassen zurückgegeben.
onlyReplacementTransportsSteuert, ob nur Ersatzverkehre (sofern vorhanden) zurückgegeben werden sollen.
maxViaStopsGibt an, wie viele Unterwegs-Halte zurückgegeben werden soll. Zusatzhalte oder ausgefallene Halte werden immer zurückgegeben. Standardmäßig werden 3 Unterwegs-Halte zurückgegeben.
maxEntriesPerTransportTypeGibt an, wie viele Abfahrten/Ankünfte pro Produktklasse ausgegeben werden. Standardmäßig werden 25 Einträge pro Produktklasse zurückgegeben.
noCancellationsSteuert, ob nur fahrbare, daher nicht ausgefallene Abfahrten/Ankünfte ausgegeben werden sollen (Positivkommunikation).
includePlatformAccessibilitySteuert, ob Informationen zur Barrierefreiheit von Gleisen/Bahnsteigen (sofern vorhanden) zurückgegeben werden.
sortByBeeinflusst die Sortierreihenfolge der Abfahrten/Ankünfte. Standardmäßig wird nach aktueller Zeit sortiert.
languagesGibt an, welche Sprachen zurückgegeben werden sollen. Standardmäßig werden Deutsch und Englisch (sofern verfügbar) zurückgegeben.

Beispielanfrage für Frankfurt Main Hauptbahnhof:

curl --request POST \ --url 'https://apis.deutschebahn.com/db-api-marketplace/apis/open-boards/v1/departures' --header 'DB-Api-Key: {{apikey}}' \ --header 'DB-Client-Id: {{clientid}}' --header "Content-Type: application/json" \ -d '{       "stopPlaceOrStation": {         "evaNumbers": [           "8000105"         ]       },       "timeWindow": {         "timeStart": "2026-10-23T13:00:00+02:00"       },       "maxViaStops": 3,       "maxEntriesPerTransportType": 10,       "languages": [         "deu"       ]     }'

Ankunftstafeln

Der Endpunkt /arrivals liefert Ankunftstafeln für alle Haltestellen in Deutschland an denen Schienenpersonenverkehre ankommen.

Parameter sind analog zur Abfahrtstafel.

Beispielanfrage für Frankfurt Main Hauptbahnhof:

curl --request POST \--url 'https://apis.deutschebahn.com/db-api-marketplace/apis/open-boards/v1/arrivals'--header 'DB-Api-Key: {{apikey}}' \--header 'DB-Client-Id: {{clientid}}'--header "Content-Type: application/json" \-d '{      "stopPlaceOrStation": {        "evaNumbers": [          "8000105"        ]      },      "timeWindow": {        "timeStart": "2026-10-23T13:00:00+02:00"      },      "maxViaStops": 3,      "maxEntriesPerTransportType": 10,      "languages": [        "deu"      ]    }'

Kontakt

Bei Fragen oder Feedback: opendata.infrago@deutschebahn.com