API Dokumentation

Outages API Dokumentation

Die Outages API bietet Zugriff auf aktuelle Informationen zu Störungen und geplanten Ausfällen. Die Daten stammen von Störungsauskunft.de und werden alle 5 Minuten aktualisiert.

Hinweis: Die bereitgestellten Daten beziehen sich auf Ausfälle und Störungen in den Bereichen Strom, Gas, Wasser, Fernwärme und Straßenbeleuchtung.

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

Zusätzlich zur Authentifizierung können über optionale GET-Parameter Filter für die Abfrage der Daten gesetzt werden.

Allgemeine Parameter

• active: Filtert Datensätze nach ihrem Aktivstatus (erlaubte Werte: 0 oder 1; Standard: 1).

Spezifische Filter

• start_date und end_date: Definieren den Zeitraum, für den die Daten abgefragt werden sollen.
  Beispiel: ?start_date=2025-04-01&end_date=2025-04-06
• operator_name: Teilstring-Suche nach dem Namen des Anbieters oder Betreibers der Störung.
  Beispiel: ?operator_name=StromNetz
• postal_code: Exakter Filter nach Postleitzahl.
  Beispiel: ?postal_code=10115
• city: Teilstring-Suche in der Stadtbezeichnung.
  Beispiel: ?city=Berlin
• type: Filtert nach Art der Störung oder des geplanten Ausfalls (z. B. 1 für Störung, 2 für geplanten Ausfall).
  Beispiel: ?type=1
• sectortype: Filtert nach einem oder mehreren Sektortypen (als kommagetrennte Liste, z. B. "1,2,3").
  Beispiel: ?sectortype=1,3

Ausgabeformate

Standardmäßig liefert die Outages API Daten im JSON-Format. Über den Parameter format kann das Ausgabeformat geändert werden:

• json (Standard): ?format=json
• xml: ?format=xml
• csv: ?format=csv
• jsonp: ?format=jsonp&callback=DEIN_CALLBACK

Beispielaufruf

Beispielaufruf für die Abfrage von Störfällen im Zeitraum:

https://api.ix23.de/outages/?api_key=DEIN_API_KEY&start_date=2025-04-01&end_date=2025-04-06&active=1&format=json

Dieser Aufruf liefert alle aktiven Datensätze (Störungen oder geplante Ausfälle) für den angegebenen Zeitraum – 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)"
}