Die eFriends WATCH+ und der eFriends Cube stellen Informationen über den aktuellen Community-Handel über eine Schnittstelle zur Verfügung.
Die Schnittstelle ist unter der folgenden Adresse im lokalen Netzwerk erreichbar:
http://<lokale IP-Adresse>/v3/MeterDataAPI/TradingSummary
oder, von außerhalb des lokalen Netzwerks:
https://<hostname>/v3/MeterDataAPI/TradingSummary
Den Wert für <hostname> kannst Du in der eFriends app im Expertenmodus abfragen.
Authentifizierung
Bei jeder Abfrage muss ein gültiger API-Key übergeben werden, entweder im HTTP-Header "apiKey" oder als URL-Parameter "apiKey". API-Keys kannst Du in der eFriends app im API Manager anlegen.
Ausgabe
Das Ausgabeformat kann über den Parameter "format" gesteuert werden
| format | Ausgabe |
| json (oder keine Angabe) | im JSON-Format |
| xml | im XML-Format |
Die folgenden Werte werden zurückgeliefert:
| Wert | Beschreibung |
|
startTime |
Beginn der Handelsperiode |
| endTime |
Ende der Handelsperiode |
| unixTimestamp |
Ende der Handelsperiode (Millisekunden seit 1. 1. 1970 UTC) |
| cubeName |
Name des Cube/der WATCH+ |
| aggregatedData | Handel in der vergangenen 10-Sekunden-Periode |
| aggregatedData.producer | Wurde in der Periode verkauft (true oder false) |
|
aggregatedData.consumer |
Wurde in der Periode gekauft (true oder false) |
| aggregatedData.pv, water, biogas, wind |
Leistung (in W), die von Produzenten mit der Erzeugungsart gekauft wurde |
|
aggregatedData.toCommunity |
Leistung (in W), die Du an die Community verkauft hast |
|
aggregatedData.fromCommunity |
Leistung (in W), die Du von der Community gekauft hast |
|
aggregatedData.toSupplier |
Leistung (in W), die Du an den Energielieferanten verkauft hast |
|
aggregatedData.fromSupplier |
Leistung (in W), die Du vom Energielieferanten gekauft hast |
|
aggregatedData.toGrid |
Eingespeiste Leistung (in W) |
|
aggregatedData.fromGrid |
Bezogene Leistung (in W) |
| balance | Bilanz der community. Positive Werte: Diese Leistung (in W) steht noch in der community zur Verfügung, negative Werte: diese Leistung beziehst Du vom Energielieferanten |
|
aggregatedData.communityShareable |
Leistung (in W), die Du an den Energielieferanten verkauft hast |
|
aggregatedData.communityConsumable |
Leistung (in W), die in der Community verfügbar war und nicht gekauft wurde |
Beispiele
Abfrage im lokalen Netzwerk als XML (mit fiktiver IP-Adresse und API-Key als Header)
curl -H "apiKey: 8efd85c9-99df-4403-b0f2-6dfd5635ceb1" http://10.0.0.5/v3/MeterDataAPI/TradingSummary?format=xml
<tradingsummary>
<startTime>2025-05-16T08:53:20.000Z</startTime>
<endTime>2025-05-16T08:53:30.000Z</endTime>
<unixTimestamp>1747385610000</unixTimestamp>
<cubeName>P01_3900008</cubeName>
<aggregatedData>
<producer>false</producer>
<consumer>true</consumer>
<pv>277</pv>
<water>0</water>
<biogas>0</biogas>
<wind>0</wind>
<toCommunity>0</toCommunity>
<fromCommunity>277</fromCommunity>
<toSupplier>0</toSupplier>
<fromSupplier>0</fromSupplier>
<toGrid>0</toGrid>
<fromGrid>277</fromGrid>
<balance>3116</balance>
<communityShareable>0</communityShareable>
<communityConsumable>3116</communityConsumable>
</aggregatedData>
</tradingsummary>
Abfrage aus dem Internet als JSON (mit fiktivem Hostnamen und API-Key als URL-Parameter)
curl https://2e64965ab9b9f1903dd0efd0c38fde79.balena-devices.com//v3/MeterDataAPI/TradingSummary?apiKey=8efd85c9-99df-4403-b0f2-6dfd5635ceb1
{"startTime":"2025-05-16T08:54:10.000Z","endTime":"2025-05-16T08:54:20.000Z",
"unixTimestamp":1747385660000,"cubeName":"P01_3900008","aggregatedData":{"producer":false,
"consumer":true,"pv":276,"water":0,"biogas":0,"wind":0,"toCommunity":0,"fromCommunity":276,
"toSupplier":0,"fromSupplier":0,"toGrid":0,"fromGrid":276,"balance":3177,
"communityShareable":0,"communityConsumable":3177}}
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.