API Dokumentation

Zurück zur Startseite

ODEG API Dokumentation

Die ODEG API bietet Zugriff auf Störungen und Fahrplanabweichungen bei der ODEG. Die Daten stammen von odeg.de. Über den GET-Parameter source kann zwischen zwei den Datenquellen gewählt werden:

Hinweis: Für den Zugriff auf die API ist ein gültiger API-Key erforderlich. Ein API-Key für den Zugang ist auf Anfrage erhältlich.

Aktualisierungsintervall

Die in der Datenbank gespeicherten ODEG-Daten werden alle 5 Minuten aktualisiert.

Authentifizierung

Jeder API-Aufruf muss den Parameter api_key enthalten. Wird dieser nicht mitgegeben oder ist er ungültig, liefert die API eine entsprechende Fehlermeldung.

?api_key=DEIN_API_KEY

Parameter und Filter

Die API erwartet den GET-Parameter source mit folgenden erlaubten Werten:

Zusätzlich stehen optionale Filterparameter zur Verfügung:

Allgemeine Parameter

Parameter für source=outages

Parameter für source=timetable

Ausgabeformate

Standardmäßig liefert die ODEG API Daten im JSON-Format. Mit dem Parameter format kann das Ausgabeformat geändert werden:

Beispielaufruf

Beispielaufruf für einen Datensatz aus der Quelle outages:

https://api.ix23.de/odeg/?api_key=DEIN_API_KEY&source=outages&active=1&line=RB&datum_start=2025-04-01&datum_end=2025-04-06&format=json

Dieser Aufruf liefert alle aktiven Störfälle (Quelle: outages), bei denen in der Linienbezeichnung "RB" vorkommt und die innerhalb des angegebenen Datumsbereichs liegen – als JSON-Daten.

Fehlerbehandlung

Bei fehlerhaften oder unvollständigen Parametern gibt die API eine entsprechende Fehlermeldung zurück. Beispiele:

{
  "error": "API key missing (API-Schlüssel fehlt)"
}
{
  "error": "Invalid source. Please specify \"outages\" or \"timetable\" (Ungültiger Wert für source. Bitte \"outages\" oder \"timetable\" angeben)"
}