Skip to Content

API List - Inverters

Inverter API

The inverter is owned by an End user, distributed by a company, and commissioned by an Engineer. The inverter states the amount of energy generated

POST - inverter/getInverterInfo 

Get Inverter Information

Parameters
serialNum
- The hybrid number of your inverter

Return

"alias": "SA..."  
"batPercent": "30.00%"  
"batteryType": "Lithium battery"  
"commissionDate": "2020-07-13"  
"company": ""
 
"companyAddress": ","
 
"companyPostcode": ""  
"datalogSn": "WF..."  
"deviceType": "STORAGE"  
"endUser": ""  
"endUserAddress": ""  
"endUserPostcode": "YO8"  
"nominalCapacity": "102.0"  
"nominalPower": 3600  
"productModel": "Giv-HY3.6"  
"serialNum": "SA..."  
"success": true,
 

POST - inverter/getInverterRuntime

Get Inverter power snapshot

Parameters
serialNum
- The hybrid number of your inverter

Return

"lost": false,
 
"pac": 1,
 
"pacText": "1.0 W",  
"pGrid": -180,
 
"pGridText": "-180 W",
 
"pLoad": 181,
 
"pLoadText": "181 W",
 
"ppv1": 2623,  
"ppv1Text": "2623.0 W",  
"ppv2": 0,  
"ppv2Text": "0.0 W",  
"status": "NORMAL"
 
"statusText": "Normal",
 
"success": true,
 

POST - inverter/getInverterEnergy 

Get Inverter Generation by Date, Month, Year or Total

Parameters
serialNum
- The hybrid number of your inverter
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": "1075.10"  
"energyText": "1.08 MWh",  
"serialNum": "SA...",  
"success": true,  

POST - pcs/batCell/getBatCellData

Return the battery data of an inverter

Parameters
serialNum -
The hybrid number of your inverter

Return

"lost": false,
 
"maxVoltModule": 1,  
"minVoltModule": 1,  
"success": true,  
"modules": [{  
"cellVoltage1": 3378,  
"cellVoltage2": 3375,  
"cellVoltage3": 3374,  
"cellVoltage4": 3377,  
"cellVoltage5": 3375,  
"cellVoltage6": 3377,  
"cellVoltage7": 3378,  
"cellVoltage8": 3382,  
"cellVoltage9": 3382,  
"cellVoltage10": 3378,  
"cellVoltage11": 3382,  
"cellVoltage12": 3378,  
"cellVoltage13": 3385,  
"cellVoltage14": 3382,  
"cellVoltage15": 3383,  
"cellVoltage16": 3383,  
"cellTempreture1Text": "19.7"  
"cellTempreture2Text": "19.9",  
"cellTempreture3Text": "18.4",  
"cellTempreture4Text": "17.4",
 
"charging": 1,
 
"discharging": 1,
 
"hasBmsCellModuleInfo": true,  
"maxVoltItem": 13,  
"maxVoltDiffValue": 11,  
"minVoltItem": 3,
 
"moduleSoc": 43,  
"moduleVoltage": 542,  
"module": 1,  
"moduleTempretureText": "33.1",
 
} ]  
 

POST - inverter/getInverterRuntime

Parameters
serialNum -
The hybrid number of your inverter

Return

"lost": false,  
"pac": 1076,  
"pacText": "1076.0 W",  
"pGrid": 576,  
"pGridText": "576 W",  
"pLoad": 500,  
"pLoadText": "500 W",  
"ppv1": 2615,  
"ppv1Text": "2615.0 W",  
"ppv2": 0,  
"ppv2Text": "0.0 W",
 
"status": "NORMAL"  
"statusText": "Normal",  
"success": true,