NaWater-Api Dokumentation

Übersicht

Die NaWater-Api ist eine Schnittstelle, die es ermöglicht, die Daten der Hochwassersensoren in Neu-Anspach abzurufen.

Die Daten werden von der Stadt Neu-Anspach zur Verfügung gestellt. Hier geht es zur offiziellen Seite der Stadt Neu-Anspach.
Im Gegensatz zur offiziellen Seite, die nur die Daten der letzten 24 Stunden anzeigt, können hier die Daten seit dem 14.11.2023 abgerufen werden.

Da dies ein Hobbyprojekt ist, kann es sein, dass die Api nicht immer erreichbar ist.
Außerdem kann es sein, dass die Api keine Daten liefert, obwohl die Sensoren Daten gesendet haben oder dass die Daten nicht stimmen.

WICHTIG: Die Api ist nur für den privaten Gebrauch gedacht. Die Daten dürfen nicht für kommerzielle Zwecke verwendet werden. Keine Garantie auf Richtigkeit der Daten.

Die Api ist unter der Adresse https://api-nawater.finndohrmann.de erreichbar.

V2

Die Version 2 der Api ist unter der Adresse https://api-nawater.finndohrmann.de/api/v2 erreichbar.

Query

Die Query-Route ermöglicht es, die Daten der Sensoren abzurufen.

Die Route ist unter der Adresse https://api-nawater.finndohrmann.de/api/v2/query erreichbar.

Name Typ Beschreibung Beispiel
id UUID/UUID-Liste Die UUID des Sensors/Sensoren, dessen Daten abgerufen werden sollen
(Mehrere UUIDs können mit einem Semikolon getrennt werden)
e39de276-e835-4f16-94f1-da26df1df667;b48500ea-11d1-48f4-9728-92120adad9ce
start Long Unix-Timestamp in Sekunden 1700871518
end Long Unix-Timestamp in Sekunden 1700957918
chartjs Boolean Wenn true, wird die Antwort in einer Form zurückgegeben,
die mit Chart.js direkt kompatibel ist
true
Beispiel: https://api-nawater.finndohrmann.de/api/v2/query?id=e39de276-e835-4f16-94f1-da26df1df667;b48500ea-11d1-48f4-9728-92120adad9ce&start=1700871518&end=1700957918&chartjs=true

V1

Die Version 1 der Api ist unter der Adresse https://api-nawater.finndohrmann.de/api/v1 erreichbar.

Query

Die Query-Route ermöglicht es, die Daten der Sensoren abzurufen.

Die Route ist unter der Adresse https://api-nawater.finndohrmann.de/api/v1/query erreichbar.

Name Typ Beschreibung Beispiel
id UUID Die UUID des Sensors, dessen Daten abgerufen werden sollen e39de276-e835-4f16-94f1-da26df1df667
start Long Unix-Timestamp in Sekunden 1700871518
end Long Unix-Timestamp in Sekunden 1700957918
chartjs Boolean Wenn true, wird die Antwort in einer Form zurückgegeben,
die mit Chart.js direkt kompatibel ist
true
Beispiel: https://api-nawater.finndohrmann.de/api/v1/query?id=e39de276-e835-4f16-94f1-da26df1df667&start=1700871518&end=1700957918&chartjs=true