Skip to Content

API List

This is a list of available APIs that are currently being used by the GivEnergy domain

For users unfamiliar with APIs. Please follow the link for using Postman

Our API uses Session Cookies to allow retention between each API calls. Working solutions have been found for integration outside of postman - JSoup, Node-RED. These are examples of backend based API tools for integration with your appliances. Postman also includes snippets of code for different programming languages, which makes use of session cookies to maintain retention.

Base URL - http://www.givenergy.cloud/GivManage/api/

The login is session based, meaning the connection will persist as long as the user does not log out. This is the first API that the user will need to send. Expected endpoint format will output in JSON


Login API

POST - login

Parameters
account - Your Username
password - Your Password

Return
{"success":true}

Lists of Available APIs

 

Miscellaneous APIs

POST - givenergy.cloud/GivManage/invData/
Returns datatable information of the inverter. This data can be shown on the system data page of your inverter

Parameters
page - Set to 1 
row - 
Number of data rows that are returned

Return

"total": 356,  
"rows": [  
"batCurrent": "0.00",  
"batPercent": "100.00",  
"batPower": "0.00",  
"batTemperature": "17.00",  
"batVoltage": "53.61",  
"chgTemperature": "27.80",  
"eacToday": "0.20",  
"eacTotal": "15.80",  
"exportEnergyToday": "0.30",  
"fac": "50.00",  
"gridExportEnergyTotal": "14.30",  
"gridImportEnergyTotal": "47.00",  
"iacr": "0.00",  
"iacs": "0.00",  
"iact": "20.50",  
"importEnergyToday": "7.30",
 
"invFrequency": "49.99",  
"invImportEnergyToday": "0.30",  
"invImportEnergyTotal": "37.60",  
"invVoltage": "246.30",
 
"ipv1": "0.00",  
"ipv2": "0.00",  
"loadPower": "230.00",  
"meter1ActivePower": "0.00",  
"meter2ActivePower": "-230.00",  
"meter2ApparentPower": "301.00",
 
"meter2PowerFactor": "2370.00",  
"moduleVoltage": "53.70",  
"pac": "-230.00",  
"pacr": "0.00",  
"pacs": "0.00",  
"pact": "0.00",  
"ppv": "0.00",  
"ppv1": "0.00",  
"ppv2": "0.00",  
"runtime": "26.00",  
"status": "WAITING"  
"temperature": "28.00",  
"time": "2020-10-27 23:54:36",  
"vacr": "247.50",  
"vacs": "0.00",  
"vact": "54.60",  
"vpv1": "245.20",
 
"vpv2": "0.00",
 

POST - givenergy.cloud/GivManage/invMeter/

Returns Meter data. This data can be shown on the meter data page of your inverter

Parameter
Page - Set to 1
Rows - Number of data rows that are returned

Return
{
"total": 287,
"rows": [
{
"acChargeToday": "0.10",
"acChargeTotal": "9.10",
"consumptionToday": "16.20",
"chargeEnergyToday"0.00"
"chargeEnergyTotal": "2567.80",
"combinedToday": "3.90",
"combinedTotal"13.10"
"consumptionToday"2.70"
"consumptionTotal"52.60",
"dischargeEnergy": "0.00"
"dischargeEnergyTotal": "2567.80",
"exportToday": "0.10",
"exportTotal": "2.30",
"importToday": "10.80",
"importTotal": "25.40",
"pvGenerationToday": "1.70",
"pvGenerationTotal": "3.50",
"selfConsumptionToday": "1.60",
"selfConsumptionTotal": "1.20"
"time": "2020-10-27 23:56:18",

},

POST - givenergy.cloud/GivManage/cellData/

Returns battery cell data. This data can be shown on the battery cell data page of your inverter

Parameter
Page - Set to 1
Rows - Number of data rows that are returned

Return
{
"total": 114,
"rows": [
{
"capacity": "10200.00",
"cellVoltage0": "-0.001",
"cellVoltage1": "3.282",
"cellVoltage2": "3.283",
"cellVoltage3": "3.282",
"cellVoltage4": "3.283",
"cellVoltage5": "3.285",
"cellVoltage6": "3.283",
"cellVoltage7": "3.283",
"cellVoltage8": "3.285",
"cellVoltage9": "3.285",
"cellVoltage10": "3.287",
"cellVoltage11": "3.287",
"cellVoltage12": "3.287",
"cellVoltage13": "3.287",
"cellVoltage14": "3.287",
"cellVoltage15": "3.290",
"cellVoltage16": "3.290",
"cellTempreture4": "8.3",
"cellTempreture3": "8.3",
"cellTempreture2": "8.3",
"cellTempreture1": "8.3",
"fullCap": "100.54",
"module": 1,
"moduleTempreture": "9.8",
"moduleVoltage": "52.5",
"soc": 11,
"time": "2020-12-24 10:15:20"
}, ...
]