API Dokumentation

Netzfrequenz API Dokumentation

Die Netzfrequenz API bietet Zugriff auf aktuelle Frequenzdaten des Stromnetzes. Die Daten stammen von swissgrid.ch. Diese Daten umfassen Messwerte wie Frequenz, Frequenzabweichung und Netzzeitabweichung und werden zur Überwachung der Netzfrequenz genutzt.

Hinweis: Die in der Datenbank gespeicherten Frequenzdaten werden alle 10 Sekunden 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

Datenabfrage

Über die Frequency API kann entweder der aktuellste Messwert abgerufen oder Daten für einen bestimmten Zeitraum angefordert werden.

• Zeitraum-Abfrage: Mittels der GET-Parameter start und end (im Format Y-m-d H:i:s) kann ein spezifischer Zeitraum definiert werden. Beispiel: ?start=2025-04-01 12:00:00&end=2025-04-01 12:05:00
• Standard: Wird kein Zeitraum angegeben, liefert die API immer den aktuellsten also letzten Messwert.

Ausgabeformate

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

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

Beispielaufrufe

Beispielaufruf für den aktuellsten Messwert:

https://api.ix23.de/frequency/?api_key=DEIN_API_KEY&format=json

Beispielaufruf für einen bestimmten Zeitraum:

https://api.ix23.de/frequency/?api_key=DEIN_API_KEY&start=2025-04-01 12:00:00&end=2025-04-01 12:05:00&format=json

Fehlerbehandlung

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

{
  "error": "API key missing"
}

{
  "error": "Ungültiges Datumsformat. Erwartet: Y-m-d H:i:s"
}