Aktuelles
Aktuelle Informationen zur Entwicklung der Opendata API.
- Stand der API: Die API befindet sich derzeit in der Beta-Phase.
- Letztes Update: 13. März 2025 - Neue Endpunkte für Pegelstände hinzugefügt.
- Geplante Features: Unterstützung für CSV- und Excel-Export, verbesserte Caching-Mechanismen.
- Bekannte Probleme: Einige Endpunkte haben Performance-Probleme bei großen Datenmengen.
Dokumentation
Die API bietet Zugriff auf:
- Pegel-Daten: Zugriff auf Metadaten aller Pegel.
- Aktuelle Pegelwerte: Abfrage der neuesten Pegelstände.
- Live-Stream: Server-Sent-Events für Echtzeit-Pegelstände.
- Bundesländer: Auflistung der Pegel sortiert nach Bundesländern.
- Gewässer: Auflistung der Pegel sortiert nach Gewässern.
- Detailabfragen: Detaillierte Pegel-Informationen und Messwerte über spezifische IDs abrufbar.
- Filter: Parameter für Start-/Enddatum, Limit und Offset verfügbar.
Lesen Sie die vollständige Dokumentation in unserem API-Dokumentationsbereich.
Beispielabfragen
Alle Stammdaten der Pegel
GET /api/v1/metadata/?limit=100&offset=0
Stammdaten eines Pegels
GET /api/v1/metadata/{pegel_id}/
Letzte Pegelwerte
GET /api/v1/values/latest?limit=100&offset=0
Pegelwerte für einen spezifischen Pegel
GET /api/v1/values/{pegel_id}/?limit=100&offset=0&start_date=2024-01-01T00:00:00&end_date=2024-11-01T00:00:00
Letzter Pegelwert für einen Pegel
GET /api/v1/values/{pegel_id}/last
Bundesländer und Pegel
GET /api/v1/states/
Pegel für ein bestimmtes Bundesland
GET /api/v1/states/{federal_state}/
Alle Pegel für ein Gewässer
GET /api/v1/waters/
Pegel für ein spezifisches Gewässer
GET /api/v1/waters/{water}/
Fair-Usage-Policy
Unsere API ist darauf ausgelegt, allen Nutzern gleichmäßigen Zugang zu gewährleisten und eine zuverlässige Leistung zu bieten. Um eine Überlastung des Systems zu vermeiden und die Qualität der Dienstleistung für alle zu sichern, haben wir eine Fair-Usage-Policy implementiert. Dies beinhaltet die Verwendung von Rate-Limitern, die sicherstellen, dass jede Anfrage innerhalb eines fairen Rahmens bleibt. Bitte beachten Sie, dass zu viele Anfragen in kurzer Zeit zu temporären Einschränkungen führen können. Wir empfehlen, Anfragen effizient und bedarfsgerecht zu stellen.
Kontakt
Haben Sie Fragen oder benötigen Sie Unterstützung? Kontaktieren Sie uns:
- E-Mail: pegel@thw.de