API List - Plants


Plant API

A plant is the user's homepage out of the following: Distributor, Company, Engineer and End User. The plant has information on the number of inverters  you have and the daily, monthly, yearly and total generation made by your inverters.

POST - plant/getPlantList

Returns a list of all plants.

Return
"total": 999,
"success": true,
"rows": [

"country": "UNITED_KINGDOM"  
"countryText": "England"  
"createDate": "2018-03-14" Date the account was created
"currentPower": "0.00"

The current power usage of all systems

"currentPowerText": "0 W" Current power usage in text form
"energyToday": "0.00" Today's home consumption
"energyTodayText": "0.00 kWh" Today's home consumption with Wh units
"energyTotal": "4350.40" Total home consumption
"energyTotalText": "4.35 MWh" Total home consumption with Wh units 
"name": "givenergy user" Name of your Givenergy Plant system
"nominalPower": 0  
"plantId": 1 The plant number of your profile. This is used in API calls 
"timezone": 0 Your time zone location to offset your inverter clock
"timezoneText": "GMT 0" Your time zone location in text
} ... ]

POST - plant/getPlantInfo

Returns the information of one plant page. 

Parameters
plantId Found from API get all plant list.

Return
An individual plant with the same output JSON as the above API call

POST - plant/getPlantSummary

Returns a list of your own plant information

Return

"activeInverterCount": "0/1" Number of inverters you own that are online
"averageHomeSelfConsumptionToday": 0  
"averageHomeSelfConsumptionTotal": "27.12"  
"batPower": "0.00" current battery Power
"batteryCapacity": 5 Capacity of the battery
"batteryCapacityText": "5.00 kWh"
 
"btToday": "0.10" Battery throughput today
"btMonth": "1.60" Battery throughput for a month
"bttTotal": "3709.70" Total battery throughput
"bttTotalText": "3.71 MWh"  
"chargeEnergyToday": "0.00" energy charged into the battery today
"consumptionEnergyToday": "0.00" energy used today from home
"consumptionEnergyTodayText": "0.00 kWh"  
"consumptionEnergyTotal": "3994.30" total energy used from home
"consumptionEnergyTotalText": "3994.30 kWh"  
"currentText: "0.00A"  
"dailyAlarmCount": 0 Number of issues system system has flagged
"dischargeEnergyToday": "0.00"  
"energyToday": "0.00"
energy charged from solar today
"energyTodayText": "0.00 kWh"  
"exportEnergyToday": "0.00" energy exported to the grid today
"exportEnergyTodayText": "0.00 kWh"  
"exportEnergyTotal": "4340.30" energy exported to the grid total
"exportEnergyTotalText": "4340.30 kWh"  
"feedInTariffToday": "0.00"  
"feedInTariffTotal": "80216.55"  
"gridEnergyOutToday": "0.00"
 
"gridEnergyOutTotal": "22743.17"
 
"gridPower": "0.00"
 
"gridPowerkW": "0.00"
 
"gridRelianceToday": 0  
"gridRelianceTotal": 69  
"hasMeterInfo": "true"  
"importEnergyToday": "0.00"  
"importEnergyTodayText": "0.00 kWh"  
"importEnergyTotal": "2775.10"  
"importEnergyTotalText": "2775.10 kWh"
 
"loadPower": 0  
"loadPowerText": "0 W"
 
"loadPowerkW": "0.00"  
"monthCo2Saved": "0.000"
 
"pInv": 0  
"pvPower": "0.00"  
"pvPowerText": "0 W"  
"pvPowerkW": "0.00"  
"savingsToday": "0.00"  
"savingsTotal": "20396.19"  
"selfConsumptionToday": "0.00"  
"selfConsumptionTodayText": "0.00 kWh"  
"selfConsumptionTotal": "1614.90"  
"selfConsumptionTotalText": "1614.90 kWh"  
"soc": 0  
"success": true  
"todayCo2Saved": "0.000"  
"totalCo2Saved": "5.937"
 
"totalGeneration": "5955.20"  
"totalGenerationText": "5.96 MWh"
 

POST - plant/getPlantRuntime

Get a summary of your energy data for the inverters you own

Parameters
plantId
-  Found from API get all plant list.

Return

"currentPower": "0.00"  
"currentPowerText": "0 W"  
"energyCo2": "4.337"
 
"energyToday": "0.00"
 
"energyTodayText": "0.00 kWh"
 
"energyTotal": "4350.40"
 
"energyTotalText": "4.35 MWh"
 
"energyTree": "39.08"  
"errorInverterCount": 0  
"load": "\ufffd"  
"lostDatalogCount": 0  
"lostInverterCount": 0  
"nominalPower": 0
 
"normalDatalogCount": 0  
"normalInverterCount": 0  
"plantId": 1  
"success": true  
"unknownInverterCount": 0  
"waitingInverterCount": 0  

POST - plant/getPlantDevices 

Get Plant's Inverter

Parameters
plantId
-  Found from API get all plant list.

Return

"datalogs": [ {  
"datalogType": "GPRS"
 
"deviceType": "DATALOG"  
"hasInverter": true  
"lost": false  
"serialNum": "WF..."  
"inverters": [{  
"alias": "SD..."
 
"address": "ST1"   
"batPercent": "85%"  
"batteryType": "Lithium battery"  
"currentPowerText": "601 W"  
"deviceType": "STORAGE"  
"energyTodayText": "0.70 kWh"  
"energyTotalText": "2.24 MWh"  
"nominalCapacity": 102  
"productModel": "Giv-HY5.0"  
"serialNum": "SD..."   
"status": "NORMAL"  
}]  
     "alias": "WF..."  
}]  
"success": true  
"plantId": 1  

POST - plant/getPlantEnergy

Get Plant Energy Output by Date, Month, Year, or Total

Parameters
Type - 
0: Daily, 1: Monthly, 2: Yearly, 3: Total. Pre-set endpoints will be available for each type
dateText - Format dependent on the Type input parameter
0 - YYYY-MM-DD
1 - YYYY-MM
2 - YYYY
3 - No dateText input

Return

"energy": "0.00"  
"energyText": "0.00 kWh",  
"plantId": 1,  
"success": true,  

POST - plant/event/getPlantEvents

Get Plant Event. Currently, the endpoint retrieves the past 10 events

Parameters
plantId -  Found from API get all plant list.

Return

"plantId": "1",  
"success": true,  
"total": 257,  
"rows": [  
"alias": "SD...",  
"clearedTime": "2019-09-27 09:51:12",  
"company": "Givenergy02",
 
"customEventType": "EVENT",  
"customEventTypeText": "Event",  
"datalogSn": "WF...",  
"endTime": "2019-09-27 09:46:54",
 
"endUser": "givenergy user",  
"event": "STORAGE_WARN_BMS_UNDER_VOLTAGE",  
"eventText": "BMS Under Voltage"  
"recordId": 2319  
"renormal": true  
"renormalTime": "2019-09-27 09:51:12",  
"serialNum": "SD...",
 
"startTime": "2019-09-27 09:46:54",  
"status": "Cleared"  
}, ... ]  

 



Article ID: 52
Created: April 29, 2021
Last Updated: May 13, 2021
Author: Adam Reynolds

Online URL: https://kb.givenergy.cloud/article.php?id=52