Letztes Update: vor 3 Jahren

Energie API

Allgemein

Aktuelle Version

0.10.5 beta

Aktualisierung

Seit der Version 0.10.2 beta ist der Intervall für die meisten Endpoints individuell. Der derzeitige Standard-Intervall liegt bei 10s.

Linkstruktur

Die Linkstruktur der aktuellen Energie REST API sieht wie folgt aus:

https://energie.haffhus.de/api/v1/{endpoint}/{id}/{option}

Wird die ID nicht spezifiziert, so werden alle Objekte eines Endpoints zurückgegeben.

Endpoints

Gesamt

Endpoint

/total/{id}/{option}

Verfügbare IDs

ID	Methode	Objekt
`25916`	`GET`	Gesamterzeugung der gesamten Anlage
`36827`	`GET`	Gesamtverbrauch der gesamten Anlage

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts
`lastDay`	`Number`	Info: vorerst nur bei Gesamterzeugung `25916` verfügbar Gibt die Gesamterzeugung des heutigen Tages an. Die Bezeichnung wird in kommenden Versionen mit hoher Wahrscheinlichkeit überarbeitet.

Options

Die Options werden zusätzlich zu den Standardwerten hinzugefügt.

Option	Rückgabewert	Typ	Informationen
`day`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`week`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`month`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`produced`	`difference` `total` `date`	`Number` `Number` `String`	difference gibt den Wertunterschied zwischen dem ausgewählten und vorherigen Tagesgesamtwert zurück total gibt den Gesamtwert seit Beginn der Datenerfassung zurück date gibt das Datum zurück

Batteriespeicher

Endpoint

/battery/{id}/{option}

Verfügbare IDs

ID	Methode	Objekt
`10061`	`GET`	Autarsys Storage

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts
`tempSystem`	`Number`	Aktuelle System-Temperatur
`tempBattery`	`Number`	Aktuelle Batterie-Temperatur

Options

Die Options werden zusätzlich zu den Standardwerten hinzugefügt.

Option	Rückgabewert	Typ	Informationen
`day`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`week`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`month`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück

BHKWs

Endpoint

/bhkws/{id}/{option}

Verfügbare IDs

ID	Methode	Objekt
`28570`	`GET`	Dachs 1
`28557`	`GET`	Dachs 2
`16420`	`GET`	Dachs 3
`28635`	`GET`	Dachs 4
`28554`	`GET`	Glock

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts

Options

Die Options werden zusätzlich zu den Standardwerten hinzugefügt.

Option	Rückgabewert	Typ	Informationen
`day`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`week`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`month`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`produced`	`difference` `total` `date`	`Number` `Number` `String`	difference gibt den Wertunterschied zwischen dem ausgewählten und vorherigen Tagesgesamtwert zurück total gibt den Gesamtwert seit Beginn der Datenerfassung zurück date gibt das Datum zurück

Ladestationen

Endpoint

/chargingstations/{id}/{option}

Verfügbare IDs

ID	Methode	Objekt
`10080`	`GET`	Ladestation DC 1
`36717`	`GET`	Ladestation DC 2
`16422`	`GET`	Ladestation DC 3
`16378`	`GET`	Ladestation DC 4

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts
`status`	`Boolean`	Gibt `true` zurück, falls die Ladestation aktiviert ist. Eine Ladestation kann aktiviert sein, obwohl sie zu diesem Zeitpunkt nicht genutzt wird.

Options

Info: Derzeit sind nicht alle Optionen bei allen Ladestationen verfügbar. Das liegt an derzeitigen physischen Installationsvorgängen. Die Werte werden nach und nach ergänzt. Nähere Informationen werden in den Changelogs beschrieben, sobald neue Werte in die API aufgenommen werden.

Die Options werden zusätzlich zu den Standardwerten hinzugefügt.

Option	Rückgabewert	Typ	Informationen
`day`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`week`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`month`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`produced`	`difference` `total` `date`	`Number` `Number` `String`	difference gibt den Unterschied zwischen dem gestrigen und heutigem Gesamtwert zurück und ist dementsprechend unsere Tagesgesamtwert total gibt den Gesamtwert seit Beginn der Datenerfassung zurück date gibt das Datum zurück

Wärmepumpen

Endpoint

/heatpumps/{id}

Verfügbare IDs

ID	Methode	Objekt
`37204`	`GET`	Wärmepumpe

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts

Photovoltaik

Endpoint

/pvs/{id}/{option}

Verfügbare IDs

ID	Methode	Objekt
`10106`	`GET`	Photovoltaik Gesamt
`10047`	`GET`	Photovoltaik Heizhaus
`29355`	`GET`	Photovoltaik Bowling
`25936`	`GET`	Photovoltaik Traktorhalle
`29482`	`GET`	Photovoltaik Ferienhaus

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts

Options

Die Options werden zusätzlich zu den Standardwerten hinzugefügt.

Option	Rückgabewert	Typ	Informationen
`day`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`week`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`month`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`produced`	`difference` `total` `date`	`Number` `Number` `String`	difference gibt den Wertunterschied zwischen dem ausgewählten und vorherigen Tagesgesamtwert zurück total gibt den Gesamtwert seit Beginn der Datenerfassung zurück date gibt das Datum zurück

Pufferspeicher

Endpoint

/bufferstorages/{id}

Verfügbare IDs

ID	Methode	Objekt
`29310`	`GET`	Pufferspeicher

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts
`temperatures`	`Array`	Einzeltemperaturen (T1 – T10) des Pufferspeichers `Array<Object>`
`status`	`Boolean`	Status des Objekts

Hackschnitzelheizung

Endpoint

/woodchipboilers/{id}

Verfügbare IDs

ID	Methode	Objekt
`20025`	`GET`	HERZ firematic

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts
`status`	`Boolean`	Status des Objekts

Pools

Endpoint

/pools/{id}

Verfügbare IDs

ID	Methode	Objekt
`16523`	`GET`	Außenpool
`16496`	`GET`	Whirlpool

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts
`covered`	`Boolean`	Status der Überdachung des Objektes
`lighting`	`Boolean`	Status der Beleuchtung des Objektes

Saunen

Endpoint

/saunas/{id}/{option}

Verfügbare IDs

ID	Methode	Objekt
`10134`	`GET`	Sauna 90°
`28829`	`GET`	Sauna 60°

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts

Options

Die Options werden zusätzlich zu den Standardwerten hinzugefügt.

Option	Rückgabewert	Typ	Informationen
`day`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`week`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`month`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`produced`	`difference` `total` `date`	`Number` `Number` `String`	difference gibt den Wertunterschied zwischen dem ausgewählten und vorherigen Tagesgesamtwert zurück total gibt den Gesamtwert seit Beginn der Datenerfassung zurück date gibt das Datum zurück

Dampfbäder

Endpoint

/steambaths/{id}/{option}

Verfügbare IDs

ID	Methode	Objekt
`28830`	`GET`	Dampfbad

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts

Options

Die Options werden zusätzlich zu den Standardwerten hinzugefügt.

Option	Rückgabewert	Typ	Informationen
`day`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`week`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`month`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`produced`	`difference` `total` `date`	`Number` `Number` `String`	difference gibt den Wertunterschied zwischen dem ausgewählten und vorherigen Tagesgesamtwert zurück total gibt den Gesamtwert seit Beginn der Datenerfassung zurück date gibt das Datum zurück

Waschmaschinen

Endpoint

/washingmachines/{id}/{option}

Verfügbare IDs

ID	Methode	Objekt
`28849`	`GET`	Waschmaschine 1
`28850`	`GET`	Waschmaschine 2

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts

Options

Die Options werden zusätzlich zu den Standardwerten hinzugefügt.

Option	Rückgabewert	Typ	Informationen
`day`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`week`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`month`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`produced`	`difference` `total` `date`	`Number` `Number` `String`	difference gibt den Wertunterschied zwischen dem ausgewählten und vorherigen Tagesgesamtwert zurück total gibt den Gesamtwert seit Beginn der Datenerfassung zurück date gibt das Datum zurück

Trockner

Endpoint

/dryers/{id}/{option}

Verfügbare IDs

ID	Methode	Objekt
`10151`	`GET`	Trockner 1
`10152`	`GET`	Trockner 2

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts

Options

Die Options werden zusätzlich zu den Standardwerten hinzugefügt.

Option	Rückgabewert	Typ	Informationen
`day`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`week`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`month`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`produced`	`difference` `total` `date`	`Number` `Number` `String`	difference gibt den Wertunterschied zwischen dem ausgewählten und vorherigen Tagesgesamtwert zurück total gibt den Gesamtwert seit Beginn der Datenerfassung zurück date gibt das Datum zurück

Mangeln

Endpoint

/mangles/{id}/{option}

Verfügbare IDs

ID	Methode	Objekt
`28853`	`GET`	Mangel

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts

Options

Die Options werden zusätzlich zu den Standardwerten hinzugefügt.

Option	Rückgabewert	Typ	Informationen
`day`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`week`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`month`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`produced`	`difference` `total` `date`	`Number` `Number` `String`	difference gibt den Wertunterschied zwischen dem ausgewählten und vorherigen Tagesgesamtwert zurück total gibt den Gesamtwert seit Beginn der Datenerfassung zurück date gibt das Datum zurück

Heizstäbe

Endpoint

/heaters/{id}/{option}

Verfügbare IDs

ID	Methode	Objekt
`36751`	`GET`	Heizstab 1 (Reethaus 1)
`28675`	`GET`	Heizstab 2 (Reethaus 2)
`15789`	`GET`	Heizstab 3 (Reethaus 3)
`28750`	`GET`	Heizstab 4 (Ferienwohnung)
`28772`	`GET`	Heizstab 5 (Haupthaus)
`28569`	`GET`	Heizstab 6 (Heizhaus)

Rückgabeübersicht

Rückgabewert	Typ	Beschreibung
`objID`	`Number`	Diese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
`name`	`String`	Bezeichnung des Objekts
`value`	`Number`	Aktueller Wert des Objekts

Options

Die Options werden zusätzlich zu den Standardwerten hinzugefügt.

Option	Rückgabewert	Typ	Informationen
`day`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`week`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`month`	`value` `time` `date`	`Number` `String` `String`	value gibt den Wert zurück time gibt die Uhrzeit zurück date gibt das Datum zurück
`produced`	`difference` `total` `date`	`Number` `Number` `String`	difference gibt den Wertunterschied zwischen dem ausgewählten und vorherigen Tagesgesamtwert zurück total gibt den Gesamtwert seit Beginn der Datenerfassung zurück date gibt das Datum zurück

Changelog

0.10.5 beta

Update vom 10.09.2021

Neue Endpoints:
- Dampfbäder (/steambaths)
- Mangeln (/mangles)

0.10.4 beta

Update vom 07.09.2021

Neue Endpoints:
- Saunen (/saunas)
- Waschmaschinen (/washingmachines)
- Trockner (/dryers)
- Heizstäbe (/heaters)

0.10.3 beta

Update vom 02.05.2021

Batteriespeicher-Temperaturen wurden hinzugefügt

0.10.2 beta

Update vom 26.06.2020

Neue ID – Außenpool: ~~16524~~ => 16523

Veröffentlicht am 13.06.2020

Intervall-Optimierungen
Interne Updates zur weiteren Verbesserung der Stabilität
Neuer Endpoint: Pools
- Endpoint: /pools
- beinhaltet zunächst Temperaturen, Status von Überdachung / Beleuchtung

0.10.1 beta

Update vom 03.06.2020

Neue ID – Photovoltaik Ferienhaus: ~~28743~~ => 29482

Veröffentlicht am 04.05.2020

Parameter _id bei allen Endpoints entfernt – Grund: Redundanz
Parameter __v bei allen Endpoints entfernt – Grund: Irrelevanz
Neue Optionen & Filter hinzugefügt (bei ausgewählten Endpoints):
- day – Live-Daten der letzten 24 Stunden
- week – Live-Daten der letzten Woche
- month – Live-Daten des letzten Monats
- produced – Tägliche Produktion des letzten Jahres

0.10.0 beta

Veröffentlicht am 15.04.2020

Erste öffentliche Version der Energie-API