0% found this document useful (0 votes)
248 views42 pages

SolisCloud API 1.0.8

This document describes SolisCloud's monitoring API version 1.0.8, which allows third parties to access information about photovoltaic plants via HTTP requests. It outlines the authentication process, API endpoints, parameters, and return data for getting plant, inverter, and energy generation details. The API provides methods for both individual requests and batch requests.

Uploaded by

adnel svadba
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
248 views42 pages

SolisCloud API 1.0.8

This document describes SolisCloud's monitoring API version 1.0.8, which allows third parties to access information about photovoltaic plants via HTTP requests. It outlines the authentication process, API endpoints, parameters, and return data for getting plant, inverter, and energy generation details. The API provides methods for both individual requests and batch requests.

Uploaded by

adnel svadba
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 42

SolisCloud Monitoring API

V1.0.8

Write: hualei Date: 2020-9-14

Check: Date:

Approve: Date:

All rights reserved


宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 2 / 41 Eff Date: 2019年08月01日

Revision History

Versio Content Eidtor Date


V1.0.0 Initial Hualei 20190726
V1.0.1 Add new plant Hualei 20190730
V1.0.2 Add new device Hualei 20190815
V1.0.3 Add inverter graph Hualei 20190822
V1.0.4 Add plant modification Hualei 20191017
V1.0.5 Added modify sub-account and query user Hualei 20191022
V1.0.5 Added new power station binding Hualei 20200914
V1.0.6 Add alarm checking interface Hualei 20201014
V1.0.7 Add inverter control interface Hualei 20210105
V1.0.8 Add plant and inverter batch interface Hualei 20210318

2
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 3 / 41 Eff Date: 2019年08月01日

Content
1. INTRODUCTION......................................................................................................................................... 5

1.1. PORT ACCESS METHOD............................................................................................................................5


1.2. REQUEST URL...........................................................................................................................................5
1.3. PUBLIC HTTP HEADER DEFINITION........................................................................................................ 5
1.4. RETURN DATA..........................................................................................................................................6

2. USER SIGNATURE AUTHENTICATION................................................................................................ 7

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


2.2. AUTHORIZATION FIELD CALCULATION EXAMPLE.................................................................................... 7
2.3. ADD USER PASSWORD ENCRYPTION..........................................................................................................9

3. API INTERFACE.........................................................................................................................................11

3.1. /V1/API/USERSTATIONLIST POWER STATION LIST.................................................................................. 11


3.2. /V1/API/STATIONDETAIL POWER STATION DETAILS................................................................................12
3.3. /V1/API/COLLECTORLIST DATALOGGER LIST......................................................................................... 15
3.4. /V1/API/COLLECTORDETAIL DATALOGGER DETAILS........................................................................... 16
3.5. /V1/API/INVETERLIST INVERTER LIST.................................................................................................. 17
3.6. /V1/API/INVETERDETAIL INVERTER DETAILS........................................................................................18
3.7. /V1/API/ADDUSER NEW USER (CREATE IF NOT EXISTS; IF EXISTS, RETURN USERID).............................23
3.8. /V1/API/ ADDSTATION NEW PLANT........................................................................................................ 23
3.9. /V1/API/STATIONDAY PLANT DAILY GRAPH...........................................................................................24
3.10. /V1/API/STATIONMONTH PLANT MONTHLY GRAPH............................................................................... 24
3.11. /V1/API/STATIONYEAR PLANT YEARLY GRAPH...................................................................................... 25
3.12. /V1/API/STATIONALL PLANT CUMULATIVE GRAPH................................................................................. 26
3.13. /V1/API/ADDDEVICE ADD DEVICE.......................................................................................................... 26
3.14. /V1/API/INVERTERDAY INVERTER DAILY GRAPH.................................................................................... 26
3.15. /V1/API/INVERTERMONTH INVERTER MONTHLY GRAPH.........................................................................27
3.16. /V1/API/INVERTERYEAR INVERTER YEARLY GRAPH................................................................................. 28
3.17. /V1/API/INVERTERALL INVERTER CUMULATIVE GRAPH..........................................................................29
3.18. /V1/API/STATIONUPDATE PLANT MODIFICATION.................................................................................... 29
3.19. /V1/API/UPDATEINSTALLER PLANT SUB-ACCOUNT MODIFICATION........................................................30
3.20. /V1/API/USERLIST USER LIST..............................................................................................................30
3.21. /V1/API/ADDSTATIONBINDCOLLECTOR NEW PLANT TO BIND COLLECTOR..........................................31
3.22. /V1/API/DELCOLLECTOR PLANT UNBIND DATALOGGER......................................................................32
3.23. /V1/API/ALARMLIST ALARM INFO CHECK........................................................................................... 32
3.24. /V1/API/STATIONDETAILLIST BATCH ACQUIRE PLANT DETAILS..................................................... 33
3.25. /V1/API/INVERTERDETAILLIST BATCH ACQUIRE INVERTER DETAILS...................................................... 36
3.26. /V1/API/STATIONDAYENERGYLIST BATCH ACQUIRE PLANT DAY GENERATION..................................... 40

3
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 4 / 41 Eff Date: 2019年08月01日

3.27. /V1/API/STATIONMONTHENERGYLIST BATCH ACQUIRE PLANT MONTH GENERATION...........................41


3.28. /V1/API/STATIONYEARENERGYLIST B BATCH ACQUIRE PLANT YEAR GENERATION..............................42

4
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 5 / 41 Eff Date: 2019年08月01日

1. INTRODUCTION
This document describes the third party using Soliscloud interface definition. A third party can use the
provided ports to get corresponding information of the PV plants.
1.1. Port Access Method
All interfaces involved in this document use HTTP POST, and message transmission is in JSON format.
Different capabilities support different access protocols and message formats. When external systems
access the SolisCloud platform, they need to select the corresponding access protocol and message
format.
1.2. Request url
Please contact Solis tech support
1.3. Public HTTP Header Definition
1.3.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
Authorization String - Authentication information used to
verify the validity of the request.
Content-MD5 String - 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.
Content-Type String application/json;charset=UTF-8 HTTP request content type.
Only support application/json
Date String - The GMT time specified in the HTTP
1.1 protocol, for example: Wed, 05
Sep. 2019 23:00:00 GMT

1.3.2. Public Response Header


Some public response headers are used in the interface. These response headers can be used by
all requests and are defined in detail as follows
Name Type Default Note
Content-Type String application/json HTTP request content type.
Only support application/json
Content-Type String HTTP request content type.。
Date String - The GMT time specified in the HTTP 1.1
protocol, for example: Wed, 05 Sep. 2019
23:00:00 GMT

5
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 6 / 41 Eff Date: 2019年08月01日

1.4. 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
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 7 / 41 Eff Date: 2019年08月01日

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

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: mBAcWORUK93FBOz6jsAuqw==
Content-Type: application/json
Date: Fri, 26 Jul 2019 06:00:46 GMT
Authorization: API 2424: ForAqMkym0v7R94RSU0rRqpEkf0=
Body:{"userId":"1145611319416590338"}
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:

7
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 8 / 41 Eff Date: 2019年08月01日

/**
* Description: 获取 GMTTime
* @return 将当前 Time 转换为 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 位字符串编码)
* @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 "{"userId":"1145611319416590338"}" in the example is:
mBAcWORUK93FBOz6jsAuqw==
2.2.4. The signature string is:
" POST\nmBAcWORUK93FBOz6jsAuqw==\napplication/json\nFri, 26 Jul 2019
06:00:46 GMT\n/v1/api/userStationList"

8
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 9 / 41 Eff Date: 2019年08月01日

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");
//根据给定的字节数组构造一个密钥,第二参数指定一个密钥算法的 Name
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 /2Np3q5h846q9cWEFUNtbL+G7H8=,
2.2.5. Authorization Calculation
Because Authorization = "API "+ KeyId + ":" + Signa, the final Authorization is “API 2424:
/2Np3q5h846q9cWEFUNtbL+G7H8=”,

Then add the Authorization header to form the final message that needs to be sent:
POST /v1/api/userStationList
Content-MD5: mBAcWORUK93FBOz6jsAuqw==
Content-Type: application/json
Date: Fri, 26 Jul 2019 06:00:46 GMT
Authorization: API 2424:/2Np3q5h846q9cWEFUNtbL+G7H8=
{"userId":"1145611319416590338"}
2.3. Add user password encryption
MD5 encryption for password, JAVA code example:
public static String md5(String sourceStr) {
String result = "";
try {
MessageDigest md = MessageDigest.getInstance("MD5");
md.update(sourceStr.getBytes());
byte[] b = md.digest();
int i;
StringBuffer buf = new StringBuffer("");
for (int offset = 0; offset < b.length; offset++) {
i = b[offset];
if (i < 0) {

9
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 10 / 41 Eff Date: 2019年08月01日

i += 256;
}
if (i < 16) {
buf.append("0");
}
buf.append(Integer.toHexString(i));
}
result = buf.toString();
} catch (Exception e) {
System.out.println(e);
}
return result;
}

10
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 11 / 41 Eff Date: 2019年08月01日

3. API INTERFACE
3.1. /v1/api/userStationList Power Station List
3.1.1. Input parameters
Name Type Description Note
pageNo Int Current page number Specify the number of response
pages to be returned. The value
defaults to 1
pageSize Int Number per page Specify the number of records
returned in each response page. The
default value is 20, max 100
userId Long User id If send the value, check the user’s
plant, if not send, check all plants

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
stationName String Power station name
Power station
addr String address
userId Long Owner Id
userName String Owner's name
mobile String phone number
capacity String Installed capacity
Installed capacity
capacityStr String unit
dayEnergy Today Generation

11
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 12 / 41 Eff Date: 2019年08月01日

Today Generation
dayEnergyStr unit
allEnergy Total Generation
Total Generation
allEnergyStr Unit
fullHour Peak Hours
picName Picture
power Power
powerStr Power Unit
latitude String latitude
longitude String longitude
installerId Main account id
installer Main account
1:Online 2:Offline 3:Alarm
state Power station status
Power station update
dataTimestamp Long time Timestamp

3.2. /v1/api/stationDetail Power Station Details


3.2.1. Input parameters
Name Type Description Note
id Long Power Station id

3.2.2. Output Parameters


Name Type Description Note
id Long Power Station id
stationName String Power Station Name
addr String Power Station Address
userId Long Owner ID
userName String Owner Name
mobile String Phone Number
capacity String Installed Capacity
capacityStr String Installed Capacity Unit
dayEnergy Today Generation
dayEnergyStr Today Generation Unit
monthEnergy Month Generation
monthEnergyStr Month Generation Unit
yearEnergy Year Generation
yearEnergyStr Year Generation Unit

12
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 13 / 41 Eff Date: 2019年08月01日

allEnergy Total Generation


allEnergyStr Total Generation Unit
dayInCome Today Revenue
dayInComeUnit Today Revenue Unit
monthInCome Month Revenue
monthInComeUnit Month Revenue Unit
yearInCome Year Revenue
yearInComeUnit Year Revenue Unit
allInCome Total Revenue
allInComeUnit Total Revenue Unit
fullHour Peak Hours
picName Pictures
power Power
powerStr Power Unit
latitude String latitude
longitude String longitude
dip Tilt Angle
azimuth Azimuth Angle
Revenue per kilowatt
price hour
installerId Main account id
installer Main account
1:Online 2:Offline 3:
state Power station status Alarm
Power station update
dataTimestamp time Timestamp
money Currency
brand Brand
countryStr Country
regionStr Area
cityStr City
condTxtN Night Weather
condTxtD Daytime Weather
tmpMax Max Temperature
tmpMin Lowest Temperature
tmpUnit Temperature Unit
powerStationNumTree Tree
powerStationNumTreeUnit Tree Unit
powerStationAvoidedCo2 CO2 reduction

13
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 14 / 41 Eff Date: 2019年08月01日

powerStationAvoidedCo2Unit CO2 reduction unit


module Long Module Number
mobile Long Plant Contact
installerEmail String Installer Email
installerMobile Long Installer Mobile
batteryPower Battery Power
batteryPowerStr Battery Power unit
Battery Power
batteryPowerPec percentage
batteryDischargeEnergy Battery discharg energy
Battery discharg energy
batteryDischargeEnergyStr unit
batteryChargeEnergy Battery charge energy
Battery charge energy
batteryChargeEnergyStr unit
batteryPercent Battery SOC
psum Meter power
psumStr Meter power unit
psumPec Meter powerPercentage
Meter today purchase
gridPurchasedDayEnergy energy
Meter today purchase
gridPurchasedDayEnergyStr energy unit
Meter this month
gridPurchasedMonthEnergy purchase energy
Meter this month
gridPurchasedMonthEnergyStr purchase energy unit
Meter this year
gridPurchasedYearEnergy purchase energy
Meter this year
gridPurchasedYearEnergyStr purchase energy unit
Meter total purchase
gridPurchasedTotalEnergy energy
Meter total purchase
gridPurchasedTotalEnergyStr energy unit
gridSellDayEnergy Meter today sell energy
Meter today sell energy
gridSellDayEnergyStr unit
gridSellMonthEnergy Meter this month sell

14
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 15 / 41 Eff Date: 2019年08月01日

energy
Meter this month sell
gridSellMonthEnergyStr energy unit
Meter this year sell
gridSellYearEnergy energy
Meter this year sell
gridSellYearEnergyStr energy unit
gridSellTotalEnergy Meter total sell energy
Meter total sell energy
gridSellTotalEnergyStr unit
familyLoadPower Load power
familyLoadPowerStr Load power unit
familyLoadPowerPec Load powerPercentage
homeLoadEnergy Today load energy
homeLoadEnergyStr Today load energy unit

3.3. /v1/api/collectorList Datalogger List


3.3.1. Input parameters
Name Type Description Note
pageNo String Current page Specify the number of response pages to
number be returned. The value defaults to 1
pageSize String Number per Specify the number of records returned
page in each response page. The default value
is 20, max 100
stationId Long Plant id Without: Check all under the installer.
With: Check the indicated plant
3.3.2. Output Parameter
Name Type Description Note
page - Result list
collectionStatusVo - Number of results
total Long Total list
records List<> List
all Int Total Number
normal Int Normal number
offline Int Offline number
fault Int Number of failures
id Long Collector id
stationName String Plant name

15
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 16 / 41 Eff Date: 2019年08月01日

stationId Long Power Station Id


userId Long Owner Id
sn String Collector SN
model String Model GPRS,WiFi
name String Collector name
Collector signal
rssiLevel String strength
Cumulative working
runingTime time
Data Package start
gprsBeginTime time
Data Package end
gprsEndTime time
state Collector status 1:Online 2:Offline 3:Alarm
Collector update
dataTimestamp time Timestamp
3.4. /v1/api/collectorDetail Datalogger Details
3.4.1. Input parameters
Name Type Description Note
id Long Collector id id and sn must send one
sn String Collector sn id and sn must send one
3.4.2. Output Parameter
Name Type Description Note
id Long Collector id
stationId Long Power Station Id
stationName String Plant name
addr String Plant address
userId Long Owner Id
state Power station status 1:Online 2:Offline 3:Alarm
Power station update
dataTimestamp time Timestamp
Cumulative working
totalWorkingTime time
sn String Collector SN
model String model GPRS,WiFi
name String Collector name
Collector signal
rssiLevel String strength
lac String Positioning lac

16
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 17 / 41 Eff Date: 2019年08月01日

lanIp LAN ip
mac Mac address
Maximum number
maximumNumber of connected units
Actual number of
actualNumber connected units
connectedSsid Connected ssid
connectionOperator Operator
Working time of this
currentWorkingTime power-on
Cumulative working
totalWorkingTime time
dataUploadCycle Data upload interval
factoryTime Factory time
gprsEndTime Package end time
3.5. /v1/api/inveterList Inverter List
3.5.1. Input parameters
Name Type Description Note
pageNo String Current page Specify the number of response
number pages to be returned. The value
defaults to 1
pageSize String Number per page Specify the number of records
returned in each response page.
The default value is 20, max 100
stationId Long Power station id Without: Check all under the
installer.
With: Check the indicated plant
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 power stations
Number of normal
normal Int power stations
Number of offline
offline Int stations

17
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 18 / 41 Eff Date: 2019年08月01日

Number of failed
fault Int power stations
id Long Inverter id
sn String Inverter SN
stationId Long Power station id
stationName String Plant name
userId Long Owner Id
power String Installed capacity
Installed capacity
powerStr String unit
etoday Energy of the day
Energy unit of the
etodayStr day
etotal Total energy
etotalStr Total energy unit
fullHour Peak Hours
picName image
pac power
pacStr Power unit
state Power station status 1:Online 2:Offline 3:Alarm
Power station update
dataTimestamp time Timestamp

3.6. /v1/api/inveterDetail Inverter Details


3.6.1. Input parameters
Name Type Description Note
id Long Inverter id d and sn must send one
sn String Inverter sn id and sn must send one
3.6.2. Output Parameters
Name Type Description Note
id Long Inverter id
sn String Inverter SN
stationId Long Power station id
stationName String Plant name
userId Long Owner Id
collectorId Long Collector id
collectorName String Collector name
collectorsn String Collector SN
currentState Current state

18
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 19 / 41 Eff Date: 2019年08月01日

eToday Energy of the day


Energy unit of the
eTodayStr day
eMonth Energy of the month
Energy unit of the
eMonthStr month
eYear Energy of the year
Energy unit of the
eYearStr year
eTotal Total energy
eTotalStr Total energy unit
fac Grid frequency
facStr Grid frequency unit
pac Real-time power
Real-time power
pacStr unit
pacPec Power percentage
fullHour Peak hours
picName image
power Installed capacity
Installed capacity
powerStr 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
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
state Power station status 1:Online 2:Offline 3:Alarm
Power station update
dataTimestamp time Timestamp

19
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 20 / 41 Eff Date: 2019年08月01日

inverterTemperature Inverter temperature


nationalStandardstr National standard
acOutputType AC output type 0: 1 phase Rest are 3 phase
dcInputtype Dc input type Num+1
powerFactor Power factor
batteryPower Battery power
batteryPowerStr Battery power unit
Battery
batteryPowerPec powerPercentage
batteryCapacitySoc Battery SOC
batteryHealthSoh Battery SOH
socDischargeSet Overdischarge SOC
socChargingSet Forcecharge SOC
Current operating
batteryType battery model
batteryVoltage Battery voltage
batteryVoltageStr Battery voltage unit
bstteryCurrent Battery current
bstteryCurrentStr Battery current unit
batteryPower Battery power
batteryPowerStr Battery power unit
Battery
batteryPowerPec powerPercentage
batteryFailureInform Battery alarm01
ation01
batteryFailureInform Battery alarm02
ation02
Today battery charge
batteryTodayCharge energy
Energy
batteryTodayCharge Today battery charge
EnergyStr energy unit
This month battery
batteryMonthCharge charge energy
Energy
batteryMonthCharge This month battery
EnergyStr charge energy unit
batteryYearChargeE This year battery
nergy charge energy

20
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 21 / 41 Eff Date: 2019年08月01日

batteryYearChargeE This year battery


nergyStr charge energy unit
Total battery charge
batteryTotalChargeE energy
nergy
batteryTotalChargeE Total battery charge
nergyStr energy unit
Today battery
batteryTodayDischar discharge energy
geEnergy
Today battery
batteryTodayDischar discharge energy
geEnergyStr unit
This month battery
batteryMonthDischa discharge energy
rgeEnergy
batteryMonthDi This month battery
schargeEnergyS discharge energy
tr unit
This year battery
batteryYearDischarg discharge energy
eEnergy
This year battery
batteryYearDischarg discharge energy
eEnergyStr unit
Total battery
batteryTotalDischarg discharge energy
eEnergy
Total battery
batteryTotalDischarg discharge energy
eEnergyStr unit

gridPurchasedToday Today meter


Energy purchase energy
gridPurchasedT Today meter
odayEnergyStr purchase energy unit
gridPurchasedM This month meter
onthEnergy purchase energy
gridPurchasedM This month meter

21
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 22 / 41 Eff Date: 2019年08月01日

onthEnergyStr purchase energy unit


gridPurchasedYearE This year meter
nergy purchase energy
gridPurchasedY This year meter
earEnergyStr purchase energy unit
gridPurchasedT Total meter purchase
otalEnergy energy
gridPurchasedT Total meter purchase
otalEnergyStr energy unit
gridSellTodayE Today meter sell
nergy energy
gridSellTodayE Today meter sell
nergyStr energy unit
gridSellMonthE This month meter
nergy sell energy
gridSellMonthE This month meter
nergyStr sell energy unit
gridSellYearEn This year meter sell
ergy energy
gridSellYearEn This year meter sell
ergyStr energy unit
gridSellTotalE Total meter sell
nergy energy
gridSellTotalE Total meter sell
nergyStr energy unit

familyLoadPowe HouseLoad power


r
familyLoadPowe HouseLoad power
rStr unit
bypassLoadPowe BackupLoad power
r
bypassLoadPowe BackupLoad power
rStr unit
Grid total active
pSum power
Grid total active
pSumStr power unit
psumPec Grid total active
powerPercentage

22
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 23 / 41 Eff Date: 2019年08月01日

homeLoadTodayE Today load energy


nergy
homeLoadTodayE Today load energy
nergyStr unit
homeLoadTotalE
nergy Total load energy
homeLoadTotalE Total load energy
nergyStr unit

3.7. /v1/api/addUser New User (Create if not exists; if exists, return userId)
3.7.1. Input parameters
Name Type Description Note
userName String username
password String password
email String mailbox Can be empty
mobile String phone number Can be empty
userType Integer user level Ordinary users pass 0

3.7.2. Output Parameters


Name Type Description Note
userId Long User ID

3.8. /v1/api/ addStation New Plant


3.8.1. Input parameters
Name Type Description Note
inverterSn String Inverter SN Fill in the new power station to bind
stationName String Plant name Required
addr String Plant address Required
Owner Id User (don’t fill in the default
userId Long operation installer)
phone number User phone number (don’t fill in the
mobile String default operation installer)
capacity String Installed capacity Required (unit kWp)
picName image
latitude String latitude
longitude String longitude
dip inclination
azimuth Azimuth
money Currency

23
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 24 / 41 Eff Date: 2019年08月01日

country Integer country Fixed 1


area You don’t need to fill in this if you
region Integer have a Gaode address code
city You don’t need to fill in this if you
city Integer have a Gaode address code
Revenue per Required
price kilowatt hour
gdAreaCode Integer Gaode address code Gaode API to obtain
offset Time zone offset
module Long Module Number
mobile Long Plant Contact
installerEmail String Installer Email
installerMobile Long Installer Mobile

3.8.2. Output Parameters


Name Type Description Note
stationId Long Plant ID

3.9. /v1/api/stationDay Plant Daily Graph


3.9.1. Input parameters
Name Type Description Note
id Long Power station id
money String Power plant
currency unit
time String time time: "2019-07-26"
timeZone Integer Power plant time
zone
3.9.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.10. /v1/api/stationMonth Plant Monthly Graph


3.10.1. Input parameters
Name Type Description Note
id Long Power station id

24
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 25 / 41 Eff Date: 2019年08月01日

money String Power plant currency


unit
month String time month: "2019-07"
3.10.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
batteryDischarge Battery discharge
Energy energy
batteryChargeEn Battery charge energy
ergy
gridPurchasedEn Meter purchase
ergy energy
gridSellEnergy Meter sell energy

3.11. /v1/api/stationYear Plant Yearly Graph


3.11.1. Input parameters
Name Type Description Note
id Long Power station id
money String Power plant currency
unit
year String time year: "2019"

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
batteryDischarge Battery
Energy discharge

25
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 26 / 41 Eff Date: 2019年08月01日

energy
batteryChargeEn Battery
ergy charge
energy
gridPurchasedEn Meter
ergy purchase
energy
gridSellEnergy Meter sell
energy
3.12. /v1/api/stationAll Plant cumulative graph
3.12.1. Input parameters
Name Type Description Note
id Long Power station id
money String Power plant
currency unit

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
batteryDischarge Battery discharge
Energy energy
batteryChargeEn Battery charge
ergy energy
gridPurchasedEn Meter purchase
ergy energy
gridSellEnergy Meter sell energy

3.13. /v1/api/addDevice Add device


3.13.1. Input parameters
Name Type Description Note
id Long Power station id
sn String Inverter sn Multiple inverters separated by comma

3.14. /v1/api/inverterDay Inverter Daily Graph


3.14.1. Input parameters

26
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 27 / 41 Eff Date: 2019年08月01日

Name Type Description Note


id Long Inverter id Id or sn
sn String Inverter sn Id or sn
money String Power plant
currency unit
time String time time: "2019-07-26"
timeZone Integer Power plant time
zone

3.14.2. Output Parameters


Name Type Description Note
dataTimestamp Long Timestamp
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
3.15. /v1/api/inverterMonth Inverter Monthly Graph
3.15.1. Input parameters

27
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 28 / 41 Eff Date: 2019年08月01日

Name Type Description Note


id Long Inverter id Id or SN
sn String Inverter sn Id or SN
money String Power plant
currency unit
month String time time: "2019-07"
3.15.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
batteryDischarge Battery discharge
Energy energy
batteryChargeEn Battery charge energy
ergy
gridPurchasedEn Meter purchase
ergy energy
gridSellEnergy Meter sell energy
3.16. /v1/api/inverterYear Inverter yearly graph
3.16.1. Input parameters
Name Type Description Note
id Long Inverter id Id or SN
sn String Inverter sn Id or SN
money String Power plant
currency unit
year String time time: "2019"
3.16.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
batteryDischarge Battery

28
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 29 / 41 Eff Date: 2019年08月01日

Energy discharge
energy
batteryChargeEn Battery
ergy charge
energy
gridPurchasedEn Meter
ergy purchase
energy
gridSellEnergy Meter sell
energy
3.17. /v1/api/inverterAll Inverter Cumulative Graph
3.17.1. Input parameters
Name Type Description Note
id Long Inverter id Id or SN
sn String Inverter sn Id or SN
money String Power plant
currency unit
3.17.2. Output Parameters
Name Type Description Note
energy Long Power generation
energyStr String Power generation
unit
money Long income
moneyStr String Income unit
batteryDischarge Battery discharge
Energy energy
batteryChargeEn Battery charge
ergy energy
gridPurchasedEn Meter purchase
ergy energy
gridSellEnergy Meter sell energy

3.18. /v1/api/stationUpdate Plant modification


3.18.1. Input parameters
Name Type Description Note
stationName String Plant name Required
addr String Plant address Required
phone number User phone number (don’t fill in the
mobile String default operation installer)

29
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 30 / 41 Eff Date: 2019年08月01日

capacity String Installed capacity Required (unit kWp)


latitude String latitude
longitude String longitude
dip inclination
azimuth Azimuth
money String Currency
country Integer country Fixed 1
area You don’t need to fill in this if you
region Integer have a Gaode address code
city You don’t need to fill in this if you
city Integer have a Gaode address code
Revenue per Required
price kilowatt hour
gdAreaCode Integer Gaode address code Gaode API to obtain
module Long Module Number
mobile Long Plant Contact
installerEmail String Installer Email
installerMobile Long Installer Mobile
3.19. /v1/api/updateInstaller Plant sub-account Modification
3.19.1. Input parameters
Name Type Description Note
id Long Power station id Required
installerId String Sub account id Multiple separated by commas
installer String Sub account name Multiple separated by commas
3.20. /v1/api/userList User List
3.20.1. Input parameters
Name Type Description Note
pageNo Integer Current page Specify the number of response
number pages to be returned. The value
defaults to 1
pageSize Integer Number per page Specify the number of records
returned in each response page.
The default value is 20
userType Integer user level Query ordinary account send 1
Query sub-account send 4
3.20.2. Output Parameters
Name Type Description Note
id Integer User id
userName Integer user name

30
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 31 / 41 Eff Date: 2019年08月01日

userType Integer user level


password Integer password
Number of power
stationNum Integer stations
mobile String User phone number Can be used to log in
mobile1 String User phone number Cannot be used to log in
email String mailbox
Total installed
capacity String capacity

3.21. /v1/api/addStationBindCollector New plant to bind collector


3.21.1. Input parameters – Method One (New Plant)
Name Type Description Note
For new plant, write to bind (multiple
sn String Datalogger SN SN use comma to separate)
stationName String Plant name Must fill in
addr String Plant address Must fill in
userId Long User ID User (Empty indicates installer)
capacity String Installed capacity Must fill in( unitkWp)
picName Picture
latitude String Latitude
longitude String Longitude
dip Tilte angle
azimuth Azimuth angle
money Currency
country Integer Country Fixed 1
You don’t need to fill in this if you
region Integer Region have a Gaode address code
You don’t need to fill in this if you
city Integer City have a Gaode address code
price Earning per kwh Must fill in
gdAreaCode Integer Gaode address code Gaode API to obtain
offset Time zone offset
0 residential, 1 commercial , 2 utility,
type Integer Plant type 3, poverty relief
0 owener full investment, 1 owener
loan , 2 self-investment, 3, joint
contribution Integer Investment type investment with owner
synchronizationType Integer Grid connection 0 full on grid, 1 self consumption , 2

31
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 32 / 41 Eff Date: 2019年08月01日

type off grid


installTime String Installation time yyyy-MM-dd HH:mm:ss
module Long Module Number
mobile Long Plant Contact
installerEmail String Installer Email
installerMobile Long Installer Mobile

3.21.1. Method 2:Input parameters (Plant exists)


Name Type Description Note
stationId Long Plant ID Must fill in
sn String Datalogger SN Multiple separated by commas

3.22. /v1/api/delCollector Plant unbind Datalogger


3.22.1. Input parameters
Name Type Description Note
sn String Datalogger SN
deleteInvert Integer If delete inverter? 1.delete all inverters, 0. not delete
inverter, default 0

3.23. /v1/api/alarmList Alarm info check


3.23.1. Input parameters
Name Type Description Note
pageNo String Current page Specify the number of response
number pages to be returned. The value
defaults to 1
pageSize String Number per page Specify the number of records
returned in each response page. The
default value is 20, max 100
stationId Long Plant ID Without: Check all under the
installer.
With: Check the indicated plant
alarmDeviceSn String InverterSN Without: Check all under the
installer.
With: Check the indicated plant
alarmBeginTime String Alarm startTime yyyy-MM-dd, Without: check all
alarmEndTime String Alarm stopTime yyyy-MM-dd, Without: check all
3.23.2. Output parameters
Name Type Description Note
stationId Long Plant ID

32
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 33 / 41 Eff Date: 2019年08月01日

stationName String Plant name


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.24. /v1/api/stationDetailList Batch acquire plant details


3.24.1. Input parameters
Name Type Description Note
pageNo Integer Current page Specify the number of response
number pages to be returned. The value
defaults to 1
pageSize Integer Number per page Specify the number of records
returned in each response page.
The default value is 20, max 100
3.24.2. Output parameters

Name Type Description Note


id Long Plant ID
stationName String Plant name
addr String Plant address
userId Long User ID
userName String Owner name
userMobile Long Owner mobile
userEmail String Owner email
capacity String Installed capacity
capacityStr String Installed capacity unit
dayEnergy Today energy
dayEnergyStr Today energy unit
monthEnergy This month energy
monthEnergyStr This month energy unit
yearEnergy This year energy
yearEnergyStr This year energy unit
allEnergy Total energy

33
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 34 / 41 Eff Date: 2019年08月01日

allEnergyStr Total energy unit


dayInCome Today income
dayInComeUnit Today income unit
monthInCome This month income
monthInComeUnit This month income unit
yearInCome This year income
yearInComeUnit This year income unit
allInCome Total income
allInComeUnit Total income unit
fullHour Peak hours
picName Picture
power Poower
powerStr Poower unit
latitude String Latitude
longitude String Longitude
dip Tilte angle
azimuth Azimuth angle
price Earning per kwh
1:Online 2:Offline 3:
state Plant status Alarm
dataTimestamp Plant update time Time Stamp
money Currency
brand Brand
countryStr Country
regionStr Region
cityStr City
condTxtN Night weather
condTxtD Day time weather
tmpMax Highest Temperature
tmpMin Lowest Temperature
tmpUnit Temperature unit
powerStationNumTree Plant tree
powerStationNumTreeUnit Plant tree unit
powerStationAvoidedCo2 CO2 reduction
powerStationAvoidedCo2Unit CO2 reduction unit
module Long Module Number
mobile Long Plant Contact
installerEmail String Installer Email
installerMobile Long Installer Mobile

34
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 35 / 41 Eff Date: 2019年08月01日

batteryPower Battery Power


batteryPowerStr Battery Power unit
Battery
batteryPowerPec PowerPercentage
batteryDischargeEnergy Battery discharg energy
Battery discharg energy
batteryDischargeEnergyStr unit
batteryChargeEnergy Battery charge energy
Battery charge energy
batteryChargeEnergyStr unit
batteryPercent Battery SOC
psum Meter power
psumStr Meter power unit
psumPec Meter powerPercentage
Meter today purchase
gridPurchasedDayEnergy energy
Meter today purchase
gridPurchasedDayEnergyStr energy unit
Meter this month
gridPurchasedMonthEnergy purchase energy
Meter this month
gridPurchasedMonthEnergyStr purchase energy unit
Meter this year
gridPurchasedYearEnergy purchase energy
Meter this year
gridPurchasedYearEnergyStr purchase energy unit
Meter total purchase
gridPurchasedTotalEnergy 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
Meter this year sell
gridSellYearEnergy energy

35
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 36 / 41 Eff Date: 2019年08月01日

Meter this year sell


gridSellYearEnergyStr energy unit
gridSellTotalEnergy Meter total sell energy
Meter total sell energy
gridSellTotalEnergyStr unit
familyLoadPower Load power
familyLoadPowerStr Load power unit
familyLoadPowerPec Load powerPercentage
homeLoadEnergy Today load energy
homeLoadEnergyStr Today load energy unit

3.25. /v1/api/inverterDetailList Batch acquire Inverter details


3.25.1. Input parameters
Name Type Description Note
pageNo Integer Current page Specify the number of response
number pages to be returned. The value
defaults to 1
pageSize Integer Number per page Specify the number of records
returned in each response page.
The default value is 20, max 100
3.25.2. Output parameters
Name Type Description Note
id Long Inverterid
sn String InverterSN
stationId Long Plant ID
stationName String Plant name
userId Long User ID
collectorId Long Dataloggerid
collectorName String DataloggerName
collectorsn String Datalogger SN
currentState Current status
eToday Today energy
eTodayStr Today energy unit
eMonth This month energy
This month energy
eMonthStr unit
eYear This year energy
This year energy
eYearStr unit

36
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 37 / 41 Eff Date: 2019年08月01日

eTotal Total energy


eTotalStr Total energy unit
fac Grid frequency
facStr Grid frequency unit
pac Real timePoower
Real timePoower
pacStr unit
pacPec PoowerPercentage
fullHour Peak hours
picName Picture
power Installed capacity
Installed capacity
powerStr unit
iAc1 AC CurrentR
iAc2 AC CurrentS
iAc3 AC CurrentT
uAc1 AC VoltageR
uAc2 AC VoltageS
uAc3 AC VoltageT
iPv1 DC Current1
iPv2 DC Current2
iPv3 DC Current3
iPv4 DC Current4
uPv1 DC Voltage1
uPv2 DC Voltage2
uPv3 DC Voltage3
uPv4 DC Voltage4
state Plant status 1:Online 2:Offline 3:Alarm
dataTimestamp Plant update time Time Stamp
inverterTemperature InverterTemperature
nationalStandardstr CountryStandard
acOutputType AC output type 0: 1ph rest:3ph
dcInputtype DC input type num+1
powerFactor Power factor
batteryPower Battery power
batteryPowerStr Battery power unit
Battery
batteryPowerPec powerPercentage
batteryCapacitySoc Battery SOC

37
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 38 / 41 Eff Date: 2019年08月01日

batteryHealthSoh Battery SOH


socDischargeSet Overdischarge SOC
socChargingSet Forcecharge SOC
Current operating
batteryType battery model
batteryVoltage Battery voltage
batteryVoltageStr Battery voltage unit
bstteryCurrent Battery current
bstteryCurrentStr Battery current unit
batteryPower Battery power
batteryPowerStr Battery power unit
Battery
batteryPowerPec powerPercentage
batteryFailureInform Battery alarm01
ation01
batteryFailureInform Battery alarm02
ation02
Today battery charge
batteryTodayCharge energy
Energy
batteryTodayCharge Today battery charge
EnergyStr energy unit
This month battery
batteryMonthCharge charge energy
Energy
batteryMonthCharge This month battery
EnergyStr charge energy unit
This year battery
batteryYearChargeE charge energy
nergy
batteryYearChargeE This year battery
nergyStr charge energy unit
Total battery charge
batteryTotalChargeE energy
nergy
batteryTotalChargeE Total battery charge
nergyStr energy unit
batteryTodayDischar Today battery
geEnergy discharge energy

38
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 39 / 41 Eff Date: 2019年08月01日

Today battery
batteryTodayDischar discharge energy
geEnergyStr unit
This month battery
batteryMonthDischa discharge energy
rgeEnergy
This month battery
batteryMonthDischa discharge energy
rgeEnergyStr unit
This year battery
batteryYearDischarg discharge energy
eEnergy
This year battery
batteryYearDischarg discharge energy
eEnergyStr unit
Total battery
batteryTotalDischarg discharge energy
eEnergy
Total battery
batteryTotalDischarg discharge energy
eEnergyStr unit

gridPurchasedToday Today meter


Energy purchase energy
gridPurchasedToday Today meter
EnergyStr purchase energy unit
gridPurchasedMonth This month meter
Energy purchase energy
gridPurchasedMonth This month meter
EnergyStr purchase energy unit
gridPurchasedYearE This year meter
nergy purchase energy
gridPurchasedYearE This year meter
nergyStr purchase energy unit
gridPurchasedTotalE Total meter purchase
nergy energy
gridPurchasedTotalE Total meter purchase
nergyStr energy unit
gridSellTodayEnerg Today meter sell

39
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 40 / 41 Eff Date: 2019年08月01日

y energy
gridSellTodayEnerg Today meter sell
yStr energy unit
gridSellMonthEnerg This month meter
y sell energy
gridSellMonthEnerg This month meter
yStr sell energy unit
This year meter sell
gridSellYearEnergy energy
gridSellYearEnergyS This year meter sell
tr energy unit
Total meter sell
gridSellTotalEnergy energy
gridSellTotalEnergy Total meter sell
Str energy unit

HouseLoad power
familyLoadPower
HouseLoad power
familyLoadPowerStr unit
BackupLoad power
bypassLoadPower
bypassLoadPowerSt BackupLoad power
r unit
Grid total active
pSum power
Grid total active
pSumStr power unit
psumPec Grid total active
powerPercentage
homeLoadTodayEne Today load energy
rgy
homeLoadTodayEne Today load energy
rgyStr unit
homeLoadTotalEner
gy Total load energy
homeLoadTotalEner Total load energy
gyStr unit
3.26. /v1/api/stationDayEnergyList Batch acquire plant day Generation
3.26.1. Input parameters

40
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 41 / 41 Eff Date: 2019年08月01日

Name Type Description Note


pageNo Integer Current page Specify the number of response
number pages to be returned. The value
defaults to 1
pageSize Integer Number per page Specify the number of records
returned in each response page. The
default value is 20, max 100
time String Time time: "2019-07-26"
3.26.2. Input 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
batteryDischarge Battery discharge
Energy energy
batteryChargeEn Battery charge energy
ergy
gridPurchasedEn Meter purchase
ergy energy
gridSellEnergy Meter sell energy

3.27. /v1/api/stationMonthEnergyList Batch acquire plant month Generation


3.27.1. Input parameters
Name Type Description Note
pageNo Integer Current page Specify the number of response
number pages to be returned. The value
defaults to 1
pageSize Integer Number per page Specify the number of records
returned in each response page. The
default value is 20, max 100
time String Time time: "2019-07"
3.27.2. Input parameters
Name Type Description Note
id Long Plant ID
energy Generation
energyStr String Generation unit

41
宁波锦浪新能源科技股份有限公司
File: Soliscloud API Classification: Secret
File No: XX-XXX-XXX Ver:V1.0 Page: 42 / 41 Eff Date: 2019年08月01日

date Long Time Stamp 1564088700000


money Income
moneyStr String Income unit
batteryDischarge Battery discharge
Energy energy
batteryChargeEn Battery charge energy
ergy
gridPurchasedEn Meter purchase
ergy energy
gridSellEnergy Meter sell energy

3.28. /v1/api/stationYearEnergyList B Batch acquire plant year Generation


3.28.1. Input parameters
Name Type Description Note
pageNo Integer Current page Specify the number of response
number pages to be returned. The value
defaults to 1
pageSize Integer Number per page Specify the number of records
returned in each response page. The
default value is 20, max 100
time String Time time: "2019"
3.28.2. Input 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
batteryDischarge Battery discharge
Energy energy
batteryChargeEn Battery charge energy
ergy
gridPurchasedEn Meter purchase
ergy energy
gridSellEnergy Meter sell energy

42

You might also like