Letztes Update: vor 2 Monaten

    Energie API


    Allgemein

    Aktuelle Version

    0.10.2 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

    IDMethodeObjekt
    25916GETGesamterzeugung der gesamten Anlage
    36827GETGesamtverbrauch der gesamten Anlage


    Rückgabeübersicht

    RückgabewertTypBeschreibung
    objIDIntegerDiese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden
    nameStringBezeichnung des Objekts
    valueDoubleAktueller Wert des Objekts
    lastDayDoubleInfo: 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.

    Wichtig: Zeit und Datum werden nicht im Typ Date, sondern Typ String zurückgegeben. Das liegt an unterschiedlichen internen Ausleseformaten, Filtern und Berechnungen.

    OptionRückgabewertTypInformationen
    day
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    week
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    month
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    produced
    difference

    total

    date

    Double

    Integer

    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

    IDMethodeObjekt
    10061GETAutarsys Storage


    Rückgabeübersicht

    RückgabewertTypBeschreibung
    objIDIntegerDiese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden
    nameStringBezeichnung des Objekts
    valueDoubleAktueller Wert des Objekts


    Options

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

    Wichtig: Zeit und Datum werden nicht im Typ Date, sondern Typ String zurückgegeben. Das liegt an unterschiedlichen internen Ausleseformaten, Filtern und Berechnungen.

    OptionRückgabewertTypInformationen
    day
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    week
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    month
    value

    time

    date

    Double

    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

    IDMethodeObjekt
    28570GETDachs 1
    28557GETDachs 2
    16420GETDachs 3
    28635GETDachs 4
    28554GETGlock


    Rückgabeübersicht

    RückgabewertTypBeschreibung
    objIDIntegerDiese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
    nameStringBezeichnung des Objekts
    valueDoubleAktueller Wert des Objekts


    Options

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

    Wichtig: Zeit und Datum werden nicht im Typ Date, sondern Typ String zurückgegeben. Das liegt an unterschiedlichen internen Ausleseformaten, Filtern und Berechnungen.

    OptionRückgabewertTypInformationen
    day
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    week
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    month
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    produced
    difference

    total

    date

    Double

    Integer

    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

    IDMethodeObjekt
    10080GETLadestation DC 1
    36717GETLadestation DC 2
    16422GETLadestation DC 3
    16378GETLadestation DC 4


    Rückgabeübersicht

    RückgabewertTypBeschreibung
    objIDIntegerDiese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
    nameStringBezeichnung des Objekts
    valueDoubleAktueller Wert des Objekts
    statusBooleanGibt 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.

    Wichtig: Zeit und Datum werden nicht im Typ Date, sondern Typ String zurückgegeben. Das liegt an unterschiedlichen internen Ausleseformaten, Filtern und Berechnungen.

    OptionRückgabewertTypInformationen
    day
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    week
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    month
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    produced
    difference

    total

    date

    Double

    Integer

    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

    IDMethodeObjekt
    37204GETWärmepumpe


    Rückgabeübersicht

    RückgabewertTypBeschreibung
    objIDIntegerDiese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
    nameStringBezeichnung des Objekts
    valueDoubleAktueller Wert des Objekts

    Photovoltaik

    Endpoint

    /pvs/{id}/{option}


    Verfügbare IDs

    IDMethodeObjekt
    10106GETPhotovoltaik Gesamt
    10047GETPhotovoltaik Heizhaus
    29355GETPhotovoltaik Bowling
    25936GETPhotovoltaik Traktorhalle
    29482GETPhotovoltaik Ferienhaus


    Rückgabeübersicht

    RückgabewertTypBeschreibung
    objIDIntegerDiese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
    nameStringBezeichnung des Objekts
    valueDoubleAktueller Wert des Objekts


    Options

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

    Wichtig: Zeit und Datum werden nicht im Typ Date, sondern Typ String zurückgegeben. Das liegt an unterschiedlichen internen Ausleseformaten, Filtern und Berechnungen.

    OptionRückgabewertTypInformationen
    day
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    week
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    month
    value

    time

    date

    Double

    String

    String
    value gibt den Wert zurück

    time gibt die Uhrzeit zurück

    date gibt das Datum zurück
    produced
    difference

    total

    date

    Double

    Integer

    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

    IDMethodeObjekt
    29310GETPufferspeicher


    Rückgabeübersicht

    RückgabewertTypBeschreibung
    objIDIntegerDiese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
    nameStringBezeichnung des Objekts
    valueDoubleAktueller Wert des Objekts
    temperaturesArrayEinzeltemperaturen (T1 – T10) des Pufferspeichers
    Array<Object>
    statusBooleanStatus des Objekts

    Hackschnitzelheizung

    Endpoint

    /woodchipboilers/{id}


    Verfügbare IDs

    IDMethodeObjekt
    20025GETHERZ firematic


    Rückgabeübersicht

    RückgabewertTypBeschreibung
    objIDIntegerDiese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
    nameStringBezeichnung des Objekts
    valueDoubleAktueller Wert des Objekts
    statusBooleanStatus des Objekts

    Pools

    Endpoint

    /pools/{id}


    Verfügbare IDs

    IDMethodeObjekt
    16523GETAußenpool
    16496GETWhirlpool


    Rückgabeübersicht

    RückgabewertTypBeschreibung
    objIDIntegerDiese ID entspricht der exakten ID des zugehörigen Objektes und sollte plattformübergreifend identisch sein. Diese ID kann als Unique-ID verwendet werden.
    nameStringBezeichnung des Objekts
    valueDoubleAktueller Wert des Objekts
    coveredBooleanStatus der Überdachung des Objektes
    lightingBooleanStatus der Beleuchtung des Objektes

    Changelog

    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