SolisCloud Monitoring API

All rights reserved

 Content
1. Introduction ................................................................................................................................................... 4

1.1. INTERFACE ACCESS METHOD .......................................................................................................................4

1.2. REQUEST URL ..............................................................................................................................................4

1.3. USER AUTHORIZATION INFORMATION ......................................................................................................... 4

1.4 PUBLIC HTTP HEADER DEFINITION .............................................................................................................5

1.5. RETURN DATA .............................................................................................................................................. 6

2. User Signature Authentication ................................................................................................................7

2.1. AUTHORIZATION FIELD CALCULATION METHOD ..........................................................................................7

2.2. AUTHORIZATION FIELD CALCULATION EXAMPLE ......................................................................................... 8

2.3 AUTHORIZATION EXAMPLE（FOR JAVA）DOWNLOAD LINK .....................................................................11

3. API Interface .................................................................................................................................................12

3.1. /V1/API/USERSTATIONLIST (POWER STATION LIST) ............................................................................12

3.2. /V1/API/STATIONDETAIL (POWER STATION DETAILS) ..........................................................................14

3.3. /V1/API/COLLECTORLIST (DATALOGGER LIST) ..................................................................................... 18

3.4. /V1/API/COLLECTORDETAIL (DATALOGGER DETAILS) .......................................................................... 19

3.5. /V1/API/INVERTERLIST (INVERTER LIST) .............................................................................................20

3.6. /V1/API/INVERTERDETAIL (INVERTER DETAILS) ................................................................................... 21

3.10. /V1/API/STATIONDAY (PLANT DAILY GRAPH) .................................................................................. 27

3.11. /V1/API/STATIONMONTH (PLANT MONTHLY GRAPH) .................................................................... 27

3.12. /V1/API/STATIONYEAR (PLANT YEARLY GRAPH) .............................................................................28

2
 3.13. /V1/API/STATIONALL (PLANT CUMULATIVE GRAPH) ....................................................................... 29

3.15. /V1/API/INVERTERDAY (INVERTER DAILY GRAPH) ............................................................................ 29

3.16. /V1/API/INVERTERMONTH (INVERTER MONTHLY GRAPH) .............................................................. 31

3.17. /V1/API/INVERTERYEAR (INVERTER YEARLY GRAPH) ......................................................................... 32

3.18. /V1/API/INVERTERALL (INVERTER CUMULATIVE GRAPH) ................................................................33

3.24. /V1/API/ALARMLIST (ALARM INFO CHECK) ................................................................................. 33

3.25. /V1/API/STATIONDETAILLIST (BATCH ACQUIRE PLANT DETAILS) ....................................................34

3.26. /V1/API/INVERTERDETAILLIST (BATCH ACQUIRE INVERTER DETAILS) .............................................. 38

3.27. /V1/API/STATIONDAYENERGYLIST (BATCH ACQUIRE PLANT DAILY GENERATION) ........................... 43

3.28. /V1/API/STATIONMONTHENERGYLIST (BATCH ACQUIRE PLANT MONTHLY GENERATION) ............ 43

3.29. /V1/API/STATIONYEARENERGYLIST (BATCH ACQUIRE PLANT YEARLY GENERATION) ....................... 44

3.30. /V1/API/EPMLIST (EPM LIST) ........................................................................................................45

3.31. /V1/API/EPMDETAIL (EPM DETAILS) ...............................................................................................45

3.32. /V1/API/EPM/DAY (EPM DAILY GRAPH) ........................................................................................ 47

3.33. /V1/API/EPM/MONTH (EPM MONTHLY GRAPH) ......................................................................... 48

3.34. /V1/API/EPM/YEAR (EPM YEARLY GRAPH) .................................................................................... 49

3.35. /V1/API/EPM/ALL (EPM CUMULATIVE GRAPH) ............................................................................49

4. APPENDIX .......................................................................................................................................................49

5. ALARM CODE ................................................................................................................................................ 50

3
1. Introduction

This document describes the interface definitions for third-party access to SolisCloud.

Third parties can obtain relevant information of photovoltaic power plants through the

following interfaces provided.

1.1. Interface Access Method

All interfaces involved in this document use HTTP POST method, and message

transmission is in JSON format. Different capabilities support different access protocols

and message formats. External systems need to select the corresponding access protocols

and message formats when accessing the SolisCloud platform. If you use JAVA language,

please try to run Authorization.java. It is a complete demo.

You need to do the following steps to call the API:

 Contact us to obtain the calling address and user authentication information as

shown in Section 1.2-1.3.

 Read through Section 1.4-2.2 to realize the calculation of the common request

header as showing in Section 1.4.1. The four parameters need to be carried in the

request header of each request. Otherwise, it cannot be connected.

 Read through Section 3 to get the specific interface information you need.

1.2. Request URL

Please log in to your SolisCloud account and go to Basic Setting-API Management to

gain the URL

4
1.3. User authorization information

Please provide your account registered on SolisCloud platform to Solis Service Team to

obtain the following key information

KeyID: Visitor ID .

KeySecret: Represents the key required for signature, which must be kept strictly

confidential to prevent leakage.

1.4 Public HTTP Header Definition

1.4.1 Public Request Header

Some public request headers are used in the interface. These request headers can be used

by all requests and are defined in detail as follows

Name Type Default Note

Authentication information
Authorization String - used to verify the validity of
the request.
Represents the MD5 value
of the requested content
data, calculates the MD5
Content-MD5 String - value of the message
content (excluding the
header) to obtain a 128-bit
number, and then base64

5
 encodes the number.
HTTP request content type.
Content-Type String application/json;charset=UTF-8 Only support
application/json
The GMT time specified in
the HTTP 1.1 protocol, for
Date String -
example: Wed, 05 Sep. 2019
23:00:00 GMT

1.4.2 Public Response Header

Some public request headers are used in the interface. These request headers can be used

by all requests and are defined in detail as follows

Name Type Default Note

HTTP request content type.
Content-Type String application/json Only support
application/json
The GMT time specified in
the HTTP 1.1 protocol, for
Date String -
example: Wed, 05 Sep. 2019
23:00:00 GMT

1.5. Return Data

If the code in the return parameter is 0, the call is successful. If the call is successful, the

result content of the business side is returned in the data.

Return parameter format:

{
"success": true,
"code": "0",
"msg": "Successful",
"data": { },
}

Name Type Length Note Description

success Boolean Success
code String Response code 0 is success
msg String Description code 0 is success, Others are error messages
data Group Return Data See the API interface for details

6
2. User Signature Authentication

2.1. Authorization Field calculation method

Authorization = "API " + KeyId + ":" + Sign
Sign = base64(HmacSHA1(KeySecret,
VERB + "\n"
+ Content-MD5 + "\n"
+ Content-Type + "\n"
+ Date + "\n"
+ CanonicalizedResource))

KeyID Visitor ID. (Contact technical support to obtain)

KeySecret It means that the key required for signature must be kept strictly confidential

to prevent leakage. (Contact technical support to obtain)

VERBRepresents the method of the HTTP request, this protocol is POST.

\n Represents a line break

Content-MD5 Represents the MD5 value of the requested content data, calculates the

MD5 value of the message content (excluding the header) to obtain a 128-bit number,

and then base64 encodes the number. When the message content is empty, the string is

empty.

Content-Type Indicates the type of request content, here is "application/json"

Date Indicates the time of this operation, and must be in GMT format, such as "Wed, 10

Jul 2019 13:16:22 GMT"

CanonicalizedResource Indicates the API interface you want to access, such as

"/v1/api/userStationList"

sign Represents digital signature, HmacSHA1 key encryption and base64 encoding

7
2.2. Authorization Field calculation example

If the KeyId is: 2424 and the KeySecret is: 6680182547, the following method can be used

to calculate the signature sign

2.2.1 Request:

POST /v1/api/userStationList
Content-MD5: kxdxk7rbAsrzSIWgEwhH4w==
Content-Type: application/json
Date: Fri, 26 Jul 2019 06:00:46 GMT
Authorization: API 2424: nBYQWeuzy3Y+gp67BN8zXTmvSDk=
Body：{"pageNo":1,"pageSize":10}

Note: There is no "Body:" in the post content sent

2.2.2 Date Time

Date time is the GMT time specified in the HTTP 1.1 protocol, you can refer to the

following JAVA code to obtain:

Note: Date time cannot exceed plus or minus 15 minutes of current time

/**
* Description: 获取 GMT 时间
* @return 将当前时间转换为 GMT 时区后的 String
*/
public static String getGMTTime(){

Calendar cd = Calendar.getInstance();
SimpleDateFormat sdf = new SimpleDateFormat("EEE, d MMM yyyy
HH:mm:ss 'GMT'", Locale.US);
sdf.setTimeZone(TimeZone.getTimeZone("GMT")); // 设置时区为 GMT
String str = sdf.format(cd.getTime());
return str;
}

2.2.3 Content-MD5 Encryption

The JAVA sample code for Content-MD5 encryption of Post content is as follows：

/**
* 1.先计算 MD5 加密的二进制数组（128 位）
。
* 2. 再对这个二进制进行 base64 编码（而不是对 32 位字符串编码）

8
 * @param plainText 加密明文
* @return 加密密文
*/
public static String getDigest(String test) {
String result = "";
try {
MessageDigest md = MessageDigest.getInstance("MD5");
md.update(test.getBytes());
byte[] b = md.digest();
result = Base64.encodeBytes(b);
} catch (NoSuchAlgorithmException e) {
e.printStackTrace();
}
return result;
}

The calculation result of Content-MD5 of “{"pageNo":1,"pageSize":10}”in the

example is: kxdxk7rbAsrzSIWgEwhH4w==

2.2.4. The signature string is:

"POST\nkxdxk7rbAsrzSIWgEwhH4w==\napplication/json\nFri, 26 Jul 2019

06:00:46 GMT\n/v1/api/userStationList"

The JAVA sample code for signature sign is as follows：

public static String HmacSHA1Encrypt(String encryptText, String

keySecret) throws Exception
{
byte[] data= keySecret.getBytes("UTF-8");
//根据给定的字节数组构造一个密钥,第二参数指定一个密钥算法的名称
SecretKey secretKey = new SecretKeySpec(data, "HmacSHA1");
//生成一个指定 Mac 算法 的 Mac 对象
Mac mac = Mac.getInstance("HmacSHA1");
//用给定密钥初始化 Mac 对象
mac.init(secretKey);
byte[] text = encryptText.getBytes("UTF-8");
//完成 Mac 操作
byte[] result = mac.doFinal(text);
return Base64.encodeBase64String(result);
}

The signature (Sign) calculation result should be nBYQWeuzy3Y+gp67BN8zXTmvSDk=

2.2.5. Authorization Calculation

9
Because Authorization = "API "+ KeyId + ":" + Signa, the final Authorization is “API 2424:

nBYQWeuzy3Y+gp67BN8zXTmvSDk=”

Note: There is a space char after “API”

Then add the Authorization header to form the final message that needs to be sent：

POST
kxdxk7rbAsrzSIWgEwhH4w==
application/json
Fri, 26 Jul 2019 06:00:46 GMT
/v1/api/userStationList

Encryption Example
Refer to https://dinochiesa.github.io/hmachash/index.html
1 Content-MD5 Calculation Example {"pageNo":1,"pageSize":10}

② Authorization Calculation Example

POST
kxdxk7rbAsrzSIWgEwhH4w==
application/json
Fri, 26 Jul 2019 06:00:46 GMT
/v1/api/userStationList

10
2.3 Authorization Example（For Java）Download Link
https://oss.ginlong.com/templet/Authorization.java

11
3. API Interface

Note: The calling frequency of all interfaces is limited to three times every five seconds for

the same IP

3.1. /v1/api/userStationList (Power Station List)

3.1.1. Input parameters

Name Type Description Note Compulsory

pageNo Int Current page Specify the number of response Y
number pages to be returned. The value
defaults to 1
pageSize Int Number per page Specify the number of records Y
returned in each response page.
The default value is 20, max 100
NmiCode String NMI Code(AU N
Only)

3.1.2. Output parameters

Name Type Description Note

page - Result list
stationStatusVo - Number of results
total Long Total list
records List<> List
Total number of
all Int power stations
Number of normal
normal Int power stations
Number of offline
offline Int stations
Number of failed
fault Int power stations
id Long Power station id
userId Long Owner Id
capacity String Installed capacity
Installed capacity
capacityStr String unit
Installed capacity
capacity1 Double (not-carry)
fullHour Double Full hours
picName String Picture
installerId Long Installer Organization

12
 id
installer String Installer Organization
dataTimestamp Long Update time
installerMobile String Installer
sno String Plant short ID
country Integer Country id
countryStr String Country Name
region Integer Region id
regionStr String Region Name
city Integer City id
cityStr String City Name
county Integer District id
countyStr String District name
dip Double Tilt angle
azimuth Double Azimuth angle
timeZone Double Time zone
timeZoneName String Time zone name
Time zone format
timeZoneStr String string
timeZoneId Long Time zone id
daylight Double Daylight saving
createDate Long Create Time
price Double Pirce per kwh
module Long Module number
pic1Url String Plant Picture 1 url
power Double Power
powerStr String Power unit
dayEnergy Double Daily Energy
dayEnergyStr String Daily Energy unit
dayIncome Double Daily income
dayIncomeUnit String Daily income unit
monthEnergy Double Monthly Energy
monthEnergyStr String Monthly Energy unit
yearEnergy Double Yearly Energy
yearEnergyStr String Yearly Energy unit
allEnergy Double Total Energy
allEnergyStr String Total Energy unit
allEnergy1 Double Total Energy Original
allIncome Double Total Income
allIncomeUnit String Total Income Unit
0Full Grid Tied 1Self-consumption
synchronizationType Integer Grid type 2Off-grid
stationTypeNew Integer Type: Default 0 1 – Grid tied;2 – Grid-tied+Meter at

13
 load side;3 - Grid-tied+Meter at grid
side;4 – Hybrid+ Meter at load side;5
- Hybrid+ Meter at grid side ;
Battery total
batteryTotalDischargeEnergy Double discharge energy
Battery total charge
batteryTotalChargeEnergy Double energy
Meter total import
gridPurchasedTotalEnergy Double energy
Meter total export
gridSellTotalEnergy Double energy
Load total
homeLoadTotalEnergy Double consumption energy
oneSelf Double Self-consumption
Battery daily
batteryTodayDischargeEnergy Double discharge energy
Battery daily charge
batteryTodayChargeEnergy Double energy
Meter daily import
gridPurchasedTodayEnergy Double energy
Meter daily export
gridSellTodayEnergy Double energy
Load daily
homeLoadTodayEnergy Double consumption energy
money String Currency unit
fisPowerTime Long First power on time
fisGenerateTime Long First generate time
remark1 String remark1
remark2 String remark 2
remark3 String remark 3
state Int Plant status 1：Online 2：Offline 3：Alarm
dataTimestamp Long Plant Update time Timestamp
Sum of Inverter rated
inverterPower String AC power
nmiCode String Nmi code For AU only

3.2. /v1/api/stationDetail (Power Station Details)

3.2.1. Input parameters

Name Type Description Note Compulsory

id Long Power Station id Y
nmiCode String nmi Code N

14
3.2.2. Output parameters

Name Type Description Note

id Long Power Station id
userId Long Owner ID
capacity String Installed Capacity
capacityStr String Installed Capacity Unit
dayEnergy Double Today Generation
dayEnergyStr String Today Generation Unit
monthEnergy Double Month Generation
monthEnergyStr String Month Generation Unit
yearEnergy Double Year Generation
yearEnergyStr String Year Generation Unit
allEnergy Double Total Generation
allEnergyStr String Total Generation Unit
dayInCome Double Today Revenue
dayInComeUnit String Today Revenue Unit
monthInCome Double Month Revenue
monthInComeUnit String Month Revenue Unit
yearInCome Double Year Revenue
yearInComeUnit String Year Revenue Unit
allInCome Double Total Revenue
allInComeUnit String Total Revenue Unit
fullHour Double Peak Hours
picName String Pictures
power Double Power
powerStr String Power Unit
dip Double Tilt Angle
azimuth Double Azimuth Angle
price String Revenue per kilowatt hour
1：Online 2：Offline 3：
state Int Power station status Alarm
dataTimestamp Long Power station update time Timestamp
money String Currency
brand String Brand
condTxtN String Night Weather
condTxtD String Daytime Weather
tmpMax String Max Temperature
tmpMin String Lowest Temperature
tmpUnit String Temperature Unit
sr String Sunris Time
ss String Sundown Time
windSpd String Wind speed, km/hr

15
windDir String Wind direction
powerStationNumTree String 植树
powerStationNumTreeUnit String Tree Unit
powerStationAvoidedCo2 String CO2 reduction
powerStationAvoidedCo2Unit String CO2 reduction unit
module Long Module Number
batteryPower Double Battery Power
batteryPowerStr String Battery Power unit
batteryPowerPec Double Battery Power percentage
batteryPercent Double Battery SOC
Battery this day discharge
batteryDischargeEnergy Double energy
Battery this day discharge
batteryDischargeEnergyStr String unit
Battery this month
batteryDischargeMonthEnergy Double discharge energy
Battery this month
batteryDischargeMonthEnergyStr String discharge unit
Battery this year discharge
batteryDischargeYearEnergy Double energy
Battery this year discharge
batteryDischargeYearEnergyStr String unit
Battery
batteryDischargeTotalEnergy Double disChargeTotalEnergy
Battery
batteryDischargeTotalEnergyStr String disChargeTotalEnergy unit
Battery this day charge
batteryChargeEnergy Double energy
batteryChargeEnergyStr String Battery this day charge unit
Battery this month charge
batteryChargeMonthEnergy Double energy
Battery this month charge
batteryChargeMonthEnergyStr String unit
Battery this year charge
batteryChargeYearEnergy Double energy
Battery this year charge
batteryChargeYearEnergyStr String unit
batteryChargeTotalEnergy Double batteryChargeTotalEnergy
batteryChargeTotalEnergy
batteryChargeTotalEnergyStr String unit
psum Double Meter power
psumStr String Meter power unit
psumPec Double Meter powerPercentage

16
 Meter today purchase
gridPurchasedDayEnergy Double energy
Meter today purchase
gridPurchasedDayEnergyStr String energy unit
Meter this month purchase
gridPurchasedMonthEnergy Double energy
Meter this month purchase
gridPurchasedMonthEnergyStr String energy unit
Meter this year purchase
gridPurchasedYearEnergy Double energy
Meter this year purchase
gridPurchasedYearEnergyStr String energy unit
Meter total purchase
gridPurchasedTotalEnergy Double energy
Meter total purchase
gridPurchasedTotalEnergyStr String energy unit
gridSellDayEnergy Double Meter today sell energy
Meter today sell energy
gridSellDayEnergyStr String unit
Meter this month sell
gridSellMonthEnergy Double energy
Meter this month sell
gridSellMonthEnergyStr String energy unit
gridSellYearEnergy Double Meter this year sell energy
Meter this year sell energy
gridSellYearEnergyStr String unit
gridSellTotalEnergy Double Meter total sell energy
gridSellTotalEnergyStr String Meter total sell energy unit
familyLoadPower Double Load power
familyLoadPowerStr String Load power unit
familyLoadPowerPec Double Load powerPercentage
homeLoadEnergy Double Today load energy
homeLoadEnergyStr String Today load energy unit
homeLoadMonthEnergy Double Monthly load energy
homeLoadMonthEnergyStr String Monthly load energy unit
homeLoadYearEnergy Double Yearly load energy
homeLoadYearEnergyStr String Yearly load energy unit
homeLoadTotalEnergy Double Total load energy
homeLoadTotalEnergyStr String Total load energy unit
inverterPower String Sum of inverter AC power
nmiCode String Nmi code
country Integer Country id
countryStr String Country name

17
region Integer Region id
regionStr String Region name
city Integer City id
cityStr String City Name
county Integer District id
countyStr String District Name
dip Double Tilt angle
azimuth Double Azimuth angle
timeZone Double Timezone
timeZoneName String Timezone name
timeZoneStr String Time zone format string
timeZoneId Long Timezone id
daylight Double Daylight saving
createDate Long Create time
1 – Grid tied;2 –
Grid-tied+Meter at load
side;3 - Grid-tied+Meter
at grid side;4 – Hybrid+
Meter at load side;5 -
Hybrid+ Meter at grid
stationTypeNew Integer Type :Default 0 side ;
fisPowerTime Long First power-on time
fisGenerateTime Long First generation time

3.3. /v1/api/collectorList (Datalogger List)

3.3.1. Input parameters

Name Type Description Note Compulsory

pageNo String Current page Specify the number of response pages Y
number to be returned. The value defaults to 1
pageSize String Number per Specify the number of records Y
page returned in each response page. The
default value is 20, max 100
stationId Long Plant id Without: Check all under the installer. N
With: Check the indicated plant
nmiCode String Nmi Code N

3.3.2. Output parameters

Name Type Description Note

page - Result list
collectionStatusVo - Number of results
total Long Total list

18
records List<> List
all Int Total Number
normal Int Normal number
offline Int Offline number
fault Int Number of failures
id Long Collector id
stationId Long Power Station Id
userId Long Owner Id
sn String Collector SN
model String Model GPRS,WiFi
name String Collector name
rssiLevel String Collector signal strength
state Collector status 1：Online 2：Offline 3：Alarm
dataTimestamp Collector update time Timestamp

3.4. /v1/api/collectorDetail (Datalogger Details)

3.4.1. Input parameters

Name Type Description Note Compulsory

id Long Collector id id and sn must send one N
sn String Collector sn id and sn must send one N

3.4.2. Output parameters

Name Type Description Note

id Long Collector id
stationId Long Power Station Id
userId Long Owner Id
state Long Power station status 1：Online 2：Offline 3：Alarm
Power station update
dataTimestamp Int time Timestamp
Cumulative working
totalWorkingTime Long time
sn Long Collector SN
model String model GPRS,WiFi
name String Collector name
Collector signal
rssiLevel String strength
lanIp String LAN ip
Maximum number of
maximumNumber Int connected units
Actual number of
actualNumber Int connected units
connectionOperator String Operator

19
 Working time of this
currentWorkingTime Long power-on
Cumulative working
totalWorkingTime Long time
dataUpload Cycle Int Data Upload interval
factoryTime Long Factory time

3.5. /v1/api/inverterList (Inverter List)

3.5.1. Input parameters

Name Type Description Note Compulsory

pageNo String Current page Specify the number of response Y
number pages to be returned. The value
defaults to 1
pageSize String Number per page Specify the number of records Y
returned in each response page.
The default value is 20, max
100
stationId Long Power station id Without: Check all under the N
installer.
With: Check the indicated plant
nmiCode String Nmi Code N

3.5.2. Output parameters

Name Type Description Note

page - Result list
inverterStatusVo - Number of results
total Long Total list
records List<> List
Total number of
all Int inverter in this plant
Number of normal
normal Int inverter in this plant
Number of offline
offline Int inverter in this plant
Number of faulty
fault Int inverters in this plant
id Long Inverter id
sn String Inverter SN
stationId Long Power station id
userId Long Owner Id
power String Installed capacity
powerStr String Installed capacity unit

20
etoday Double Energy of the day
etodayStr Double Energy unit of the day
etotal Double Total energy
etotalStr Double Total energy unit
fullHour Double Peak Hours
pac Double power
pacStr Double Power unit
state Int Power station status 1：Online 2：Offline 3：Alarm
Power station update
dataTimestamp Long time Timestamp
collectorSn String Datalogger sn
productModel String Inverter model
0 – 1 input;1 - 2 input;2 - 3 input;3 - 4
dcInputType Integer dcInputType input
acOutputType Integer acOutputType 0-1ph; others – 3ph
series String Inverter series
name String Inverter name
collectorState Integer Datalogger status
0 normal offline
stateExceptionFlag Integer 1abnormal offline
eToday Double Daily generation kwh
Daily generation kwh
eToday1 Double original
eTodayStr String Daily generation unit
eTotal Double Total generation
Total generation
eTotal1 Double original
eTotalStr String Total generation unit
totalFullHour Double Total peak hours
1 – Grid tied;2 – Grid-tied+Meter at
load side;3 - Grid-tied+Meter at grid
inverterMeterModel Integer side;4 – Hybrid+ Meter at load side;5
Inverter Type - Hybrid+ Meter at grid side ;
createDate Long Create time

3.6. /v1/api/inverterDetail (Inverter Details)

3.6.1. Input parameters

Name Type Description Note Compulsory

id Long Inverter id d and sn must send one N
sn String Inverter sn id and sn must send one N

3.6.2. Output parameters

21
Name Type Description Note
id Long Inverter id
sn String Inverter SN
stationId Long Power station id
userId Long Owner Id
collectorId Long Collector id
collectorName String Collector name
collectorsn String Collector SN
currentState Current state
Energy of the
eToday day
Energy unit of
eTodayStr the day
Energy of the
eMonth month
Energy unit of
eMonthStr the month
Energy of the
eYear year
Energy unit of
eYearStr the year
eTotal Total energy
eTotalStr Total energy unit
fac Grid frequency
Grid frequency
facStr unit
pac Real-time power
Real-time power
pacStr unit
Power
pacPec percentage
fullHour Peak hours
picName image
Installed
power capacity
Installed
powerStr capacity unit
iAc1 AC current R
iAc2 AC current S
iAc3 AC current T
uAc1 AC voltage R
uAc2 AC voltage S
uAc3 AC voltage T

22
iPv1 DC current 1
iPv2 DC current 2
iPv3 DC current 3
iPv4 DC current 4
uPv1 DC voltage 1
uPv2 DC voltage 2
uPv3 DC voltage 3
uPv4 DC voltage 4
....... ......
iPv32 DC current 32
uPv32 DC voltage 32
Power station
state status 1：Online 2：Offline 3：Alarm
Power station
dataTimestamp update time Timestamp
Inverter
inverterTemperature temperature
National
nationalStandardstr standard
acOutputType AC output type 0: 1 phase Rest are 3 phase
dcInputtype Dc input type Num+1
powerFactor Power factor
batteryPower Battery power
Battery power
batteryPowerStr unit
Battery
batteryPowerPec powerPercentage
batteryCapacitySoc Battery SOC
batteryHealthSoh Battery SOH
Overdischarge
socDischargeSet SOC
Forcecharge
socChargingSet SOC
Current
operating battery
batteryType model
batteryVoltage Battery voltage
Battery voltage
batteryVoltageStr unit
bstteryCurrent Battery current
Battery current
bstteryCurrentStr unit
batteryPower Battery power

23
 Battery power
batteryPowerStr unit
Battery
batteryPowerPec powerPercentage
Battery alarm01
batteryFailureInformation01
Battery alarm02
batteryFailureInformation02
Today battery
charge energy
batteryTodayChargeEnergy
Today battery
charge energy
batteryTodayChargeEnergyStr unit
This month
battery charge
energy
batteryMonthChargeEnergy
This month
battery charge
batteryMonthChargeEnergyStr energy unit
This year battery
charge energy
batteryYearChargeEnergy
This year battery
charge energy
batteryYearChargeEnergyStr unit
Total battery
charge energy
batteryTotalChargeEnergy
Total battery
charge energy
batteryTotalChargeEnergyStr unit
Today battery
discharge energy
batteryTodayDischargeEnergy
Today battery
discharge energy
batteryTodayDischargeEnergyStr unit
This month
battery discharge
energy
batteryMonthDischargeEnergy
batteryMonthDischargeEnergyStr This month

24
 battery discharge
energy unit
This year battery
discharge energy
batteryYearDischargeEnergy
This year battery
discharge energy
batteryYearDischargeEnergyStr unit
Total battery
discharge energy
batteryTotalDischargeEnergy
Total battery
discharge energy
batteryTotalDischargeEnergyStr unit

Today meter
gridPurchasedTodayEnergy purchase energy
Today meter
purchase energy
gridPurchasedTodayEnergyStr unit
This month
meter purchase
gridPurchasedMonthEnergy energy
This month
meter purchase
gridPurchasedMonthEnergyStr energy unit
This year meter
gridPurchasedYearEnergy purchase energy
This year meter
purchase energy
gridPurchasedYearEnergyStr unit
Total meter
gridPurchasedTotalEnergy purchase energy
Total meter
purchase energy
gridPurchasedTotalEnergyStr unit
Today meter sell
gridSellTodayEnergy energy
Today meter sell
gridSellTodayEnergyStr energy unit
This month
gridSellMonthEnergy meter sell energy
This month
gridSellMonthEnergyStr meter sell energy

25
 unit
This year meter
gridSellYearEnergy sell energy
This year meter
gridSellYearEnergyStr sell energy unit
Total meter sell
gridSellTotalEnergy energy
Total meter sell
gridSellTotalEnergyStr energy unit

HouseLoad
power
familyLoadPower
HouseLoad
familyLoadPowerStr power unit
BackUpload
power
bypassLoadPower
BackUpload
bypassLoadPowerStr power unit
Grid total active
pSum power
Grid total active
pSumStr power unit
psumPec Grid total active
powerPercentage
Today load
energy
homeLoadTodayEnergy
Today load
homeLoadTodayEnergyStr energy unit
homeLoadTotalEnergy Total load energy
Total load energy
homeLoadTotalEnergyStr unit
Note: 5100,5101,5102,5103 is
model string model
off grid hybrid inverter
1.PV
type integer inverter .2Energy
Storage Inverter
name String Inverter name

1 – Grid tied;2 –
Grid-tied+Meter at load
inverterMeterModel Integer Inverter Type side;3 - Grid-tied+Meter at

26
 grid side;4 – Hybrid+ Meter
at load side;5 - Hybrid+
Meter at grid side ;
0 Normal Offline
1 Abnormal
stateExceptionFlag Integer Offline
Data logger
collectorState Integer status 1 Online 2 Offline
Data logger
collectorModel String model
Warning
warningInfoData Integer Message
productModel String Inverter Model
Effective Grid
nationalStandards String Code
Inverter
version String firmware version

3.10. /v1/api/stationDay (Plant Daily Graph)

3.10.1. Input parameters

Name Type Description Note Compulsory

id Long Power station id Either “id” or “nmicode” N
money String Power plant Y
currency unit
time String time time: "2019-07-26" Y
timeZone Integer Power plant time Y
zone
nmiCode String nmicode Either “id” or “nmicode” N

3.10.2. Output parameters

Name Type Description Note

power Long power
powerStr String Power unit
time Long Timestamp 1564088700000
money Long income
moneyStr String Income unit

3.11. /v1/api/stationMonth (Plant Monthly Graph)

3.11.1. Input parameters

Name Type Description Note Compulsory

27
id Long Power station id Either “id” or “nmicode” N
money String Power plant Y
currency unit
month String time month: "2019-07" Y
nmiCode String nmicode Either “id” or “nmicode” N

3.11.2. Output parameters

Name Type Description Note

energy Long Power generation
energyStr String Power generation unit
date Long Timestamp 1564088700000
money Long income
moneyStr String Income unit
batteryDischargeEnergy Battery discharge energy
batteryChargeEnergy Battery charge energy
gridPurchasedEnergy Meter purchase energy
gridSellEnergy Meter sell energy

3.12. /v1/api/stationYear (Plant Yearly Graph)

3.12.1. Input parameters

Name Type Description Note Compulsory

id Long Power station id Either “id” or “nmicode” N
money String Power plant Y
currency unit
year String time year: "2019" Y
nmiCode String nmicode Either “id” or “nmicode” N

3.12.2. Output parameters

Name Type Description Note

energy Long Power
generation
energyStr String Power
generation
unit
date Long Timestamp 1564088700000
money Long income
moneyStr String Income unit
batteryDischargeEnergy Battery
discharge
energy
batteryChargeEnergy Battery

28
 charge
energy
gridPurchasedEnergy Meter
purchase
energy
gridSellEnergy Meter sell
energy

3.13. /v1/api/stationAll (Plant cumulative graph)

3.13.1. Input parameters

Name Type Description Note Compulsory

id Long Power station Either “id” or “nmicode” N
id
money String Power plant Y
currency unit
nmiCode String nmicode Either “id” or “nmicode” N

3.13.2. Output parameters

Name Type Description Note

energy Long Power generation
energyStr String Power generation
unit
date Long Timestamp 1564088700000
money Long income
moneyStr String Income unit
batteryDischargeEnergy Battery discharge
energy
batteryChargeEnergy Battery charge
energy
gridPurchasedEnergy Meter purchase
energy
gridSellEnergy Meter sell energy

3.15. /v1/api/inverterDay (Inverter Daily Graph)

3.15.1. Input parameters

Name Type Description Note Compulsory

id Long Inverter id Id or sn N
sn String Inverter sn Id or sn N
money String Power plant Y

29
 currency unit
time String time time: "2019-07-26" Y
timeZone Integer Power plant time Y
zone

3.15.2. Output parameters

Name Type Description Note

dataTimestamp Long Timestamp
Update time
conversion string
timeStr String based on plant time
zone

eToday Energy of the day

eTotal Total energy
fac Grid frequency
pac Real-time power
Real-time power
pacStr unit
pacPec Power percentage
power Installed capacity
iAc1 AC current R
iAc2 AC current S
iAc3 AC current T
uAc1 AC voltage R
uAc2 AC voltage S
uAc3 AC voltage T
iPv1 DC current 1
iPv2 DC current 2
iPv3 DC current 3
iPv4 DC current 4
uPv1 DC voltage 1
uPv2 DC voltage 2
uPv3 DC voltage 3
uPv4 DC voltage 4
inverterTemperature Inverter temperature
acOutputType AC output type 0:1 phase， rest are 3 phase
dcInputtype Dc input type NUM+1
powerFactor PF
batteryCapacitySoc Battery SOC
batteryHealthSoh Battery SOH
socDischargeSet Overdischarge SOC
socChargingSet Forcecharge SOC

30
batteryVoltage Battery Voltage
bstteryCurrent Battery Current
batteryPower Battery Power
Today Battery
batteryTodayChargeEnergy Charge Energy
Total Battery
batteryTotalChargeEnergy Charge Energy
Today Battery
batteryTodayDischargeEnergy Discharge Energy
Total Battery
batteryTotalDischargeEnergy Discharge Energy
Today Meter
gridPurchasedTodayEnergy Purchase Energy
Total Meter
gridPurchasedTotalEnergy Purchase Energy
Today Meter Sell
gridSellTodayEnergy Energy
Total Meter Sell
gridSellTotalEnergy Energy

Home Load Power

familyLoadPower
Backup Load Power
bypassLoadPower
Grid Total Active
pSum Power
Today Load
homeLoadTodayEnergy consumption energy
Total Load
homeLoadTotalEnergy consumption energy

3.16. /v1/api/inverterMonth (Inverter Monthly Graph)

3.16.1. Input parameters

Name Type Description Note Compulsory

id Long Inverter id Id or SN N
sn String Inverter sn Id or SN N
money String Power plant Y
currency unit
month String time time: "2019-07" Y

3.16.2. Output parameters

31
Name Type Description Note
energy Long Power generation
energyStr String Power generation unit
date Long Timestamp 1564088700000
money Long income
moneyStr String Income unit
batteryDischargeEnergy Battery discharge
energy
batteryChargeEnergy Battery charge energy
gridPurchasedEnergy Meter purchase energy
gridSellEnergy Meter sell energy

3.17. /v1/api/inverterYear (Inverter yearly graph)

3.17.1. Input parameters

Name Type Description Note Compulsory

id Long Inverter id Id or SN N
sn String Inverter sn Id or SN N
money String Power plant Y
currency unit
year String time time: "2019" Y

3.17.2. Output parameters

Name Type Description Note

energy Long Power
generation
energyStr String Power
generation
unit
date Long Timestamp 1564088700000
money Long income
moneyStr String Income unit
batteryDischargeEnergy Battery
discharge
energy
batteryChargeEnergy Battery
charge
energy
gridPurchasedEnergy Meter
purchase
energy
gridSellEnergy Meter sell

32
 energy

3.18. /v1/api/inverterAll (Inverter Cumulative Graph)

3.18.1. Input parameters

Name Type Description Note Compulsory

id Long Inverter id Id or SN N
sn String Inverter sn Id or SN N
money String Power plant Y
currency unit

3.18.2. Output parameters

Name Type Description Note

year Int year
energy Long Power generation
energyStr String Power generation
unit
money Long income
moneyStr String Income unit
batteryDischargeEnergy Battery discharge
energy
batteryChargeEnergy Battery charge
energy
gridPurchasedEnergy Meter purchase
energy
gridSellEnergy Meter sell energy

3.24. /v1/api/alarmList (Alarm info check)

3.24.1. Input parameters

Name Type Description Note Compulsory

pageNo String Current page Specify the number of response Y
number pages to be returned. The value
defaults to 1
pageSize String Number per page Specify the number of records Y
returned in each response page. The
default value is 20, max 100
stationId Long Plant ID Without: Check all under the N
installer.
With: Check the indicated plant
alarmDeviceSn String InverterSN Without: Check all under the N

33
 installer.
With: Check the indicated plant
alarmBeginTime String Alarm startTime yyyy-MM-dd, Without: check all N
alarmEndTime String Alarm stopTime yyyy-MM-dd, Without: check all N
nmiCode String nmicode N

3.24.2. Output parameters

Name Type Description Note

stationId Long Plant ID
alarmDeviceSn String InverterSN
alarmCode String Alarm code
alarmLevel String Alarm level 1Reminder 2ordinary 3Emergency
alarmBeginTime Long Alarm startTime
alarmEndTime Long Alarm stopTime
alarmMsg String Alarm content
advice String Alarm suggestion
state String Alarm status 0 Pending 1Solved 2Recover

3.25. /v1/api/stationDetailList (Batch acquire plant details)

3.25.1. Input parameters

Name Type Description Note Compulsory

pageNo Integer Current page Specify the number of response Y
number pages to be returned. The value
defaults to 1
pageSize Integer Number per page Specify the number of records Y
returned in each response page.
The default value is 20, max
100

3.25.2. Output parameters

Name Type Description Note

id Long Plant ID
userId Long User ID
capacity String Installed capacity
capacityStr String Installed capacity unit
dayEnergy Double Today energy
dayEnergyStr String Today energy unit
monthEnergy Double This month energy
monthEnergyStr String This month energy unit
yearEnergy Double This year energy
yearEnergyStr String This year energy unit

34
allEnergy Double Total energy
allEnergyStr String Total energy unit
dayInCome Double Today income
dayInComeUnit String Today income unit
monthInCome Double This month income
monthInComeUnit String This month income unit
yearInCome Double This year income
yearInComeUnit String This year income unit
allInCome Double Total income
allInComeUnit String Total income unit
fullHour Double Peak hours
picName String Picture
power Double Poower
powerStr String Poower unit
dip Double Tilte angle
azimuth Double Azimuth angle
price String Earning per kwh
1：Online 2：Offline 3：
state Int Plant status Alarm
dataTimestamp Long Plant update time Time Stamp
money String Currency
brand String Brand
condTxtN String Night weather
condTxtD String Day time weather
tmpMax String Highest Temperature
tmpMin String Lowest Temperature
tmpUnit String Temperature unit
sr String Sunrise time
ss String Sundown time
windSpd String Wind speed km/hr
windDir String Wind direction
powerStationNumTree String Plant tree
powerStationNumTreeUnit String Plant tree unit
powerStationAvoidedCo2 String CO2 reduction
powerStationAvoidedCo2Unit String CO2 reduction unit
module Long Module Number
batteryPower Double Battery Power
batteryPowerStr String Battery Power unit
batteryPowerPec Double Battery PowerPercentage
batteryPercent Double Battery SOC
Battery this day discharge
batteryDischargeEnergy Double energy
batteryDischargeEnergyStr String Battery this day discharge

35
 unit
Battery this month
batteryDischargeMonthEnergy Double discharge energy
Battery this month
batteryDischargeMonthEnergyStr String discharge unit
Battery this year discharge
batteryDischargeYearEnergy Double energy
Battery this year discharge
batteryDischargeYearEnergyStr String unit
Battery
batteryDischargeTotalEnergy Double disChargeTotalEnergy
Battery
batteryDischargeTotalEnergyStr String disChargeTotalEnergy unit
Battery this day charge
batteryChargeEnergy Double energy
batteryChargeEnergyStr String Battery this day charge unit
Battery this month charge
batteryChargeMonthEnergy Double energy
Battery this month charge
batteryChargeMonthEnergyStr String unit
Battery this year charge
batteryChargeYearEnergy Double energy
Battery this year charge
batteryChargeYearEnergyStr String unit
batteryChargeTotalEnergy Double batteryChargeTotalEnergy
batteryChargeTotalEnergy
batteryChargeTotalEnergyStr String unit
psum Meter power
psumStr Meter power unit
psumPec Meter powerPercentage
Meter today purchase
gridPurchasedDayEnergy energy
Meter today purchase
gridPurchasedDayEnergyStr energy unit
Meter this month purchase
gridPurchasedMonthEnergy energy
Meter this month purchase
gridPurchasedMonthEnergyStr energy unit
Meter this year purchase
gridPurchasedYearEnergy energy
Meter this year purchase
gridPurchasedYearEnergyStr energy unit
gridPurchasedTotalEnergy Meter total purchase

36
 energy
Meter total purchase
gridPurchasedTotalEnergyStr energy unit
gridSellDayEnergy Meter today sell energy
Meter today sell energy
gridSellDayEnergyStr unit
Meter this month sell
gridSellMonthEnergy energy
Meter this month sell
gridSellMonthEnergyStr energy unit
gridSellYearEnergy Meter this year sell energy
Meter this year sell energy
gridSellYearEnergyStr unit
gridSellTotalEnergy Meter total sell energy
gridSellTotalEnergyStr Meter total sell energy unit
familyLoadPower Load power
familyLoadPowerStr Load power unit
familyLoadPowerPec Load powerPercentage
homeLoadEnergy Today load energy
homeLoadEnergyStr Today load energy unit
homeLoadMonthEnergy Double Monthly load energy
homeLoadMonthEnergyStr String Monthly load energy unit
homeLoadYearEnergy Double Yearly load energy
homeLoadYearEnergyStr String Yearly load energy unit
homeLoadTotalEnergy Double Total load energy
homeLoadTotalEnergyStr String Total load energy unit
inverterPower String Sum of inverter AC power
nmiCode String Nmi code
country Integer Country id
countryStr String Country name
region Integer Region id
regionStr String Region name
city Integer City id
cityStr String City Name
county Integer District id
countyStr String District Name
dip Double Tilt angle
azimuth Double Azimuth angle
timeZone Double Timezone
timeZoneName String Timezone name
timeZoneStr String Time zone format string
timeZoneId Long Timezone id
daylight Double Daylight saving

37
createDate Long Create time
0 Grid tied, 1 Hybrid ， 2
AC without inverter ， 3
EPM，4 Internal meter，
stationTypeNew Integer Type :Default 0 5 External meter
fisPowerTime Long First power-on time
fisGenerateTime Long First generation time

3.26. /v1/api/inverterDetailList (Batch acquire Inverter details)

3.26.1. Input parameters

Name Type Description Note Compulsory

pageNo Integer Current page Specify the number of response Y
number pages to be returned. The value
defaults to 1
pageSize Integer Number per page Specify the number of records Y
returned in each response page.
The default value is 20, max
100

3.26.2. Output parameters

Name Type Description Note

id Long Inverterid
sn String InverterSN
stationId Long Plant ID
userId Long User ID
collectorId Long Dataloggerid
collectorName String DataloggerName
collectorsn String Datalogger SN
currentState String Current status
eToday Double Today energy
eTodayStr String Today energy unit
eMonth Double This month energy
This month energy
eMonthStr String unit
eYear Double This year energy
This year energy
eYearStr String unit
eTotal Double Total energy
eTotalStr String Total energy unit
fac Double Grid frequency
facStr String Grid frequency unit

38
pac Double Real timePoower
Real timePoower
pacStr String unit
pacPec Double PoowerPercentage
fullHour Double Peak hours
picName String Picture
power Double Installed capacity
Installed capacity
powerStr String unit
iAc1 Double AC CurrentR
iAc2 Double AC CurrentS
iAc3 Double AC CurrentT
uAc1 Double AC VoltageR
uAc2 Double AC VoltageS
uAc3 Double AC VoltageT
iPv1 Double DC Current1
iPv2 Double DC Current2
iPv3 Double DC Current3
iPv4 Double DC Current4
uPv1 Double DC Voltage1
uPv2 Double DC Voltage2
uPv3 Double DC Voltage3
uPv4 Double DC Voltage4

iPv32 Double DC Current 32

uPv32 Double DC Voltage 32
state Int Plant status 1：Online 2：Offline 3：Alarm
dataTimestamp Long Plant update time Time Stamp
inverterTemperature Double InverterTemperature
nationalStandardstr String CountryStandard
acOutputType Int AC output type 0： 1ph rest：3ph
dcInputtype Int DC input type num+1
powerFactor Double Power factor
batteryPower Double Battery power
batteryPowerStr String Battery power unit
Battery
batteryPowerPec Double powerPercentage
batteryCapacitySoc Double Battery SOC
batteryHealthSoh Double Battery SOH
socDischargeSet Double Overdischarge SOC
socChargingSet Double Forcecharge SOC
Current operating
batteryType String battery model

39
batteryVoltage Double Battery voltage
batteryVoltageStr String Battery voltage unit
bstteryCurrent Double Battery current
bstteryCurrentStr String Battery current unit
batteryPower Double Battery power
batteryPowerStr String Battery power unit
Battery
batteryPowerPec Double powerPercentage
Battery alarm01
batteryFailureInformation01 String
Battery alarm02
batteryFailureInformation02 String
Today battery
charge energy
batteryTodayChargeEnergy Double
Today battery
batteryTodayChargeEnergyStr String charge energy unit
This month battery
charge energy
batteryMonthChargeEnergy Double
This month battery
batteryMonthChargeEnergyStr String charge energy unit
This year battery
charge energy
batteryYearChargeEnergy Double
This year battery
batteryYearChargeEnergyStr String charge energy unit
Total battery charge
energy
batteryTotalChargeEnergy Double
Total battery charge
batteryTotalChargeEnergyStr String energy unit
Today battery
discharge energy
batteryTodayDischargeEnergy Double
Today battery
discharge energy
batteryTodayDischargeEnergyStr String unit
This month battery
discharge energy
batteryMonthDischargeEnergy Double
This month battery
discharge energy
batteryMonthDischargeEnergyStr String unit

40
 This year battery
discharge energy
batteryYearDischargeEnergy Double
This year battery
discharge energy
batteryYearDischargeEnergyStr String unit
Total battery
discharge energy
batteryTotalDischargeEnergy Double
Total battery
discharge energy
batteryTotalDischargeEnergyStr String unit
Today meter
gridPurchasedTodayEnergy Double purchase energy
Today meter
purchase energy
gridPurchasedTodayEnergyStr String unit
This month meter
gridPurchasedMonthEnergy Double purchase energy
This month meter
purchase energy
gridPurchasedMonthEnergyStr String unit
This year meter
gridPurchasedYearEnergy Double purchase energy
This year meter
purchase energy
gridPurchasedYearEnergyStr String unit
Total meter
gridPurchasedTotalEnergy Double purchase energy
Total meter
purchase energy
gridPurchasedTotalEnergyStr String unit
Today meter sell
gridSellTodayEnergy Double energy
Today meter sell
gridSellTodayEnergyStr String energy unit
This month meter
gridSellMonthEnergy Double sell energy
This month meter
gridSellMonthEnergyStr String sell energy unit
This year meter sell
gridSellYearEnergy Double energy
This year meter sell
gridSellYearEnergyStr String energy unit

41
 Total meter sell
gridSellTotalEnergy Double energy
Total meter sell
gridSellTotalEnergyStr String energy unit
HouseLoad power
familyLoadPower Double
HouseLoad power
familyLoadPowerStr String unit
BackUpload
power
bypassLoadPower Double
BackUpload
bypassLoadPowerStr String power unit
Grid total active
pSum Double power
Grid total active
pSumStr String power unit
psumPec Grid total active
Double powerPercentage
Today load energy
homeLoadTodayEnergy Double
Today load energy
homeLoadTodayEnergyStr String unit
homeLoadTotalEnergy Double Total load energy
Total load energy
homeLoadTotalEnergyStr String unit
Note: 5100,5101,5102,5103 is
model String model off-grid hybrid
type Integer 1 Grid tied 2 Hybrid
name String Inverter name

1 – Grid tied;2 – Grid-tied+Meter at

load side;3 - Grid-tied+Meter at
grid side;4 – Hybrid+ Meter at
load side;5 - Hybrid+ Meter at grid
inverterMeterModel Integer Inverter Type side ;
0 Normal Offline 1
stateExceptionFlag Integer Abnormal Offline
collectorState Integer Data logger status 1 Online 2 Offline
collectorModel String Data logger model
warningInfoData Integer Warning Message
productModel String Inverter Model
nationalStandards String Effective Grid Code

42
 Inverter firmware
version String version

3.27. /v1/api/stationDayEnergyList (Batch acquire plant daily

Generation)

3.27.1. Input parameters

Name Type Description Note Compulsory

pageNo Integer Current page Specify the number of response Y
number pages to be returned. The value
defaults to 1
pageSize Integer Number per page Specify the number of records Y
returned in each response page.
The default value is 20, max 100
time String Time time: "2019-07-26" Y

3.27.2. Output parameters

Name Type Description Note

id Long Plant ID
energy Generation
energyStr String Generation unit
date Long Time Stamp 1564088700000
money Income
moneyStr String Income unit
batteryDischargeEnergy Battery discharge
energy
batteryChargeEnergy Battery charge energy
gridPurchasedEnergy Meter purchase energy
gridSellEnergy Meter sell energy

3.28. /v1/api/stationMonthEnergyList (Batch acquire plant monthly

Generation)

3.28.1. Input parameters

Name Type Description Note Compulsory

pageNo Integer Current page Specify the number of response pages to be Y
number returned. The value defaults to 1
pageSize Integer Number per Specify the number of records returned in each Y
page response page. The default value is 20, max 100

43
 time String Time time: "2019-07" Y
nmiCode String nmicode N

3.28.2. Output parameters

Name Type Description Note

id Long Plant ID
energy Generation
energyStr String Generation unit
date Long Time Stamp 1564088700000
money Income
moneyStr String Income unit
batteryDischargeEnergy Battery discharge
energy
batteryChargeEnergy Battery charge energy
gridPurchasedEnergy Meter purchase energy
gridSellEnergy Meter sell energy

3.29. /v1/api/stationYearEnergyList (Batch acquire plant yearly

Generation)

3.29.1. Input parameters

Name Type Description Note Compulsory

pageNo Integer Current page Specify the number of response Y
number pages to be returned. The value
defaults to 1
pageSize Integer Number per page Specify the number of records Y
returned in each response page.
The default value is 20, max 100
time String Time time: "2019" Y

3.29.2. Output parameters

Name Type Description Note

id Long Plant ID
energy Generation
energyStr String Generation unit
date Long Time Stamp 1564088700000
money Income
moneyStr String Income unit
batteryDischargeEnergy Battery discharge
energy
batteryChargeEnergy Battery charge energy

44
gridPurchasedEnergy Meter purchase energy
gridSellEnergy Meter sell energy

3.30. /v1/api/epmList (EPM List)

3.30.1. Input parameters

Name Type Description Note Compulsory

pageNo String Current page Specify the number of response pages Y
number to be returned. The value defaults to 1
pageSize String Number per Specify the number of records Y
page returned in each response page. The
default value is 20, max 100
stationId Long Plant ID Without: Check all under the installer. N
With: Check the indicated plant

3.30.2. Output parameters

Name Type Description Note

sn String EPM-SN
collectorId Long Datalogger id
collectorSn String Datalogger id
userId Long User id
stationId Long Plant id
state Integer Device Status 1 Online 2 Offline
dataTimestamp Long Plant Update Time Time stamp
failSafe String FailSafe switch 0 OFF 1 ON
pEpmTotal Double EPM Total Power
pEpmTotalStr String EPM Total Power Unit
eTotalBuy Double Total Purchase Energy
eTotalBuyStr String Total Purchase Energy
Unit
eTotalSell Double Total Sell Energy
eTotalSellStr String Total Sell Energy Unit

3.31. /v1/api/epmDetail (EPM Details)

3.31.1. Input parameters

Name Type Description Note Compulsory

sn String EPM sn Must send Y

3.31.2. Output parameters

Name Type Description Note

45
sn String EPM-SN
collectorId Long Datalogger id
collectorSn String Datalogger id
userId Long User id
stationId String Plant id
state Integer Device Status 1 Online 2 Offline
dataTimestamp Long Plant Update Time Time stamp
failSafe String FailSafe switch 0 OFF 1 ON
empSoftwareVersion String EPM Software Version
pLimit Double Power Limit Percentage
ctRatio Double CT Ratio
pSet Double Backflow Power Setting
pSetStr String Backflow Power Setting
Unit
pInverterTotal Double Inverter total power
pInverterTotalStr String Inverter total power unit
eToaalInverter Double Inverter total generation
eToaalInverterStr String Inverter total generation
unit
pLoad Double Total Consumption
Power
pLoadStr String Total Consumption
Power Unit
eTotalLoad Double Total Consumption
Energy
eTotalLoadStr String Total Consumption
Energy Unit
pEpmTotal Double EPM Total Power
pEpmTotalStr String EPM Total Power Unit
eTotalBuy Double Total Purchase Energy
eTotalBuyStr String Total Purchase Energy
Unit
eTotalSell Double Total Sell Energy
eTotalSellStr String Total Sell Energy Unit
iAc1 Double Current U Unit A
iAc2 Double Current V Unit A
iAc3 Double Current W Unit A
uAc1 Double Voltage U Unit V
uAc2 Double Voltage V Unit V
uAc3 Double Voltage W Unit V
pAc1 Double Power U Unit W
pAc2 Double Power V Unit W
pAc3 Double Power W Unit W

46
powerFactor Double PF
facMeter Double Grid Frequency

3.32. /v1/api/epm/day (EPM Daily Graph)

3.32.1. Input parameters

Name Type Description Note Compulsory

searchinfo String Query field, u_ac1 -voltage U Y
multiple fields are u_ac2 -voltage V
separated by u_ac3 -voltage W
commas i_ac1 -current U
i_ac2 -current V
i_ac3 -current W
p_ac1 -power U
p_ac2 -power V
p_ac3 -power W
power_factor -grid power factor
fac_meter -grid frequency
(Meter)
p_load -total load power
e_toaal_inverter -Total inverter
power generation
e_total_load -load total
electricity consumption
e_total_buy
e_total_sell
sn String EPM SN Must Send Y
time String 2020-09-24 Y
timeZone Integer Plant Time Zone Y

3.32.2. Output parameters

Name Type Description Note

dataTimestamp Long Update time (8 time data_timestamp
zone)
timeStr String String with the update
time converted according
to the time zone of the
plant
pEpmTotal Long EPM total power (total p_epm_total
grid power) Negative -
buy electricity, positive -
sell electricity
pEpmTotalStr String EPM total power unit When the unit is rounded, the power

47
 generation should be * percentage
pEpmTotalPec String EPM total power When the unit is rounded, the power
percentage generation should be * percentage
eTotalBuy Long Total active energy taken Upload e_total_buy to get
from the grid
eTotalSell Long Total active energy Upload e_total_sell to get
export to grid
uAc1 Long EPM AC voltage U Upload u_ac1 to get
iAc1 Long EPM AC current U Upload i_ac1 to get
pAc1 Long EPM active power U Upload p_ac1 to get
uAc2 Long EPM AC voltage V Upload u_ac2 to get
iAc2 Long EPM AC current V Upload i_ac2 to get
pAc2 Long EPM active power V Upload p_ac2 to get
uAc3 Long EPM AC voltage W Upload u_ac3 to get
iAc3 Long EPM AC current W Upload i_ac3 to get
pAc3 Long EPM active power W Upload p_ac3 to get
pInverterTotal Long Inverter total power Upload p_inverter_total to get
pLimit Long Power Limit Percentage Upload p_limit to get
ctRatio Long CT ratio Upload ct_ratio to get
powerFactor Long Grid PF Upload power_factor to get
facMeter Long Grid Frequency Upload fac_meter to get
pLoad Long Load total consumption Upload p_load to get
power
eToaalInverter Long Inverter total generation Upload e_toaal_inverter to get
eTotalLoad Long Load total consumption Upload e_total_load to get
energy

3.33. /v1/api/epm/month (EPM Monthly Graph)

3.33.1. Input parameters

Name Type Description Note Compulsory

sn String EPM SN Must Send Y
month String Time month: "2019-07" Y

3.33.2. Output parameters

Name Type Description Note

date Long timestamp millisecond
dateStr String time string 2019-07-01
energy Double power generation
energyStr String power generation unit
epmSellEnergy buy electricity Unit kWh
epmBuyEnergy selling electricity Unit kWh

48
3.34. /v1/api/epm/year (EPM Yearly Graph)

3.34.1. Input parameters

Name Type Description Note Compulsory

sn String EPM SN Must Send Y
year String Time year: "2019" Y

3.34.2. Output parameters

Name Type Description Note

date Long timestamp millisecond
dateStr String time string 2019-07
energy Double power generation
energyStr String power generation unit
epmSellEnergy buy electricity Unit kWh
epmBuyEnergy selling electricity Unit kWh

3.35. /v1/api/epm/all (EPM Cumulative Graph)

3.35.1. Input parameters

Name Type Description Note Compulsory

sn String EPM SN 必 Upload Y

3.35.2. Output parameters

Name Type Description Note

year Integer Year 2020
energy Double power generation
energyStr String power generation unit
epmSellEnergy buy electricity Unit kWh
epmBuyEnergy selling electricity Unit kWh

4. APPENDIX
Status Chinese
English Explanation
Code Explanation

R0000 无权限操作 No authority

B0001 已绑定其他用户 Has been bound to other users

I0003 请输入 SN 号 Please enter SN

49
Status Chinese
English Explanation
Code Explanation

该采集器已不存在 The collector no longer exists or has no

B0049
或无权限，无法查看 permissions and cannot be viewed

I0000 必要参数为空 The necessary parameters are empty

B0011 该用户不存在 The user does not exist

帐号或者密码错误， Incorrect account or password, please

I0012
请重新输入 re-enter

5. ALARM CODE
https://oss.ginlong.com/templet/Alarm%20information%28%E6%8A%A5%E8%AD%A6%E4%BF%A1
%E6%81%AF%29.xlsx

50