Ginlong (Solis) Technologies

SolisCloud Platform API Document

V2.0

All rights reserved. No reproduction allowed

-1-
 SolisCloud Platform API Document V2.0

Content
1 GLOBAL DESCRIPTION ................................................................................................................. - 4 -

2 INTERFACE INFORMATION ......................................................................................................... - 4 -

2.1 INTERFACE ADDRESS AND KEY ......................................................................................................- 4 -

2.2 REQUEST STANDARD FORMAT ........................................................................................................- 4 -
2.3 STANDARD FORMAT FOR RETURNS ................................................................................................. - 5 -
2.4 INTERFACE CALL EXAMPLES ..........................................................................................................- 6 -
2.5 ENCRYPTION TOOL REFERENCE ..................................................................................................... - 6 -

3 DEVICE INTERFACES .....................................................................................................................- 7 -

3.1 OBTAIN THE INVERTER LIST UNDER THE ACCOUNT ........................................................................ - 7 -

3.2 OBTAINING DETAILS OF A SINGLE INVERTER ............................................................................... - 12 -
3.3 OBTAINING DETAILS OF MULTIPLE INVERTERS ............................................................................ - 22 -
3.4 OBTAIN REAL-TIME DATA OF A SINGLE INVERTER ON A CERTAIN DAY .......................................... - 34 -
3.5 OBTAINING DAILY DATA OF A SINGLE INVERTER FOR A MONTH ................................................. - 36 -
3.6 OBTAIN MONTHLY DATA OF A SINGLE INVERTER FOR A CERTAIN YEAR ........................................ - 39 -
3.7 OBTAINING ANNUAL DATA OF A SINGLE INVERTER ..................................................................... - 41 -
3.8 OBTAINING QUALITY ASSURANCE DATA FOR MULTIPLE INVERTERS ...........................................- 43 -
3.9 OBTAIN THE DEVICE ALARM LIST UNDER THE ACCOUNT ............................................................. - 45 -
3.10 OBTAIN THE COLLECTOR LIST UNDER THE ACCOUNT .................................................................- 47 -
3.11 OBTAINING DETAILS OF A SINGLE COLLECTOR ..........................................................................- 51 -
3.12 OBTAINING SINGLE COLLECTOR SIGNAL VALUES ......................................................................- 53 -
3.13 OBTAIN EPM LIST UNDER ACCOUNT ..........................................................................................- 54 -
3.14 OBTAINING DETAILS OF A SINGLE EPM .....................................................................................- 57 -
3.15 OBTAIN REAL-TIME DATA OF A SINGLE EPM ON A CERTAIN DAY ............................................... - 61 -
3.16 OBTAINING DAILY DATA OF A SINGLE EPM FOR A MONTH ....................................................... - 63 -
3.17 OBTAINING MONTHLY DATA OF A SINGLE EPM FOR A CERTAIN YEAR ..................................... - 65 -
3.18 OBTAINING ANNUAL DATA FOR A SINGLE EPM .........................................................................- 66 -
3.19 OBTAIN A LIST OF METEOROLOGICAL INSTRUMENTS UNDER THE ACCOUNT ..............................- 68 -
3.20 OBTAINING DETAILS OF A SINGLE METEOROLOGICAL INSTRUMENT .........................................- 71 -

4 PLANT INTERFACE ....................................................................................................................... - 73 -

4.1 OBTAIN THE LIST OF POWER STATIONS UNDER THE ACCOUNT ......................................................- 73 -
4.2 OBTAINING DETAILS OF INDIVIDUAL POWER STATIONS ...............................................................- 77 -
4.3 OBTAINING DETAILS OF MULTIPLE POWER STATIONS ..................................................................- 86 -
4.4 OBTAINING REAL-TIME DATA OF MULTIPLE POWER STATIONS ON A CERTAIN DAY ........................ - 95 -
4.5 OBTAINING DAILY DATA OF MULTIPLE POWER STATIONS FOR A MONTH .................................... - 97 -
4.6 OBTAINING ANNUAL DATA FROM MULTIPLE POWER STATIONS ................................................... - 99 -
4.7 OBTAIN REAL-TIME DATA OF A SINGLE POWER STATION ON A CERTAIN DAY .............................. - 102 -
4.8 OBTAIN DAILY DATA OF A SINGLE POWER STATION FOR A CERTAIN MONTH ................................- 104 -
4.9 OBTAINING MONTHLY DATA OF A SINGLE POWER PLANT FOR A CERTAIN YEAR ...................... - 107 -
4.10 OBTAINING ANNUAL DATA OF A POWER PLANT .......................................................................- 110 -
4.11 NEWLY ADDED POWER STATION INFORMATION ......................................................................... - 112 -

-2-
 SolisCloud Platform API Document V2.0

4.12 MODIFYING POWER STATION INFORMATION ............................................................................ - 114 -

4.13 BINDING A NEW COLLECTOR TO THE POWER STATION .............................................................. - 116 -
4.14 POWER STATION UNBINDING COLLECTOR ................................................................................. - 118 -
4.15 POWER PLANT BINDING INVERTER ............................................................................................- 119 -

APPENDIX 1. ERROR CODES .......................................................................................................- 121 -

APPENDIX 2. TYPE OF POWER PLANT .................................................................................... - 121 -

APPENDIX 3. TYPES OF INVERTER METERS .........................................................................- 122 -

-3-
 SolisCloud Platform API Document V2.0

1 GLOBAL DESCRIPTION
1) All interface encryption is based on the HTTPS protocol.
2) The update frequency for all interface data is 5 minutes.
3) All interface request methods are POST.
4) All interface request types are application/JSON;Charset=UTF-8.
5) All interface requests require adding Content MD5, Content Type, Date, and Authorization to the
header.
6) All interface returned data is in JSON format.
7) All interface returned data (power, energy, energy, frequency, etc.) must be used in conjunction with the
unit.

2 INTERFACE INFORMATION
2.1 Interface Address and Key
Type Content
API URL https://www.soliscloud.com:13333/
API ID Log in to www.soliscloud.com and go to "Account" - "Basic Settings" - "API
API Secret Management" to obtain. Pay attention to confidentiality and prevent Data
breach.

2.2 Request Standard Format

POST [API URL]
Content-MD5: [Content-MD5]
Content-Type: application/json;charset=UTF-8
Date: [Date]
Authorization: API {apiId}: [sign]
Body: [Body]
Name Description Example
https://www.soliscloud.com:13333/v1/api/inverter
API URL Specific address of each interface.
Detail
public static String getDigest(String test) {
String result = "";
try {
MessageDigest md =
1. Perform MD5 encryption on MessageDigest.getInstance("MD5");
the body; md.update(test.getBytes());
2. Convert encrypted content into byte[] b = md.digest();
Content-MD5
a 128 bit binary array; result = Base64.encodeBytes(b);
3. Base64 encoding of binary } catch (NoSuchAlgorithmException
arrays. e) {
e.prIntegerStackTrace();
}
return result;
}

-4-
 SolisCloud Platform API Document V2.0

Content-Type Fixed value application/json;charset=UTF-8

public static String getGMTTime(){

1. Obtain the current time in the
Calendar cd =
GMT time zone;
Calendar.getInstance();
2. Convert the current time to a
SimpleDateFormat sdf = new
string in the following format.
SimpleDateFormat("EEE, d MMM yyyy
Format: EEE, d MMM yyyy HH:
HH:mm:ss 'GMT'", Locale.US);
Date mm: ss' GMT '
sdf.setTimeZone(TimeZone.getTimeZone("GMT"
Note: The Date time cannot
));
exceed the current time by more
String str =
than plus or minus 15 minutes,
sdf.format(cd.getTime());
otherwise a call failure may
return str;
occur.
}
The legitimacy authentication Authorization : "API " + apiId + ":" + Sign
information of the interface Sign = base64(HmacSHA1(apiSecret,POST+
request, in the format shown in "\n"
the example, is explained as + Content-MD5 + "\n"
follows: + Content-Type + "\n"
apiId represents the visitor's + Date + "\n"
identity ID. + CanonicalizedResource))
ApiSecret represents the key
required for signing.
Authorization
CanonicalizedResource represents
the API interface path that you
want to access, such as
"/v1/api/inverterDetail"
Sign represents a digital
signature, which is obtained by
encrypting the HmacSHA1 key
with base64 encoding.
\n represents a line break.
{
Please refer to the request
"id": "1308675217944611083",
Body parameters for each business
"sn": "120B40198150131"
interface for details.
}
2.3 Standard format for returns
Content-Type: application/json;charset=UTF-8
Date: [Date]
Body: [Body]
Name Description Example
Content-Type Fixed value application/json;charset=UTF-8
Date GMT time in string format Fri, 26 Jul 2019 06:00:46 GMT
Body The body content includes: {success, {
code, msg, data} "success": true,

-5-
 SolisCloud Platform API Document V2.0

"Success": true represents success, while "code": "0",

false represents failure. "msg": "success",
Code: 0 represents success, while others "data": { }
represent failure. Please refer to }
Appendix 1 for the failure code.
"Msg": Description of the code value.
Data ": Please refer to the return
parameters of each business interface for
details.

2.4 Interface Call Examples

Request parameters:
POST /v1/api/userStationList
Content-MD5: kxdxk7rbAsrzSIWgEwhH4w==
Content-Type: application/json
Date: Fri, 26 Jul 2019 06:00:46 GMT
Authorization: API {apiId}:nBYQWeuzy3Y+gp67BN8zXTmvSDk=
Body：{"pageNo":1,"pageSize":10}
Return parameters:
{
"success": true,
"code": "0",
"msg": "success",
"data": { }
}
JAVA example (please download directly):
https://ginlong-product.oss-cn-shanghai.aliyuncs.com/templet/Authorization.java

2.5 Encryption Tool Reference

Reference website https://dinochiesa.github.io/hmachash/index.html
Content MD5 calculation example {"pageNo":1,"pageSize":10}

-6-
 SolisCloud Platform API Document V2.0

3 DEVICE INTERFACES

3.1 Obtain the inverter list under the account

Interface Name Obtain the inverter list under the account

Corresponding to the SolisCloud platform device overview - inverter list, a
Interface Description
single call can obtain the list data of up to 100 devices.
Request URL https://www.soliscloud.com:13333/v1/api/inverterList
Interface frequency
2 times/sec
limit
Request parameters [Body]
Parameter Name Data Type Required Description
Specify the number of page numbers to return. The
pageNo String Y
default value is 1, representing page 1.
Specify the number of returns per page. The default
pageSize String Y
value is 20, and the maximum value is 100.
1. Specify stationId to represent the information
under this power station, which can be obtained
stationId Integer N from the list of power stations.
2. If this value is blank, it represents querying all
information under the account.
1. Specify nmiCode to represent the information
under this nmi, which can be obtained from the list
nmiCode String N of power plants.
2. If this value is blank, it represents querying all
information under the account.
Return parameters [Body]
Parameter Name Data Type Required Description
0 represents success, while others represent failure.
code String Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
page Object Y Result list
inverterStatusVo Object Y Number of results
total Integer N Total number of lists
records Array N Array of record
all Integer N Total number of inverters
normal Integer N Number of normal inverters
offline Integer N Number of offline inverters
fault Integer N Number of faulty inverters
id Integer N Inverter ID

-7-
 SolisCloud Platform API Document V2.0

sn String N Inverter SN
stationId Integer N Station ID
stationName String N Name of station
userId Integer N Owner ID
power String N Installed capacity
powerStr String N Unit of installed capacity
etoday Number N Daily power generation
etoday1 Number N Original value of daily electricity generation
etodayStr Number N Unit of daily power generation
etotal Number N Total power generation
etotal1 Number N Original value of total power generation
etotalStr Number N Unit of total power generation
Full power hours, power generation divided by
fullHour Number N
rated power
pac Number N Power
pacStr Number N Unit of power
state Integer N Inverter status: 1=online, 2=offline, 3=alarm
Data update time under UTC+8. The format is a
dataTimestamp Integer N
timestamp.
collectorSn String N Collector SN
productModel String N Inverter type: 1=grid, 2=storage
Number of DC input channels: value+1=actual
number of channels.
dcInputType Integer N
For example, 0=1 channel, 1=2 channels, 2=3
channels, and so on
AC output class: 0=single-phase,
acOutputType Integer N
others=three-phase
series String N Inverter series
name String N Inverter name
addr String N Station address
collectorState Integer N Collector status: 1=online, 2=offline
Inverter offline status: 0=normal offline,
stateExceptionFlag Integer N
1=abnormal offline
Total full power hours, total power generation
totalFullHour Number N
divided by rated power
inverterMeterModel Integer N Type of inverter meter, see Appendix 3 for details
createDate Integer N Date of data creation
updateShelfEndTime Integer N End time of warranty
Code example
POST /v1/api/inverterList
Request parameters
Connection: keep-alive

-8-
 SolisCloud Platform API Document V2.0

Date: Tue, 27 Jun 2023 06:23:30 GMT

Content-MD5: Trz24rS6Ot0X3mHzTjNPww==
Authorization:API
1300386381676644416:h8wghlL2V9593N8AjNMSNRZrnB8=
Content-Type: application/json;charset=UTF-8
Content-Length: 84
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"pageNo": 1,
"pageSize": 10,
"stationId": "1298491919448631809",
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"inverterStatusVo": {
"all": 8,
"normal": 0,
"fault": 0,
"offline": 8,
"mppt": 0
},
"page": {
"records": [
{
Return parameters
"id": "1308675217944611083",
"sn": "120B40198150131",
"model": "b4",
"collectorSn": "404314859",
"productModel": "b4",
"nationalStandards": "0",
"inverterSoftwareVersion": "000000",
"inverterSoftwareVersion2": "000000",
"dcInputType": 3,
"acOutputType": 1,
"stationId": "1298491919448631809",
"tag": "YingZhen",
"rs485ComAddr": "101",
"simFlowState": -5,
"power": 8.000,

-9-
 SolisCloud Platform API Document V2.0

"powerStr": "kW",
"pac": 5.025,
"pac1": 0,
"pacStr": "kW",
"state": 1,
"stateExceptionFlag": 0,
"ivSupport": 0,
"inverterConfig": "0",
"fullHour": 4.38,
"totalFullHour": 4549.63,
"maxDcBus": 0.0,
"maxDcBusTime": "0",
"maxUac": 259.4,
"maxUacTime": "1678591780000",
"maxUpv": 392.7,
"maxUpvTime": "1673747977000",
"timeZone": -9.00,
"timeZoneStr": "UTC-9:00",
"dataTimestamp": "1687846773000",
"dataTimestampStr": "2023-06-26 22:19:33
(UTC-9:00)",
"fisTime": "1624441308000",
"inverterMeterModel": 1,
"updateShelfTime": "null",
"collectorId": "1306858901386141423",
"dispersionRate": 0.0,
"currentState": "0",
"pow1": 1825.85,
"pow2": 1686.39,
"pow3": 1640.24,
......
"pow31": 0.0,
"pow32": 0.0,
"gridPurchasedTodayEnergy": 0.000,
"gridPurchasedTodayEnergyStr": "kWh",
"gridSellTodayEnergy": 0.000,
"gridSellTodayEnergyStr": "kWh",
"psumCalPec": "1",
"batteryPower": 0.000,
"batteryPowerStr": "kW",
"batteryPowerPec": "1",
"batteryCapacitySoc": 0.000,
"parallelStatus": 0,
"parallelAddr": 0,

- 10 -
 SolisCloud Platform API Document V2.0

"parallelPhase": 0,
"parallelBattery": 0,
"batteryTodayChargeEnergy": 0.000,
"batteryTodayChargeEnergyStr": "kWh",
"batteryTotalChargeEnergy": 0.000,
"batteryTotalChargeEnergyStr": "kWh",
"batteryTodayDischargeEnergy": 0.000,
"batteryTodayDischargeEnergyStr": "kWh",
"batteryTotalDischargeEnergy": 0.000,
"batteryTotalDischargeEnergyStr": "kWh",
"bypassLoadPower": 0.000,
"bypassLoadPowerStr": "kW",
"backupTodayEnergy": 0.000,
"backupTodayEnergyStr": "kWh",
"backupTotalEnergy": 0.000,
"backupTotalEnergyStr": "kWh",
"nmiCode": "41028459350",
"isS5": 0,
"batteryModel": 1,
"bypassAcOnoffSet": 0.0,
"parallelOnoff01": 0.000,
"parallelOnoff02": 0.000,
"etotal": 36.397,
"etoday": 27.800,
"psum": 0.000,
"psumCal": 5.025,
"etotal1": 36397.000,
"offlineLongStr": "--",
"etoday1": 27.800000,
"etotalStr": "MWh",
"etodayStr": "kWh",
"psumStr": "kW",
"psumCalStr": "kW"
}
],
"total": 1,
"size": 10,
"current": 1,
"orders": [
],
"optimizeCountSql": false,
"searchCount": true,
"pages": 1
},

- 11 -
 SolisCloud Platform API Document V2.0

"mpptSwitch": 1
}
}

3.2 Obtaining Details of a Single Inverter

Interface Name Obtaining Details of a Single Inverter

Obtain detailed data of the specified inverter, corresponding to
Interface Description
the inverter detailed data on the SolisCloud platform.
Request URL https://www.soliscloud.com:13333/v1/api/inverterDetail
Interface frequency limit 2 times/sec
Request parameters [Body]
Requ
Parameter Name Data Type Description
ired
id Integer Y Query the detailed data of the specified
inverter ID or inverter SN, both ID and
sn String Y
SN cannot be empty at the same time
Return parameters [Body]
Requ
Parameter Name Data Type Description
ired
0 represents success, while others
code String Y represent failure. The failure code is
detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
id Integer N Inverter ID
sn String N Inverter SN
stationId Integer N Station ID
stationName String N Name of station
userId Integer N Owner ID
collectorId Integer N Collector ID
collectorName String N Name of the Collector
collectorsn String N Collector SN
currentState String N Current state
eToday Number N Daily power generation
eTodayStr String N Unit of daily power generation
eMonth Number N Monthly power generation
eMonthStr String N Unit of monthly power generation
eYear Number N Yearly power generation
eYearStr String N Unit of yearly power generation
eTotal Number N Total power generation

- 12 -
 SolisCloud Platform API Document V2.0

eTotalStr String N Unit of total power generation

fac Number N Grid frequency
facStr String N Unit of grid frequency
pac Number N Real time power
pacStr String N Unit of real time power
pacPec Number N Power percentage
Full power hours, power generation
fullHour Number N
divided by rated power
picName String N Picture name
power Number N Installed capacity
powerStr String N Unit of installed capacity
iAc1 Number N AC side current-R
iAc2 Number N AC side current-S
iAc3 Number N AC side current-T
uAc1 Number N AC side voltage-R
uAc2 Number N AC side voltage-S
uAc3 Number N AC side voltage-T
iPv1 Number N DC side current-1
iPv2 Number N DC side current-2
iPv3 Number N DC side current-3
iPv4 Number N DC side current-4
... Number N
iPv32 Number N DC side current-32
uPv1 Number N DC side voltage-1
uPv2 Number N DC side voltage-2
uPv3 Number N DC side voltage-3
uPv4 Number N DC side voltage-4
....... N ......
uPv32 Number N DC side voltage-32
pow1 Number N DC side power-1
Pow2 Number N DC side power-2
....... N ......
Pow32 Number N DC side power-32
Inverter status: 1=online, 2=offline,
state Integer N
3=alarm
Data update time under UTC+8. The
dataTimestamp Integer N
format is a timestamp.
inverterTemperature Number N Inverter temperature
nationalStandardstr String N National Grid Standards
acOutputType Integer N AC output class: 0=single-phase,

- 13 -
 SolisCloud Platform API Document V2.0

others=three-phase
Number of DC input channels:
value+1=actual number of channels.
dcInputType Integer N
For example, 0=1 channel, 1=2
channels, 2=3 channels, and so on
powerFactor Number N Power factor
batteryPower Number N Battery power
batteryPowerStr String N Unit of battery power
batteryPowerPec Number N Battery power percentage
batteryCapacitySoc Number N Battery SOC
batteryHealthSoh Number N Battery SOH
socDischargeSet Number N Overdischarge of SOC
socChargingSet Number N Strong charging SOC
batteryType String N Current battery model
batteryVoltage Number N Battery voltage
batteryVoltageStr String N Unit of battery voltage
bstteryCurrent Number N Battery current
bstteryCurrentStr String N Unit of battery current
batteryPower Number N Battery power
batteryPowerStr String N Unit of battery power
batteryPowerPec Number N Battery power percentage
batteryFailureInformation01 String N Battery fault information-01
batteryFailureInformation02 String N Battery fault information-02
batteryTodayChargeEnergy Number N Daily battery charging energy
batteryTodayChargeEnergyStr String N Unit of daily battery charging energy
batteryMonthChargeEnergy Number N Monthly battery charging energy
batteryMonthChargeEnergyStr String N Unit of monthly battery charging energy
batteryYearChargeEnergy Number N Yearly battery charging energy
batteryYearChargeEnergyStr String N Unit of yearly battery charging energy
batteryTotalChargeEnergy Number N Total battery charging energy
batteryTotalChargeEnergyStr String N Unit of total battery charging energy
batteryTodayDischargeEnergy Number N Daily battery discharging energy
batteryTodayDischargeEnergyStr String N Unit of daily battery discharging energy
batteryMonthDischargeEnergy Number N Monthly battery discharging energy
Unit of monthly battery discharging
batteryMonthDischargeEnergyStr String N
energy
batteryYearDischargeEnergy Number N Yearly battery discharging energy
Unit of yearly battery discharging
batteryYearDischargeEnergyStr String N
energy
batteryTotalDischargeEnergy Number N Total battery discharging energy

- 14 -
 SolisCloud Platform API Document V2.0

batteryTotalDischarg
String N Unit of total battery discharging energy
eEnergyStr
gridPurchasedTodayEnergy Number N Daily grid purchased energy
gridPurchasedTodayEnergyStr String N Unit of daily grid purchased energy
gridPurchasedMonthEnergy Number N Monthly grid purchased energy
gridPurchasedMonthEnergyStr String N Unit of monthly grid purchased energy
gridPurchasedYearEnergy Number N Yearly grid purchased energy
gridPurchasedYearEnergyStr String N Unit of yearly grid purchased energy
gridPurchasedTotalEnergy Number N Total grid purchased energy
gridPurchasedTotalEnergyStr String N Unit of total grid purchased energy
gridSellTodayEnergy Number N Daily grid selling energy
gridSellTodayEnergyStr String N Unit of daily grid selling energy
gridSellMonthEnergy Number N Monthly grid selling energy
gridSellMonthEnergyStr String N Unit of monthly grid selling energy
gridSellYearEnergy Number N Yearly grid selling energy
gridSellYearEnergyStr String N Unit of yearly grid selling energy
gridSellTotalEnergy Number N Total grid selling energy
gridSellTotalEnergyStr String N Unit of total grid selling energy
familyLoadPower Number N Family load power
familyLoadPowerStr String N Unit of family load power
bypassLoadPower Number N Bypass load power
bypassLoadPowerStr String N Unit of bypass load power
pSum Number N Total active power of the grid
pSumStr String N Unit of total active power of the grid
Percentage of total active power of the
psumPec Number N
power grid
homeLoadTodayEnergy Number N Daily load consumption
homeLoadTodayEnergyStr String N Unit of daily load consumption
homeLoadTotalEnergy Number N Total load consumption
homeLoadTotalEnergyStr String N Unit of total load consumption
model String N Inverter model
type Integer N Inverter type: 1=grid, 2=storage
name String N Inverter name
Type of inverter meter, see Appendix 3
inverterMeterModel Integer N
for details
Inverter offline status: 0=normal offline,
stateExceptionFlag Integer N
1=abnormal offline
collectorState Integer N Collector status: 1=online, 2=offline
collectorModel String N Collector model
warningInfoData Integer N Alarm information

- 15 -
 SolisCloud Platform API Document V2.0

productModel String N Product model

nationalStandards String N National Grid Standards
version String N Inverter software version
reactivePower Number N Inverter reactive power
reactivePowerStr String N Unit inverter reactive power
apparentPower Number N Inverter apparent power
apparentPowerStr String N Unit of inverter apparent power
dcPac Number N Total DC input power of inverter
dcPacStr String N Unit of total DC input power of inverter
updateShelfEndTime Integer N End time of warranty
iA Number N Meter item A current
uA Number N Meter item A voltage
pA Number N Meter item A power
aLookedPower Number N Meter item A apparent power
aReactivePower Number N Meter item A reactive power
aphasePowerFactor Number N Meter item A active power
averagePowerFactor Number N Meter power factor
iB Number N Meter item B current
uB Number N Meter item B voltage
pB Number N Meter item B power
bLookedPower Number N Meter item B apparent power
bReactivePower Number N Meter item B reactive power
bphasePowerFactor Number N Meter item B active power
iC Number N Meter item C current
uC Number N Meter item C voltage
pC Number N Meter item C power
cLookedPower Number N Meter item C apparent power
cReactivePower Number N Meter item C reactive power
cphasePowerFactor Number N Meter item C active power
fAc Number N Grid frequency
pSum Number N Total power of the meter
Code example
POST /v1/api/inverterDetail
Connection: keep-alive
Date: Tue, 27 Jun 2023 06:27:04 GMT
Content-MD5: L8Cn6A73DbGlYSSwqZrhUA==
Request parameters
Authorization:API
1300386381676644416:aGrbjf3lEidLNAMjN63o3tw/Eeo=
Content-Type: application/json;charset=UTF-8
Content-Length: 32

- 16 -
 SolisCloud Platform API Document V2.0

Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"id": "1308675217944611083",
"sn": "120B40198150131"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"fullHour": 0.00,
"fullHourStr": "h",
"ctrlCommand": 0,
"reactivePower": 0,
"apparentPower": 0,
"dcPac": 0,
"uInitGnd": 0,
"uInitGndStr": "V",
"dcBus": 0,
"dcBusStr": "V",
"dcBusHalf": 0,
"dcBusHalfStr": "V",
"power": 0,
"powerStr": "kWp",
Return parameters
"powerPec": "1",
"porwerPercent": 0,
"pac": 0,
"pacStr": "kW",
"pacPec": "1",
"oneSelf": 0,
"eToday": 0,
"eTodayStr": "kWh",
"eMonth": 0,
"eMonthStr": "kWh",
"eYear": 0,
"eYearStr": "kWh",
"eTotal": 0,
"eTotalStr": "kWh",
"uPv1": 0,
"uPv1Str": "V",
"iPv1": 0,
"iPv1Str": "A",
"uPv2": 0,

- 17 -
 SolisCloud Platform API Document V2.0

"uPv2Str": "V",
"iPv2": 0,
"iPv2Str": "A",
......
"uPv32": 0,
"uPv32Str": "V",
"iPv32": 0,
"iPv32Str": "A",
"pow1": 0,
"pow1Str": "W",
"pow2": 0,
"pow2Str": "W",
"pow3": 0,
"pow3Str": "W",
......
"pow32": 0,
"pow32Str": "W",
"uAc1": 0,
"uAc1Str": "V",
"iAc1": 0,
"iAc1Str": "A",
"uAc2": 0,
"uAc2Str": "V",
"iAc2": 0,
"iAc2Str": "A",
"uAc3": 0,
"uAc3Str": "V",
"iAc3": 0,
"iAc3Str": "A",
"batteryDischargeEnergy": 0,
"batteryDischargeEnergyStr": "kWh",
"batteryChargeEnergy": 0,
"batteryChargeEnergyStr": "kWh",
"homeLoadEnergy": 0,
"homeLoadEnergyStr": "kWh",
"gridPurchasedEnergy": 0,
"gridPurchasedEnergyStr": "kWh",
"gridSellEnergy": 0,
"gridSellEnergyStr": "kWh",
"facStr": "Hz",
"batteryPower": 0,
"batteryPowerStr": "kW",
"batteryPowerPec": "1",
"batteryPowerZheng": 0,

- 18 -
 SolisCloud Platform API Document V2.0

"batteryPowerFu": 0,
"storageBatteryVoltage": 0,
"storageBatteryVoltageStr": "V",
"storageBatteryCurrent": 0,
"storageBatteryCurrentStr": "A",
"batteryVoltage": 0,
"batteryVoltageStr": "V",
"bstteryCurrent": 0,
"bstteryCurrentStr": "A",
"batteryPowerBms": 0,
"batteryPowerBmsStr": "kW",
"batteryChargingCurrent": 0,
"batteryChargingCurrentStr": "A",
"batteryDischargeLimiting": 0,
"batteryDischargeLimitingStr": "A",
"batteryTotalChargeEnergy": 0,
"batteryTotalChargeEnergyStr": "kWh",
"batteryTodayChargeEnergy": 0,
"batteryTodayChargeEnergyStr": "kWh",
"batteryMonthChargeEnergy": 0,
"batteryMonthChargeEnergyStr": "kWh",
"batteryYearChargeEnergy": 0,
"batteryYearChargeEnergyStr": "kWh",
"batteryYesterdayChargeEnergy": 0,
"batteryYesterdayChargeEnergyStr": "kWh",
"batteryTotalDischargeEnergy": 0,
"batteryTotalDischargeEnergyStr": "kWh",
"batteryTodayDischargeEnergy": 0,
"batteryTodayDischargeEnergyStr": "kWh",
"batteryMonthDischargeEnergy": 0,
"batteryMonthDischargeEnergyStr": "kWh",
"batteryYearDischargeEnergy": 0,
"batteryYearDischargeEnergyStr": "kWh",
"batteryYesterdayDischargeEnergy": 0,
"batteryYesterdayDischargeEnergyStr": "kWh",
"gridPurchasedTotalEnergy": 0,
"gridPurchasedTotalEnergyStr": "kWh",
"gridPurchasedYearEnergy": 0,
"gridPurchasedYearEnergyStr": "kWh",
"gridPurchasedMonthEnergy": 0,
"gridPurchasedMonthEnergyStr": "kWh",
"gridPurchasedTodayEnergy": 0,
"gridPurchasedTodayEnergyStr": "kWh",
"gridPurchasedYesterdayEnergy": 0,

- 19 -
 SolisCloud Platform API Document V2.0

"gridPurchasedYesterdayEnergyStr": "kWh",
"gridSellTotalEnergy": 0,
"gridSellTotalEnergyStr": "kWh",
"gridSellYearEnergy": 0,
"gridSellYearEnergyStr": "kWh",
"gridSellMonthEnergy": 0,
"gridSellMonthEnergyStr": "kWh",
"gridSellTodayEnergy": 0,
"gridSellTodayEnergyStr": "kWh",
"gridSellYesterdayEnergy": 0,
"gridSellYesterdayEnergyStr": "kWh",
"homeLoadTotalEnergy": 0,
"homeLoadTotalEnergyStr": "kWh",
"homeLoadTodayEnergy": 0,
"homeLoadTodayEnergyStr": "kWh",
"totalLoadPower": 0,
"totalLoadPowerStr": "kW",
"homeLoadYesterdayEnergy": 0,
"homeLoadYesterdayEnergyStr": "kWh",
"familyLoadPower": 0,
"familyLoadPowerStr": "kW",
"familyLoadPercent": 0,
"homeGridYesterdayEnergy": 0,
"homeGridYesterdayEnergyStr": "kWh",
"homeGridTodayEnergy": 0,
"homeGridTodayEnergyStr": "kWh",
"homeGridMonthEnergy": 0,
"homeGridMonthEnergyStr": "kWh",
"homeGridYearEnergy": 0,
"homeGridYearEnergyStr": "kWh",
"homeGridTotalEnergy": 0,
"homeGridTotalEnergyStr": "kWh",
"bypassLoadPower": 0,
"bypassLoadPowerStr": "kW",
"backupYesterdayEnergy": 0,
"backupYesterdayEnergyStr": "kWh",
"backupTodayEnergy": 0,
"backupTodayEnergyStr": "kWh",
"backupMonthEnergy": 0,
"backupMonthEnergyStr": "kWh",
"backupYearEnergy": 0,
"backupYearEnergyStr": "kWh",
"backupTotalEnergy": 0,
"backupTotalEnergyStr": "kWh",

- 20 -
 SolisCloud Platform API Document V2.0

"batteryType": "0",
"pEpmSet": 0,
"pEpmSetStr": "kW",
"pEpm": 0,
"pEpmStr": "kW",
"psumCalPec": "1",
"dispersionRate": 0,
"upvTotal": 0,
"upvTotalStr": "V",
"ipvTotal": 0,
"ipvTotalStr": "A",
"powTotal": 0,
"powTotalStr": "W",
"batteryCDEnableSet": 0,
"batteryCDSet": 0,
"batteryCDISet": 0,
"batteryCMaxiSet": 0,
"batteryDMaxiSet": 0,
"batteryUvpSet": 0,
"batteryFcvSet": 0,
"batteryAcvSet": 0,
"batteryOvpSet": 0,
"batteryLaTemp": 0,
"generatorPower": 0,
"generatorPowerStr": "kW",
"generatorPowerPec": "1",
"generatorTodayEnergy": 0,
"generatorTodayEnergyStr": "kWh",
"generatorTodayEnergyPec": "1",
"generatorTotalEnergy": 0,
"generatorTotalEnergyStr": "kWh",
"generatorTotalEnergyPec": "1",
"iA": 0,
"uA": 0,
"iB": 0,
"uB": 0,
"iC": 0,
"uC": 0,
"aReactivePower": 0,
"aLookedPower": 0,
"aPhasePowerFactor": 0,
"bReactivePower": 0,
"bLookedPower": 0,
"bPhasePowerFactor": 0,

- 21 -
 SolisCloud Platform API Document V2.0

"cReactivePower": 0,
"cLookedPower": 0,
"cPhasePowerFactor": 0,
"averagePowerFactor": 0,
"dcPacStr": "W",
"psum": 0,
"reactivePowerStr": "Var",
"apparentPowerStr": "VA",
"familyLoadPowerPec": "1",
"psumCal": 0,
"psumStr": "kW",
"psumCalStr": "kW"
}
}

3.3 Obtaining Details of Multiple Inverters

Interface Name Obtaining Details of Multiple Inverters

Interface Description Details of multiple inverters corresponding to SolisCloud
platform.
Request URL https://www.soliscloud.com:13333/v1/api/inverterDetailList
Interface frequency limit 2 times/sec
Request parameters [Body]
Requi
Parameter Name Data Type Description
red
Specify the number of page numbers to
pageNo String N return. The default value is 1,
representing page 1.
Specify the number of returns per page.
pageSize Integereger Y The default value is 20, and the
maximum value is 100.
Return parameters [Body]
Requi
Parameter Name Data Type Description
red
0 represents success, while others
code String Y represent failure. The failure code is
detailed in Appendix 1.
msg String Y Description of code values
data array Y Data identification
id Integereger Y Inverter ID
sn String N Inverter SN
stationId Integereger N Station ID
stationName String N Name of station

- 22 -
 SolisCloud Platform API Document V2.0

userId Integereger N Owner ID

collectorId Integereger N Collector ID
collectorName String N Name of the Collector
collectorsn String N Collector SN
currentState String N Current state
eToday Number N Daily power generation
eTodayStr String N Unit of daily power generation
eMonth Number N Monthly power generation
eMonthStr String N Unit of monthly power generation
eYear Number N Yearly power generation
eYearStr String N Unit of yearly power generation
eTotal Number N Total power generation
eTotalStr String N Unit of total power generation
fac Number N Grid frequency
facStr String N Unit of grid frequency
pac Number N Real time power
pacStr String N Unit of real time power
pacPec Number N Power percentage
Full power hours, power generation
fullHour Number N
divided by rated power
picName String N Picture name
power Number N Installed capacity
powerStr String N Unit of installed capacity
iAc1 Number N AC side current-R
iAc2 Number N AC side current-S
iAc3 Number N AC side current-T
uAc1 Number N AC side voltage-R
uAc2 Number N AC side voltage-S
uAc3 Number N AC side voltage-T
iPv1 Number N DC side current-1
iPv2 Number N DC side current-2
iPv3 Number N DC side current-3
iPv4 Number N DC side current-4
uPv1 Number N DC side voltage-1
uPv2 Number N DC side voltage-2
uPv3 Number N DC side voltage-3
uPv4 Number N DC side voltage-4
....... Number N 5~31
iPv32 Number N DC side current-32
uPv32 Number N DC side voltage-32

- 23 -
 SolisCloud Platform API Document V2.0

pow1 Number N DC side power-1

Pow2 Number N DC side power-2
....... Number N 3~31
Pow32 Number N DC side power-32
Inverter status: 1=online, 2=offline,
state Integer N
3=alarm
Data update time under UTC+8. The
dataTimestamp Integereger N
format is a timestamp.
inverterTemperature Number N Inverter temperature
nationalStandardstr String N National Grid Standards
AC output class: 0=single-phase,
acOutputType Integer N
others=three-phase
Number of DC input channels:
value+1=actual number of channels.
dcInputType Integer N
For example, 0=1 channel, 1=2
channels, 2=3 channels, and so on
powerFactor Number N Power factor
batteryPower Number N Battery power
batteryPowerStr String N Unit of battery power
batteryPowerPec Number N Battery power percentage
batteryCapacitySoc Number N Battery SOC
batteryHealthSoh Number N Battery SOH
socDischargeSet Number N Overdischarge of SOC
socChargingSet Number N Strong charging SOC
batteryType String N Current battery model
batteryVoltage Number N Battery voltage
batteryVoltageStr String N Unit of battery voltage
bstteryCurrent Number N Battery current
bstteryCurrentStr String N Unit of battery current
batteryPower Number N Battery power
batteryPowerStr String N Unit of battery power
batteryPowerPec Number N Battery power percentage
batteryFailureInformation01 String N Battery fault information-01
batteryFailureInformation02 String N Battery fault information-02
batteryTodayChargeEnergy Number N Daily battery charging energy
batteryTodayChargeEnergyStr String N Unit of daily battery charging energy
batteryMonthChargeEnergy Number N Monthly battery charging energy
Unit of monthly battery charging
batteryMonthChargeEnergyStr String N
energy
batteryYearChargeEnergy Number N Yearly battery charging energy
batteryYearChargeEnergyStr String N Unit of yearly battery charging energy

- 24 -
 SolisCloud Platform API Document V2.0

batteryTotalChargeEnergy Number N Total battery charging energy

batteryTotalChargeEnergyStr String N Unit of total battery charging energy
batteryTodayDischargeEnergy Number N Daily battery discharging energy
Unit of daily battery discharging
batteryTodayDischargeEnergyStr String N
energy
batteryMonthDischargeEnergy Number N Monthly battery discharging energy
Unit of monthly battery discharging
batteryMonthDischargeEnergyStr String N
energy
batteryYearDischargeEnergy Number N Yearly battery discharging energy
Unit of yearly battery discharging
batteryYearDischargeEnergyStr String N
energy
batteryTotalDischargeEnergy Number N Total battery discharging energy
batteryTotalDischarg
String N Unit of total battery discharging energy
eEnergyStr
gridPurchasedTodayEnergy Number N Daily grid purchased energy
gridPurchasedTodayEnergyStr String N Unit of daily grid purchased energy
gridPurchasedMonthEnergy Number N Monthly grid purchased energy
gridPurchasedMonthEnergyStr String N Unit of monthly grid purchased energy
gridPurchasedYearEnergy Number N Yearly grid purchased energy
gridPurchasedYearEnergyStr String N Unit of yearly grid purchased energy
gridPurchasedTotalEnergy Number N Total grid purchased energy
gridPurchasedTotalEnergyStr String N Unit of total grid purchased energy
gridSellTodayEnergy Number N Daily grid selling energy
gridSellTodayEnergyStr String N Unit of daily grid selling energy
gridSellMonthEnergy Number N Monthly grid selling energy
gridSellMonthEnergyStr String N Unit of monthly grid selling energy
gridSellYearEnergy Number N Yearly grid selling energy
gridSellYearEnergyStr String N Unit of yearly grid selling energy
gridSellTotalEnergy Number N Total grid selling energy
gridSellTotalEnergyStr String N Unit of total grid selling energy
familyLoadPower Number N Family load power
familyLoadPowerStr String N Unit of family load power
bypassLoadPower Number N Bypass load power
bypassLoadPowerStr String N Unit of bypass load power
pSum Number N Total active power of the grid
pSumStr String N Unit of total active power of the grid
Percentage of total active power of the
psumPec Number N
power grid
homeLoadTodayEnergy Number N Daily load consumption
homeLoadTodayEnergyStr String N Unit of daily load consumption

- 25 -
 SolisCloud Platform API Document V2.0

homeLoadTotalEnergy Number N Total load consumption

homeLoadTotalEnergyStr String N Unit of total load consumption
model String N Inverter model
type Integereger N Inverter type: 1=grid, 2=storage
name String N Inverter name
Type of inverter meter, see Appendix 3
inverterMeterModel Integereger N
for details
Inverter offline status: 0=normal
stateExceptionFlag Integereger N
offline, 1=abnormal offline
collectorState Integereger N Collector status: 1=online, 2=offline
collectorModel String N Collector model
warningInfoData Integereger N Alarm information
productModel String N Product model
nationalStandards String N National Grid Standards
version String N Inverter software version
reactivePower Number N Inverter reactive power
reactivePowerStr String N Unit inverter reactive power
apparentPower Number N Inverter apparent power
apparentPowerStr String N Unit of inverter apparent power
dcPac Number N Total DC input power of inverter
Unit of total DC input power of
dcPacStr String N
inverter
updateShelfEndTime Integereger N End time of warranty
Code example
POST /v1/api/inverterDetailList
Connection: keep-alive
Date: Wed, 28 Jun 2023 02:18:54 GMT
Content-MD5: sAGxE9QzeBN88qPrz+sCZQ==
Authorization:API
1300386381676644416:ewHgoms8cJSVoFo9wtCb40R6n7g=
Content-Type: application/json;charset=UTF-8
Request parameters
Content-Length: 30
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"pageNo": "1",
"pageSize": "10"
}
{
"success": true,
Return parameters
"code": "0",
"msg": "success",

- 26 -
 SolisCloud Platform API Document V2.0

"data": {
"records": [{
"id": "1308675217944612385",
"sn": "00FFFC445594901",
"inverterMeterModel": 1,
"collectorsn": "FFFC4455949",
"collectorId": "1306858901386142563",
"state": 2,
"stateExceptionFlag": 0,
"simFlowState": -4,
"fullHour": 0,
"fullHourStr": "h",
"currentState": "4dd",
"warningInfoData": 0,
"updateShelfEndTime": 0,
"timeZone": 8.00,
"timeZoneStr": "UTC+08:00",
"daylight": 0,
"daylightSwitch": 0,
"model": "1E",
"productModel": "1E",
"ctrlCommand": 0,
"inverterTemperature": 57.2,
"inverterTemperatureUnit": "℉",
"temp": 175,
"tempName": "IGBT",
"sno": "108B3B",
"stationId": "1298491919448633624",
"version": "000A08",
"acOutputType": 1,
"dcInputType": 19,
"rs485ComAddr": "e46",
"dataTimestamp": "1685416761952",
"timeStr": "2023-05-30 11:19:21",
"reactivePower": 55.943,
"apparentPower": 44.899,
"dcPac": 0.000,
"uInitGnd": 0,
"uInitGndStr": "V",
"dcBus": 10.000,
"dcBusStr": "V",
"dcBusHalf": 10.000,
"dcBusHalfStr": "V",
"power": 0.000,

- 27 -
 SolisCloud Platform API Document V2.0

"powerStr": "kWp",
"powerPec": "1",
"porwerPercent": 0,
"pac": 21.046,
"pacStr": "kW",
"pacPec": "1",
"oneSelf": 0.000,
"eToday": 750.600,
"eTodayStr": "kWh",
"eMonth": 5.693,
"eMonthStr": "MWh",
"eYear": 92.996,
"eYearStr": "MWh",
"eTotal": 102.293,
"eTotalStr": "MWh",
"uPv1": 0,
"uPv1Str": "V",
"iPv1": 0,
"iPv1Str": "A",
"uPv2": 0,
"uPv2Str": "V",
"iPv2": 0,
"iPv2Str": "A",
......
"uPv32": 0,
"uPv32Str": "V",
"iPv32": 0,
"iPv32Str": "A",
"pow1": 0,
"pow1Str": "W",
"pow2": 0,
"pow2Str": "W",
"pow3": 0,
"pow3Str": "W",
......
"pow32": 0,
"pow32Str": "W",
"uAc1": 0.900,
"uAc1Str": "V",
"iAc1": 1.000,
"iAc1Str": "A",
"uAc2": 220.000,
"uAc2Str": "V",
"iAc2": 230.000,

- 28 -
 SolisCloud Platform API Document V2.0

"iAc2Str": "A",
"uAc3": 220.000,
"uAc3Str": "V",
"iAc3": 230.000,
"iAc3Str": "A",
"powerFactor": 1.000,
"batteryDischargeEnergy": 0,
"batteryDischargeEnergyStr": "kWh",
"batteryChargeEnergy": 0,
"batteryChargeEnergyStr": "kWh",
"homeLoadEnergy": 0,
"homeLoadEnergyStr": "kWh",
"gridPurchasedEnergy": 0,
"gridPurchasedEnergyStr": "kWh",
"gridSellEnergy": 0,
"gridSellEnergyStr": "kWh",
"fac": 50.000,
"facStr": "Hz",
"batteryPower": 0.000,
"batteryPowerStr": "kW",
"batteryPowerPec": "1",
"batteryPowerZheng": 0.000,
"batteryPowerFu": 0,
"storageBatteryVoltage": 0.000,
"storageBatteryVoltageStr": "V",
"storageBatteryCurrent": 0.000,
"storageBatteryCurrentStr": "A",
"batteryCapacitySoc": 0.000,
"batteryHealthSoh": 0.000,
"batteryVoltage": 0.000,
"batteryVoltageStr": "V",
"bstteryCurrent": 0.000,
"bstteryCurrentStr": "A",
"batteryPowerBms": 0.000,
"batteryPowerBmsStr": "kW",
"internalBatteryI": 0.000,
"batteryChargingCurrent": 0.000,
"batteryChargingCurrentStr": "A",
"batteryDischargeLimiting": 0.000,
"batteryDischargeLimitingStr": "A",
"batteryFailureInformation01": "0",
"batteryFailureInformation02": "0",
"batteryTotalChargeEnergy": 0.000,
"batteryTotalChargeEnergyStr": "kWh",

- 29 -
 SolisCloud Platform API Document V2.0

"batteryTodayChargeEnergy": 0.000,
"batteryTodayChargeEnergyStr": "kWh",
"batteryMonthChargeEnergy": 0,
"batteryMonthChargeEnergyStr": "kWh",
"batteryYearChargeEnergy": 0,
"batteryYearChargeEnergyStr": "kWh",
"batteryYesterdayChargeEnergy": 0.000,
"batteryYesterdayChargeEnergyStr": "kWh",
"batteryTotalDischargeEnergy": 0.000,
"batteryTotalDischargeEnergyStr": "kWh",
"batteryTodayDischargeEnergy": 0.000,
"batteryTodayDischargeEnergyStr": "kWh",
"batteryMonthDischargeEnergy": 0,
"batteryMonthDischargeEnergyStr": "kWh",
"batteryYearDischargeEnergy": 0,
"batteryYearDischargeEnergyStr": "kWh",
"batteryYesterdayDischargeEnergy": 0.000,
"batteryYesterdayDischargeEnergyStr": "kWh",
"gridPurchasedTotalEnergy": 0.000,
"gridPurchasedTotalEnergyStr": "kWh",
"gridPurchasedYearEnergy": 0,
"gridPurchasedYearEnergyStr": "kWh",
"gridPurchasedMonthEnergy": 0,
"gridPurchasedMonthEnergyStr": "kWh",
"gridPurchasedTodayEnergy": 0.000,
"gridPurchasedTodayEnergyStr": "kWh",
"gridPurchasedYesterdayEnergy": 0.000,
"gridPurchasedYesterdayEnergyStr": "kWh",
"gridSellTotalEnergy": 0.000,
"gridSellTotalEnergyStr": "kWh",
"gridSellYearEnergy": 0,
"gridSellYearEnergyStr": "kWh",
"gridSellMonthEnergy": 0,
"gridSellMonthEnergyStr": "kWh",
"gridSellTodayEnergy": 0.000,
"gridSellTodayEnergyStr": "kWh",
"gridSellYesterdayEnergy": 0.000,
"gridSellYesterdayEnergyStr": "kWh",
"homeLoadTotalEnergy": 0.000,
"homeLoadTotalEnergyStr": "kWh",
"homeLoadTodayEnergy": 0.000,
"homeLoadTodayEnergyStr": "kWh",
"totalLoadPower": 0,
"totalLoadPowerStr": "kW",

- 30 -
 SolisCloud Platform API Document V2.0

"homeLoadYesterdayEnergy": 0.000,
"homeLoadYesterdayEnergyStr": "kWh",
"familyLoadPower": 0.000,
"familyLoadPowerStr": "kW",
"familyLoadPercent": 0,
"homeGridYesterdayEnergy": 0.000,
"homeGridYesterdayEnergyStr": "kWh",
"homeGridTodayEnergy": 0.000,
"homeGridTodayEnergyStr": "kWh",
"homeGridMonthEnergy": 0.000,
"homeGridMonthEnergyStr": "kWh",
"homeGridYearEnergy": 0.000,
"homeGridYearEnergyStr": "kWh",
"homeGridTotalEnergy": 0.000,
"homeGridTotalEnergyStr": "kWh",
"bypassLoadPower": 0.000,
"bypassLoadPowerStr": "kW",
"backupYesterdayEnergy": 0.000,
"backupYesterdayEnergyStr": "kWh",
"backupTodayEnergy": 0.000,
"backupTodayEnergyStr": "kWh",
"backupMonthEnergy": 0.000,
"backupMonthEnergyStr": "kWh",
"backupYearEnergy": 0.000,
"backupYearEnergyStr": "kWh",
"backupTotalEnergy": 0.000,
"backupTotalEnergyStr": "kWh",
"bypassAcVoltage": 0.000,
"bypassAcVoltageB": 0.0,
"bypassAcVoltageC": 0.0,
"bypassAcCurrent": 0.000,
"bypassAcCurrentB": 0.0,
"bypassAcCurrentC": 0.0,
"pLimitSet": 1.0,
"pFactorLimitSet": 1.0,
"pReactiveLimitSet": 1.0,
"batteryType": "1.0",
"socDischargeSet": 100.0,
"socChargingSet": 100.0,
"pEpmSet": 10.000,
"pEpmSetStr": "kW",
"epmFailSafe": 0.0,
"epmSafe": 1,
"pEpm": 1.000,

- 31 -
 SolisCloud Platform API Document V2.0

"pEpmStr": "kW",
"psumCalPec": "1",
"insulationResistance": 0.0,
"dispersionRate": 219.09,
"sirRealtime": 0,
"iLeakLimt": 0,
"upvTotal": 0,
"upvTotalStr": "V",
"ipvTotal": 0,
"ipvTotalStr": "A",
"powTotal": 0,
"powTotalStr": "W",
"parallelStatus": 0,
"parallelAddr": 0,
"parallelPhase": 0,
"parallelBattery": 0,
"batteryAlarm": "0",
"bypassAcOnoffSet": 0.0,
"bypassAcVoltageSet": 0.0,
"bypassAcCurrentSet": 0.0,
"batteryCDEnableSet": 0.0,
"batteryCDSet": 0.0,
"batteryCDISet": 0.0,
"batteryCMaxiSet": 0.0,
"batteryDMaxiSet": 0.0,
"batteryUvpSet": 0.0,
"batteryFcvSet": 0.0,
"batteryAcvSet": 0.0,
"batteryOvpSet": 0.0,
"batteryOlvEnableSet": 0.0,
"batteryLaTemp": 0.0,
"offGridDDepth": 0.0,
"epsDDepth": 0.0,
"epsSwitchTime": "0",
"bmsState": 0,
"acInType": 0,
"energyStorageControl": "0",
"meter1Type": 0,
"meter2Type": 0,
"meter1SiteHigh": 0,
"meter2SiteHigh": 0,
"meter1TypeLow": 0,
"meter2TypeLow": 0,
"generatorPower": 0.000,

- 32 -
 SolisCloud Platform API Document V2.0

"generatorPowerStr": "kW",
"generatorPowerPec": "1",
"generatorTodayEnergy": 0.000,
"generatorTodayEnergyStr": "kW",
"generatorTodayEnergyPec": "1",
"generatorTotalEnergy": 0.000,
"generatorTotalEnergyStr": "kW",
"generatorTotalEnergyPec": "1",
"generatorWarning": "0",
"generatorSet": "0",
"generatorSet01": 0.000,
"parallelOnoff": "0",
"parallelOnoff01": 0.000,
"parallelOnoff02": 0.000,
"parallelNumber": 0.000,
"parallelOnline": 0.000,
"iA": 0,
"uA": 0,
"iB": 0,
"uB": 0,
"iC": 0,
"uC": 0,
"aReactivePower": 0,
"aLookedPower": 0,
"aPhasePowerFactor": 0,
"bReactivePower": 0,
"bLookedPower": 0,
"bPhasePowerFactor": 0,
"cReactivePower": 0,
"cLookedPower": 0,
"cPhasePowerFactor": 0,
"averagePowerFactor": 0,
"dcPacStr": "VA",
"psum": 5.000,
"reactivePowerStr": "kVar",
"apparentPowerStr": "kVA",
"familyLoadPowerPec": "1",
"psumCal": 21.046,
"psumStr": "kW",
"psumCalStr": "kW"
}]
}
}

- 33 -
 SolisCloud Platform API Document V2.0

3.4 Obtain real-time data of a single inverter on a certain day

Interface Name Obtain real-time data of a single inverter on a certain day

Interface Description Corresponding daily chart of SolisCloud platform inverter details.
Request URL https://www.soliscloud.com:13333/v1/api/inverterDay
Interface frequency limit 2 times/sec
Request parameters [Body]
Parameter Name Data Type Required Description
id Integer N Query the data of the specified inverter ID or
N inverter SN, and both ID and SN cannot be
sn String empty at the same time.
money String Y Used to calculate revenue, e.g. EUR, CNY
time String Y Specify to query data for a certain day,
format: yyyy-MM-dd
timeZone Integer Y The time zone where the device is located.
Example: 8
Return parameters [Body]
Parameter Name Data Type Required Description
code String Y 0 represents success, while others represent
failure. The failure code is detailed in
Appendix 1.
msg String Y Description of code values
data Array Y Data identification
dataTimestamp Integer N Data update time under UTC+8. The format
is a timestamp.
timeStr String N Update time, string converted based on time
zone
eToday Number N Daily power generation
eTotal Number N Total power generation
fac Number N Grid frequency
pac Number N Real time power
pacStr String N Unit of real time power
pacPec Number N Power percentage
iAc1 Number N AC side current-R
iAc2 Number N AC side current-S
iAc3 Number N AC side current-T
uAc1 Number N AC side voltage-R
uAc2 Number N AC side voltage-S
uAc3 Number N AC side voltage-T
iPv1 Number N DC side current-1
iPv2 Number N DC side current-2

- 34 -
 SolisCloud Platform API Document V2.0

iPv3 Number N DC side current-3

iPv4 Number N DC side current-4
uPv1 Number N DC side voltage-1
uPv2 Number N DC side voltage-2
uPv3 Number N DC side voltage-3
uPv4 Number N DC side voltage-4
inverterTemperature Number N Inverter temperature
N AC output class: 0=single-phase,
acOutputType Integer others=three-phase
Number of DC input channels:
value+1=actual number of channels.
dcInputType Integer N
For example, 0=1 channel, 1=2 channels,
2=3 channels, and so on
powerFactor Number N Power factor
batteryCapacitySoc Number N Battery SOC
batteryHealthSoh Number N Battery SOH
socDischargeSet Number N Overdischarge of SOC
socChargingSet Number N Strong charging SOC
batteryVoltage Number N Battery voltage
bstteryCurrent Number N Battery current
batteryPower Number N Battery power
batteryTodayChargeEnergy Number N Daily battery charging energy
batteryTotalChargeEnergy Number N Total battery charging energy
batteryTodayDischargeEnergy Number N Daily battery discharging energy
batteryTotalDischargeEnergy Number N Total battery discharging energy
gridPurchasedTodayEnergy Number N Daily grid purchased energy
gridPurchasedTotalEnergy Number N Total grid purchased energy
gridSellTodayEnergy Number N Daily grid selling energy
gridSellTotalEnergy Number N Total grid selling energy
familyLoadPower Number N Family load power
bypassLoadPower Number N Bypass load power
pSum Number N Total active power of the grid
homeLoadTodayEnergy Number N Daily load consumption
homeLoadTotalEnergy Number N Total load consumption
Code example
POST /v1/api/inverterDay
Connection: keep-alive
Date: Tue, 27 Jun 2023 11:21:04 GMT
Request parameters
Content-MD5: uS4IZTyKQmsv606fXNjQ0A==
Authorization:API
1300386381676644416:xNtp1S0/KMJ60iUURwmsSAH7azs=

- 35 -
 SolisCloud Platform API Document V2.0

Content-Type: application/json;charset=UTF-8
Content-Length: 100
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"id":"1308675217944611083",
"sn":"120B40198150131",
"money":"",
"time":"2023-06-27",
"timeZone":"8"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": [
{
"dataTimestamp": "1687813291000",
"timeStr": "2023-06-27 05:01:31",
"acOutputType": 1,
"dcInputType": 3,
"state": 1,
"time": "05:01:31",
Return parameters "pac": 74.000,
"pacStr": "kW",
"pacPec": "0.001",
"eToday": 0.000,
"eTotal": 36362.000,
"uPv1": 245.3,
"iPv1": 0.1,
"uPv2": 243.0,
"iPv2": 0.1,
"uPv3": 244.7,
}
]
}

3.5 Obtaining Daily Data of a Single Inverter for a Month

Interface Name Obtaining Daily Data of a Single Inverter for a Month

Interface Description Monthly chart corresponding to SolisCloud platform inverter details.
Request URL https://www.soliscloud.com:13333/v1/api/inverterMonth
Interface frequency
2 times/sec
limit

- 36 -
 SolisCloud Platform API Document V2.0

Request parameters [Body]

Parameter Name Data Type Required Description
id number N Query the data of the specified inverter ID
or inverter SN, and both ID and SN cannot be
sn String N
empty at the same time.
money String Y Used to calculate revenue, e.g. EUR, CNY
Query data for a specified month in the format of
month String Y
'yyyy MM'
Return parameters [Body]
Parameter Name Data Type Required Description
0 represents success, while others represent
code String Y
failure. The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
energy number N Power generation
energyStr String N Unit of power generation
date Number N Data, format timestamp
dateStr String N Data, format string
money Number N Income
moneyStr String N Unit of income
batteryDischargeEnergy number N Battery discharge energy
batteryChargeEnergy Number N Battery charging energy
gridPurchasedEnergy number N Grid purchased energy
gridSellEnergy Number N Grid sell energy
Code example
POST /v1/api/inverterMonth
Connection: keep-alive
Date: Tue, 27 Jun 2023 11:25:25 GMT
Content-MD5: Sdjc8y5oT63JIHwqy/J5ew==
Authorization:API 1300386381676644416:lrfIOa5z7mm6TnKGxT0lDV1lRmk=
Content-Type: application/json;charset=UTF-8
Content-Length: 98
Host: test.soliscloud.com:3333
Request parameters User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)

{
"id": "1308675217944611083",
"sn": "120B40198150131",
"money": "",
"month": "2023-06",
"timeZone": "8"
}

- 37 -
 SolisCloud Platform API Document V2.0

{
"success": true,
"code": "0",
"msg": "success",
"data": [
{
"inverterId": "1308675217944611083",
"id": "1308676247344233516",
"money": 41.600,
"moneyStr": "AUD",
"moneyPec": "1",
"energy": 41.600,
"energyStr": "kWh",
"energyPec": "1",
"fullHour": 5.20000,
"date": 1685592000000,
"dateStr": "2023-06-01",
"timeZone": 8,
"batteryDischargeEnergy": 0.00000,
"batteryChargeEnergy": 0.00000,
"gridPurchasedEnergy": 0.00000,
"gridPurchasedIncome": 0.000,
Return parameters
"gridSellEnergy": 0.00000,
"gridSellIncome": 0.000,
"homeLoadEnergy": 0.00000,
"consumeEnergy": 0,
"produceEnergy": 0,
"offSetEnergy": 0,
"offSetIncome": 0,
"errorFlag": 0
},
...... 2023-06-01 ~ 2023-06-26
{
"inverterId": "1308675217944611083",
"id": "1308676247344236300",
"money": 44.900,
"moneyStr": "AUD",
"moneyPec": "1",
"energy": 44.900,
"energyStr": "kWh",
"energyPec": "1",
"fullHour": 5.61,
"date": 1687838400000,
"dateStr": "2023-06-27",

- 38 -
 SolisCloud Platform API Document V2.0

"timeZone": 8,
"batteryDischargeEnergy": 0,
"batteryChargeEnergy": 0,
"gridPurchasedEnergy": 0,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0,
"gridSellIncome": 0.000,
"homeLoadEnergy": 0,
"consumeEnergy": 0,
"produceEnergy": 0,
"offSetEnergy": 0,
"offSetIncome": 0,
"errorFlag": 0
}
]
}

3.6 Obtain monthly data of a single inverter for a certain year

Interface Name Obtain monthly data of a single inverter for a certain year
Annual chart corresponding to the inverter details of the SolisCloud
Interface Description
platform.
Request URL https://www.soliscloud.com:13333/v1/api/inverterYear
Interface frequency
2 times/sec
limit
Request parameters [Body]
Parameter Name Data Type Required Description
id number N Query the data of the specified inverter ID or
inverter SN, and both ID and SN cannot be
sn String N
empty at the same time.
money String Y Used to calculate revenue, e.g. EUR, CNY
Query data for a specified year, time format:
year String Y
"yyyy"
Return parameters [Body]
Parameter Name Data Type Required Description
0 represents success, while others represent
code String Y failure. The failure code is detailed in
Appendix 1.
msg String Y Description of code values
data Object Y Data identification
energy number N Power generation
energyStr String N Unit of power generation
date Number N Data, format timestamp

- 39 -
 SolisCloud Platform API Document V2.0

dateStr String N Data, format string

money Number N Income
moneyStr String N Unit of income
batteryDischargeEnergy number N Battery discharge energy
batteryChargeEnergy Number N Battery charging energy
gridPurchasedEnergy number N Grid purchased energy
gridSellEnergy Number N Grid sell energy
Code example
POST /v1/api/inverterYear
Connection: keep-alive
Date: Tue, 27 Jun 2023 11:27:46 GMT
Content-MD5: DX2ecuD6A/Nd1CyX7dOZyg==
Authorization: API 1300386381676644416:Sh/MgB/ddIuRItuE6zj238qkxd4=
Content-Type: application/json;charset=UTF-8
Content-Length: 94
Host: test.soliscloud.com:3333
Request parameters User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)

{
"id": "1308675217944611083",
"sn": "120B40198150131",
"money": "元",
"year": "2023",
"timeZone": "8"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": [
{
"inverterId": "1308675217944611083",
"id": "1308675218175749632",
"money": 359.476,
Return parameters
"moneyStr": "KAUD",
"moneyPec": "0.001",
"energy": 866.000,
"energyStr": "MWh",
"energyPec": "0.001",
"fullHour": 108.25000,
"date": 1672545600000,
"dateStr": "2023-01",
"timeZone": 8,

- 40 -
 SolisCloud Platform API Document V2.0

"batteryDischargeEnergy": 0.00000,
"batteryChargeEnergy": 0.00000,
"gridPurchasedEnergy": 0.00000,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0.00000,
"gridSellIncome": 0.000,
"homeLoadEnergy": 0.00000,
"consumeEnergy": 0,
"produceEnergy": 0,
"offSetEnergy": 0,
"offSetIncome": 0,
"errorFlag": 0
},
...... 2023-02 ~ 2023-05
{
"inverterId": "1308675217944611083",
"id": "1308675218175756315",
"money": 852.000,
"moneyStr": "KAUD",
"moneyPec": "0.001",
"energy": 852.000,
"energyStr": "MWh",
"energyPec": "0.001",
"fullHour": 106.50,
"date": 1685592000000,
"dateStr": "2023-06",
"timeZone": 8,
"batteryDischargeEnergy": 0,
"batteryChargeEnergy": 0,
"gridPurchasedEnergy": 0,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0,
"gridSellIncome": 0.000,
"homeLoadEnergy": 0,
"consumeEnergy": 0,
"produceEnergy": 0,
"offSetEnergy": 0,
"offSetIncome": 0,
"errorFlag": 0
}
]
}

3.7 Obtaining Annual Data of a Single Inverter

- 41 -
 SolisCloud Platform API Document V2.0

Interface Name Obtaining Annual Data of a Single Inverter

Interface Description The cumulative chart corresponding to the SolisCloud platform inverter.
Request URL https://www.soliscloud.com:13333/v1/api/inverterAll
Interface frequency
2 times/sec
limit
Request parameters [Body]
Parameter Name Data Type Required Description
id number N Query the data of the specified inverter ID or
inverter SN, and both ID and SN cannot be
sn String N
empty at the same time.
money String Y Used to calculate revenue, e.g. EUR, CNY
Return parameters [Body]
Parameter Name Data Type Required Description
0 represents success, while others represent
code String Y failure. The failure code is detailed in Appendix
1.
msg String Y Description of code values
data Object Y Data identification
year Integer Y Year
energy number N Power generation
energyStr String N Unit of power generation
batteryDischargeEnergy number N Battery discharge energy
batteryChargeEnergy Number N Battery charging energy
gridPurchasedEnergy number N Grid purchased energy
gridSellEnergy Number N Grid sell energy
Code example
POST /v1/api/userStationList
Connection: keep-alive
Date: Wed, 31 May 2023 09:12:23 GMT
Content-MD5: nyUAGqC1qeRnZ4vvgxK2ow==
Authorization: API 1300386381676565707:PqHiyhsQ8BILCrfIHshkSue5yzg=
Content-Type: application/json;charset=UTF-8
Content-Length: 70
Request parameters
Host: www.soliscloud.com:13333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"pageNo": 1,
"pageSize": 10,
"nmiCode": ""
}
{
Return parameters
"code": "0",

- 42 -
 SolisCloud Platform API Document V2.0

"msg": "success",
"data": {
"stationStatusVo": {
"all": 0,
"normal": 0,
"fault": 0,
"offline": 0,
"building": 0,
"mppt": 0
},
"page": {
"records": [ ],
"total": 0,
"size": 10,
"current": 1,
"orders": [ ],
"optimizeCountSql": false,
"searchCount": true,
"pages": 0
},
"mpptSwitch": 0
}
}

3.8 Obtaining Quality Assurance Data for Multiple Inverters

Interface Name Obtaining Quality Assurance Data for Multiple Inverters
Interface Description Corresponding to SolisCloud platform warranty query.
Request URL https://www.soliscloud.com:13333/v1/api/inverter/shelfTime
Interface frequency
2 times/sec
limit
Request parameters [Body]
Data
Parameter Name Required Description
Type
Specify the number of page numbers to return. The
pageNo number Y
default value is 1, representing page 1.
Specify the number of returns per page. The default
pageSize number Y
value is 20, and the maximum value is 100.
Specify to query single or multiple inverter SNs.
sn String N When querying multiple, the SN is separated by ','. A
maximum of 1000 SNs at a time.
Return parameters [Body]
Data
Parameter Name Required Description
Type
code String Y 0 represents success, while others represent failure.

- 43 -
 SolisCloud Platform API Document V2.0

The failure code is detailed in Appendix 1.

msg String Y Description of code values
data Object Y Data identification
page Object Y result list
total Integer Y Total number of lists
records Array Y Array of record
id number Y Inverter ID
sn String Y Inverter SN
shelfBeginTime number N Start time of warranty
shelfEndTime number N End time of warranty
shelfTime number N Warranty period
shelfState number N Warranty status: 0=Under warranty, 1=Over warranty
Code example
POST /v1/api/inverter/shelfTime
Connection: keep-alive
Date: Wed, 28 Jun 2023 06:42:38 GMT
Content-MD5: YyrTpXdCTJN377g1hYLcJw==
Authorization:API
1300386381676644416:k+aaQOt5Tr3M4YmLpKjJUoQgum4=
Content-Type: application/json;charset=UTF-8
Request parameters Content-Length: 45
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"pageNo": "1",
"pageSize": "20",
"sn": "120B40198150131"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"records": [
{
Return parameters "id": "1308675217944612369",
"deleteFlag": 0,
"sn": "00FFC1155339601",
"shelfState": "--",
"shelfTime": 0,
"shelfWarrantyType": 0
},
{

- 44 -
 SolisCloud Platform API Document V2.0

"id": "1308675217944611083",
"deleteFlag": 0,
"sn": "120B40198150131",
"shelfState": "--",
"shelfTime": 0,
"shelfWarrantyType": 0
}
],
"total": 2,
"size": 20,
"current": 1,
"orders": [ ],
"optimizeCountSql": true,
"searchCount": true,
"pages": 1
}
}

3.9 Obtain the device alarm list under the account

Interface Name Obtain the device alarm list under the account
Interface Description Corresponding SolisCloud platform alarm information query.
Request URL https://www.soliscloud.com:13333/v1/api/alarmList
Interface frequency
2 times/sec
limit
Request parameters [Body]
Parameter Name Data Type Required Description
Specify the number of page numbers to return.
pageNo String N
The default value is 1, representing page 1.
Specify the number of returns per page. The
pageSize Integereger Y
default value is 20, and the maximum value is 100.
1. Specify stationId to represent the information
under this power station, which can be obtained
Integereger
stationId N from the list of power stations.
2. If this value is blank, it represents querying all
information under the account.
1. Specify alarmDeviceSn to represent the query
of alarm information under this inverter.
alarmDeviceSn String N 2. If this value is blank, it means querying all
alarm information of all inverters under this
account.
1. Specify the alarm information since querying
alarmBegIntegerime String N yyyy-MM-dd
2. If this value is blank, it represents querying all.

- 45 -
 SolisCloud Platform API Document V2.0

1. Specify the alarm information found for

alarmEndTime String N yyyy-MM-dd.
2. If this value is blank, it represents querying all.
1. Specify nmiCode to represent the information
under this nmi, which can be obtained from the list
nmiCode String N of power plants.
2. If this value is blank, it represents querying the
information under the account.
Return parameters [Body]
Parameter Name Data Type Required Description
0 represents success, while others represent
code String Y
failure. The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
page Object Y result list
total Integer Y Total number of lists
records Array Y Array of record
stationId Long Y Station ID
stationName String N Name of station
alarmDeviceSn String N Inverter SN
Alarm code. Please refer to the fault information
alarmCode String N
table for detailed analysis.
alarmLevel String N Alarm level: 1=tip, 2=general, 3=emergency
alarmBegIntegerime Long N Alarm start time
alarmEndTime Long N Alarm end time
alarmMsg String N Alarm content
advice String N Alarm handling suggestions
state String N Alarm status: 0=pending, 1=processed, 2=restored
warningInfoData Integereger N Sub alarm code
Code example
POST /v1/api/alarmList
Connection: keep-alive
Date: Wed, 28 Jun 2023 02:14:44 GMT
Content-MD5: vSNnxiqefqgVUnS7iLaT5Q==
Authorization: API 1300386381676644416:0AkbOnxxeTgBIo9mjy2811KB98o=
Content-Type: application/json;charset=UTF-8
Request parameters
Content-Length: 122
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"pageNo": "1",
"pageSize": "10",

- 46 -
 SolisCloud Platform API Document V2.0

"stationId": "1298491919448631809",
"alarmDeviceSn": "00FFC0011557001",
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"records": [
{
"id": "-1",
"stationId": "1298491919448631809",
"alarmDeviceSn": "00FFC0011557001",
"alarmDeviceType": "3",
"alarmType": 0,
"alarmLevel": "1",
"alarmCode": "2129",
"alarmBeginTime": 1687918458326,
"alarmEndTime": 1687918484635,
"alarmLong": "26308",
Return parameters
"state": "0",
"advice": "",
"alarmMsg": "",
"model": "1e",
"warningInfoData": 0,
"type": 0
}
],
"total": 1,
"size": 10,
"current": 1,
"orders": [ ],
"optimizeCountSql": true,
"searchCount": true,
"pages": 1
}
}

3.10 Obtain the collector list under the account

Interface Name Obtain the collector list under the account
Interface Description List of collectors corresponding to the SolisCloud platform.
Request URL https://www.soliscloud.com:13333/v1/api/collectorList
Interface frequency limit 2 times/sec

- 47 -
 SolisCloud Platform API Document V2.0

Request parameters [Body]

Parameter Name Data Required Description
Type
pageNo Specify the number of page numbers to return.
String Y
The default value is 1, representing page 1.
Specify the number of returns per page. The
pageSize String Y default value is 20, and the maximum value is
100.
1. Specify stationId to represent the
information under this power station, which
stationId Integer N can be obtained from the list of power stations.
2. If this value is blank, it represents querying
all information under the account.
1. Specify nmiCode to represent the
information under this nmi, which can be
nmiCode String N obtained from the list of power plants.
2. If this value is blank, it represents querying
the information under the account.
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent
code String Y failure. The failure code is detailed in
Appendix 1.
msg String Y Description of code values
data Object Y Data identification
page Object N result list
collectionStatusVo Object N Number of results
total Integer N Total number of lists
records Array N Array of record
all Integer N Total number of Collectors
normal Integer N Normal number of Collectors
offline Integer N Number of offline Collectors
fault Integer N Number of Collectors faults
id Integer N Collector ID
stationName String N Name of station
stationId Integer N Station ID
userId Integer N Owner ID
sn String N Collector SN
model String N Collector Model
name String N Name of the Collector
rssiLevel String N Collector signal strength

- 48 -
 SolisCloud Platform API Document V2.0

state Integer N Inverter status: 1=online, 2=offline, 3=alarm

Data update time under UTC+8. The format is
dataTimestamp Integer N
a timestamp.
contractTime Integer N Traffic expiration time
Code example
POST /v1/api/collectorList
Connection: keep-alive
Date: Tue, 27 Jun 2023 06:08:42 GMT
Content-MD5: Trz24rS6Ot0X3mHzTjNPww==
Authorization:API
1300386381676644416:H5snoTcVYy8btETT9efTikfo1Vk=
Content-Type: application/json;charset=UTF-8
Content-Length: 84
Request parameters Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"pageNo": 1,
"pageSize": 10,
"stationId": "",
"nmiCode": "41028459350"
}

{
"success": true,
"code": "0",
"msg": "success",
"data": {
"collectionStatusVo": {
"all": 9,
"normal": 0,
"fault": 0,
"offline": 9
},
Return parameters
"page": {
"records": [
{
"id": "1306858901386141423",
"sn": "404314859",
"stationId": "1298491919448631809",
"state": 1,
"stateExceptionFlag": 0,
"gprsPackage": "A",
"simFlowState": -5,
"model": "",

- 49 -
 SolisCloud Platform API Document V2.0

"runingTime": "0",
"currentWorkingTime": "0",
"totalWorkingTime": "0",
"dataUploadCycle": "0",
"factoryTime": "0",
"dataTimestamp": "1687845861000",
"dataTimestampStr": "2023-06-27 16:04:21
(UTC+10:00)",
"rssiLevel": 0,
"rssi": 0,
"iccid": "",
"collectorMode": 0,
"collectorModeSet": 0,
"dataloggerModel": 0,
"connectionOperator": "",
"lac": "0",
"ci": "0",
"countryStr": "",
"regionId": 423,
"regionStr": "",
"cityId": 11393,
"cityStr": "Forster",
"countyId": 11379,
"countyStr": "Forster",
"addr": "Aquatic Drive",
"buildAddr": "Aquatic Drive,Forster",
"timeZone": 10.00,
"timeZoneStr": "UTC+10:00",
"timeZoneName": "(UTC+10:00) ",
"shelfStateTag": 0,
"tag": "YingZhen"
}
],
"total": 1,
"size": 10,
"current": 1,
"orders": [ ],
"optimizeCountSql": true,
"searchCount": true,
"pages": 1
},
"mpptSwitch": 1
}
}

- 50 -
 SolisCloud Platform API Document V2.0

3.11 Obtaining Details of a Single Collector

Interface Name Obtaining Details of a Single Collector
Interface Description Corresponding SolisCloud platform collector details
Request URL https://www.soliscloud.com:13333/v1/api/collectorDetail
Interface frequency limit 2 times/sec
Request parameters [Body]
Data
Parameter Name Required Description
Type
id Integer Y Query the detailed data of the specified collector
ID or collector SN, where both ID and SN cannot
sn String Y
be empty.
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent
code String Y failure. The failure code is detailed in Appendix
1.
msg String Y Description of code values
data Object Y Data identification
id Integer N Collector ID
stationId Integer N Station ID
stationName String N Name of station
addr String N Station address
userId Integer N Owner ID
state Integer N Plant station status: 1=online, 2=offline, 3=alarm
dataTimestamp Integer N Plant update time
totalWorkingTime Integer N Total Working Time
sn String N Collector SN
model String N Collector Model
name String N Name of the Collector
rssiLevel String N Collector signal strength
lanIp String N LAN IP
maximumNumber Integer N Maximum number of connections
actualNumber Integer N Actual number of connected units
connectedSsid String N Connected ssid
connectionOperator String N Operator Name
currentWorkingTime Integer N The working time of this power on
totalWorkingTime Integer N Total Working Time
dataUploadCycle Integer N Data upload interval
factoryTime Integer N Delivery time

- 51 -
 SolisCloud Platform API Document V2.0

contractTime Integer N Traffic expiration time

Code example
POST /v1/api/collectorDetail
Connection: keep-alive
Date: Tue, 27 Jun 2023 06:15:09 GMT
Content-MD5: qycSZycxVX/XDeFD5Ek1eA==
Authorization:API
1300386381676644416:cWtufLl7zXVVM264SRjBuTJUDVc=
Content-Type: application/json;charset=UTF-8
Request parameters
Content-Length: 26
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"id": "",
"sn": "404314859"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"id": "1306858901386141423",
"sn": "404314859",
"model": "",
"stationId": "1298491919448631809",
"version": "0",
"actualNumber": 0,
"maximumNumber": 0,
"connectionOperator": "",
Return parameters "iccid": "",
"state": 1,
"factoryTime": "0",
"dataUploadCycle": 0,
"currentWorkingTime": "0",
"totalWorkingTime": "0",
"gprsPackage": "A",
"dataTimestamp": "1687846165000",
"rssiLevel": 0,
"timeZone": 10.00,
"daylight": 0,
"timeZoneStr": "UTC+10:00"
}
}

- 52 -
 SolisCloud Platform API Document V2.0

3.12 Obtaining Single Collector Signal Values

Interface Name Obtaining Single Collector Signal Values
Interface Description Corresponding SolisCloud Platform Collector Signal Chart.
Request URL https://www.soliscloud.com:13333/v1/api/collector/day
Interface frequency
2 times/sec
limit
Request parameters [Body]
Data
Parameter Name Required Description
Type
sn String Y Query the information of the specified collector SN
Query information for a specified date, for example:
time String Y
yyyy-MM-dd
timeZone number Y The time zone where the device is located. Example: 8
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent failure.
code String Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
collectorId number N Collector ID
collectorSn String N Collector SN
Data update time under UTC+8. The format is a
dataTimestamp number N
timestamp.
Update time, string converted based on the time zone
timeStr String N
of the collector
pec number N Signal strength percentage, in%
rssi number N Signal strength value
rssiLevel number N Signal strength level
Code example
POST /v1/api/collector/day
Connection: keep-alive
Date: Wed, 28 Jun 2023 06:42:38 GMT
Content-MD5: YyrTpXdCTJN377g1hYLcJw==
Authorization:API
1300386381676644416:k+aaQOt5Tr3M4YmLpKjJUoQgum4=
Request parameters
Content-Type: application/json;charset=UTF-8
Content-Length: 45
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"sn": "FFC11553396",

- 53 -
 SolisCloud Platform API Document V2.0

"time": "2023-05-22"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": [
{
"dataTimestamp": "1687899787000",
"timeStr": "05:03:07",
"daylight": 0,
"daylightSwitch": 0,
"collectorId": "1306858901386141423",
"collectorSn": "404314859",
"rssiLevel": 0,
"rssi": 0,
"lac": "0.0",
"pec": 0,
Return parameters "collectorMode": 0
},
{
"dataTimestamp": "1687900091000",
"timeStr": "05:08:11",
"daylight": 0,
"daylightSwitch": 0,
"collectorId": "1306858901386141423",
"collectorSn": "404314859",
"rssiLevel": 0,
"rssi": 0,
"lac": "0.0",
"pec": 0,
"collectorMode": 0
}
]
}

3.13 Obtain EPM list under account

Interface Name Obtain EPM list under account

- 54 -
 SolisCloud Platform API Document V2.0

Interface Description Corresponding SolisCloud Platform EPM List.

Request URL https://www.soliscloud.com:13333/v1/api/epmList
Interface frequency
2 times/sec
limit
Request parameters [Body]
Data
Parameter Name Required Description
Type
Specify the number of page numbers to return. The
pageNo number Y
default value is 1, representing page 1.
Specify the number of returns per page. The default
pageSize number Y
value is 20, and the maximum value is 100.
1. Specify stationId to represent the information under
this power station, which can be obtained from the list
stationId String N of power stations.
2. If this value is blank, it represents querying all
information under the account.
1. Specify nmiCode to represent the information
under this nmi, which can be obtained from the list of
nmiCode String N power plants.
2. If this value is blank, it represents querying the
information under the account.
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent failure.
code String Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
page Object Y result list
total Integer Y Total number of lists
records Array Y Array of record
id number Y EPM_Id
sn String Y EPM_SN
collectorId number N Collector ID
collectorSn String N Collector SN
userId number N Owner ID
stationId number N Station ID
stationName String N Name of station
state number N EPM device status: 1=online, 2=offline
Data update time under UTC+8. The format is a
dataTimestamp number N
timestamp.
failSafe number N FailSafe switch

- 55 -
 SolisCloud Platform API Document V2.0

pEpmTotal number N EPM total power

pEpmTotalStr String N Unit of EPM total power
eTotalBuy number N Total purchase energy of grid
eTotalBuyStr String N Unit of total energy volume of grid
eTotalSell number N Total selling energy of grid
eTotalSellStr String N Unit of total selling energy of grid
Code example
POST /v1/api/epmList
Connection: keep-alive
Date: Wed, 28 Jun 2023 02:35:23 GMT
Content-MD5: eJ3ZPauZc7s2G8vzz8U66Q==
Authorization:API
1300386381676644416:tlS4UEPtWVCA0/qdhKThq9A7BH8=
Content-Type: application/json;charset=UTF-8
Content-Length: 89
Request parameters
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"pageNo": "1",
"pageSize": "100",
"stationId": "1298491919448631809",
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"epmStatusVo": {
"all": 20,
"normal": 1,
"fault": 0,
"offline": 19,
Return parameters
"mppt": 0
},
"page": {
"records": [
{
"id": "1306507149505459510",
"sn": "00FFC0011557002",
"collectorId": "1306858901386142611",
"collectorSn": "FFC00115570",
"simFlowState": -4,

- 56 -
 SolisCloud Platform API Document V2.0

"stationId": "1298491919448631809",
"state": 1,
"stateExceptionFlag": 0,
"dataTimestamp": "1687918466519",
"dataTimestampStr": "2023-06-28 12:14:26
(UTC+10:00)",
"failSafe": 0,
"pEpmTotal": 3.900,
"pEpmTotalStr": "kW",
"eTotalBuy": 8.519,
"eTotalBuyStr": "MWh",
"eTotalSell": 8.819,
"eTotalSellStr": "MWh",
"pLimit": 90.190,
"timeZone": 10.00,
"timeZoneStr": "(UTC+10:00)",
"timeZoneName": "(UTC+10:00) ",
"idStr": "1306507149505459510"
}
],
"total": 1,
"size": 100,
"current": 1,
"orders": [ ],
"optimizeCountSql": false,
"searchCount": true,
"pages": 1
}
}
}

3.14 Obtaining Details of a Single EPM

Interface Name Obtaining Details of a Single EPM
Interface Description Corresponding SolisCloud Platform EPM Details
Request URL https://www.soliscloud.com:13333/v1/api/epmDetail
Interface frequency
2 times/sec
limit
Request parameters [Body]
Data
Parameter Name Required Description
Type
sn String Y Specify to query a certain EPM
Return parameters [Body]
Data
Parameter Name Required Description
Type

- 57 -
 SolisCloud Platform API Document V2.0

0 represents success, while others represent failure.

code String Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
id number Y EPM_Id
sn String Y EPM_SN
collectorId number N Collector ID
collectorSn String N Collector SN
userId number N Owner ID
stationId number N Station ID
stationName String N Name of station
state number N EPM status: 1=online, 2=offline
Data update time under UTC+8. The format is a
dataTimestamp number N
timestamp.
failSafe number N FailSafe switch
empSoftwareVersion String N EPM software version
pLimit number N Power limit percentage
ctRatio number N Current sensor ratio
pSet number N Return power setting value
pSetStr String N Unit of return power setting value
pInverterTotal number Total power of inverter
pInverterTotalStr String Unit of total power of inverter
eToaalInverter number Total generation energy of inverter
eToaalInverterStr String Unit of total generation energy of inverter
pLoad number Total power consumption
pLoadStr String Unit of total power consumption
eTotalLoad number Total energy consumption
eTotalLoadStr String Unit of total energy consumption
pEpmTotal number N EPM total power
pEpmTotalStr String N Unit of EPM total power
eTotalBuy number N Total purchased energy
eTotalBuyStr String N Unit of total purchased energy
eTotalSell number N Total sell energy
eTotalSellStr String N Unit of total sell energy
iAc1 number N Current U
iAc2 number N Current V
iAc3 number N Current W
uAc1 number N Voltage U
uAc2 number N Voltage V
uAc3 number N Voltage W

- 58 -
 SolisCloud Platform API Document V2.0

pAc1 number N Power U

pAc2 number N Power V
pAc3 number N Power W
powerFactor number N Power factor
facMeter number N Grid frequency
Code example
POST /v1/api/epmDetail
Connection: keep-alive
Date: Wed, 28 Jun 2023 02:35:23 GMT
Content-MD5: eJ3ZPauZc7s2G8vzz8U66Q==
Authorization:API
1300386381676644416:tlS4UEPtWVCA0/qdhKThq9A7BH8=
Request parameters Content-Type: application/json;charset=UTF-8
Content-Length: 89
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"sn": "00FFC0011557002"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"id": "1306507149505459510",
"sn": "00FFC0011557002",
"collectorSn": "FFC00115570",
"collectorId": "1306858901386142611",
"stationId": "1298491919448631809",
"stationType": 0,
"stationTypeNew": 3,
Return parameters
"epmType": 1,
"synchronizationType": 0,
"gridSwitch1": 0,
"sno": "1085AC",
"timeZone": 10.00,
"timeZoneStr": "UTC+10:00",
"daylight": 0,
"state": 1,
"stateExceptionFlag": 0,
"epmDataTime": "1624959259",
"dataTimestamp": "1687918466519",
"rs485ComAddr": "101",

- 59 -
 SolisCloud Platform API Document V2.0

"empSoftwareVersion": 1,
"uAc1": 901.900,
"uAc1Str": "V",
"iAc1": 901.900,
"iAc1Str": "A",
"pAc1": 901900.000,
"pAc1Str": "W",
"uAc2": 901.900,
"uAc2Str": "V",
"iAc2": 901.900,
"iAc2Str": "A",
"pAc2": 901900.000,
"pAc2Str": "W",
"uAc3": 901.900,
"uAc3Str": "V",
"iAc3": 901.900,
"iAc3Str": "A",
"pAc3": 901900.000,
"pAc3Str": "W",
"pEpmTotal": 3.900,
"pEpmTotalStr": "kW",
"pInverterTotal": 2.200,
"pInverterTotalStr": "kW",
"inverterModel": 1,
"pLimit": 90.190,
"ctRatio": 9019.000,
"pSet": 901.900,
"pSetStr": "kW",
"inverterNum": 1,
"failSafe": 0,
"powerFactor": 90.190,
"facMeter": 90.190,
"pLoad": 3.400,
"pLoadStr": "kW",
"eToaalInverter": 24.019,
"eToaalInverterStr": "MWh",
"eTotalLoad": 5.219,
"eTotalLoadStr": "MWh",
"eTotalBuy": 8.519,
"eTotalBuyStr": "MWh",
"eTotalSell": 8.819,
"eTotalSellStr": "MWh",
"tag": "zhichuan",
"epmModel": "0",

- 60 -
 SolisCloud Platform API Document V2.0

"pEpmTotalOrigin": 3900,
"pEpmTotalPec": "1",
"pInverterTotalOrigin": 2200,
"pLoadOrigin": 3400,
"pSetOrigin": 901900,
"eToaalInverterOrigin": 24019,
"eTotalLoadOrigin": 5219,
"eTotalBuyOrigin": 8519,
"eTotalSellOrigin": 8819
}
}

3.15 Obtain real-time data of a single EPM on a certain day

Interface Name Obtain real-time data of a single EPM on a certain day
Interface
Corresponding SolisCloud Platform EPM Daily Chart
Description
Request URL https://www.soliscloud.com:13333/v1/api/epm/day
Interface
2 times/sec
frequency limit
Request parameters [Body]
Parameter Data Requi
Description
Name Type red
sn String Y EPM_SN
Query fields, separated by commas for multiple queries:
u_ac1=Voltage U, u_ac2=Voltage V, u_ac3=Voltage W
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
searchinfo String Y fac_meter=Grid frequency (Meter)
p_load=total power of the load
e_total_inverter=total output of the inverter
e_total_load=total power consumption of the load
e_total_buy=total electricity purchased
e_total_sell=total electricity sold
time String Y Specify to query data for a certain day, format: yyyy-MM-dd
timeZone number Y The time zone where the device is located. Example: 8
Return parameters [Body]
Parameter Data Requi
Description
Name Type red
0 represents success, while others represent failure. The
code String Y
failure code is detailed in Appendix 1.
msg String Y Description of code values
data Array Y Data identification

- 61 -
 SolisCloud Platform API Document V2.0

dataTimestamp number Y Data update time under UTC+8. The format is a timestamp.
timeStr String Y Update time, string converted based on time zone
Total power of grid, where a negative value represents buying
pEpmTotal number N electricity and a positive value represents selling electricity.
Transmit e_epm_total acquisition
pEpmTotalStr String N Unit of total power of grid
pEpmTotalPec number N Percentage of total power of grid
eTotalBuy number N Total active energy from grid, transmission e_total_buy Get
Total active energy transmitted by the power grid,
eTotalSell number N
transmission e_total_sell acquisition
uAc1 number N EPM AC voltage U, transmission u_ac1 acquisition
iAc1 number N EPM AC current U, transmission i_ac1 acquisition
pAc1 number N EPM active power U, transmission p_ac1 acquisition
uAc2 number N EPM AC voltage V, transmission u_ac2 acquisition
iAc2 number N EPM AC current V, transmission i_ac2 acquisition
pAc2 number N EPM active power V, transmission p_ac2 acquisition
uAc3 number N EPM AC voltage W, transmission u_ac3 acquisition
iAc3 number N EPM AC current W, transmission i_ac3 acquisition
pAc3 number N EPM active power W, transmission p_ac3 acquisition
Total power of inverter, transmission p_inverter_total
pInverterTotal number N
acquisition
pLimit number N Power limit percentage, transmission p_limit acquisition
ctRatio number N Current sensor ratio, transmission ct_ratio acquisition
powerFactor number N Power factor of grid, transmission power_factor acquisition
facMeter number N Grid frequency, transmission fac_meter acquisition
pLoad number N Total load power, transmission p_load acquisition
Total generation of the inverter, transmission e_toaal_inverter
eToaalInverter number N
acquisition
Total consumption of the load, transmission e_total_load
eTotalLoad number N
acquisition
Code example
POST /v1/api/day
Connection: keep-alive
Time: Wed, 28 Jun 2023 02:41:59 GMT
Content-MD5: P3y0vBtI9DkzBxNo6BXInw==
Content-Type: application/json
Request
Authorization:API 1300386381676644416:eSyNqUbYhu5z80vIKiFxMr3poNY=
parameters
token:
Date: Wed, 28 Jun 2023 02:41:59 GMT
Content-Length: 111
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)

- 62 -
 SolisCloud Platform API Document V2.0

{
"sn": "00FFC0011557002",
"searchinfo": "u_ac1,u_ac2,e_total_buy,e_total_sell",
"time": "2023-06-27",
"timeZone": "8"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"daylightList": [ ],
"e_total_buy": [ ],
Return
"u_ac1": [ ],
parameters
"data_timestamp": [ ],
"timeStr": [ ],
"u_ac2": [ ],
"daylightSwitch": 0,
"e_total_sell": [ ]
}
}

3.16 Obtaining Daily Data of a Single EPM for a Month

Interface Name Obtaining Daily Data of a Single EPM for a Month
Interface Description Corresponding SolisCloud Platform EPM Monthly Chart
Request URL https://www.soliscloud.com:13333/v1/api/epm/month
Interface frequency
2 times/sec
limit
Request parameters [Body]
Data
Parameter Name Required Description
Type
sn String Y EPM_SN
Specify to query data for a certain month,
month String Y
format: yyyy-MM
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent
code String Y failure. The failure code is detailed in Appendix
1.
msg String Y Description of code values
data Array Y Data identification
date number Y Data, format timestamp

- 63 -
 SolisCloud Platform API Document V2.0

dateStr String Y Data, format string

energy number N Power generation
epmSellEnergy number N Sell Energy of EPM
epmBuyEnergy number N Buy Energy of EPM
Code example
POST /v1/api/month
Connection: keep-alive
Time: Wed, 28 Jun 2023 02:41:59 GMT
Content-MD5: P3y0vBtI9DkzBxNo6BXInw==
Content-Type: application/json
Authorization:API
1300386381676644416:eSyNqUbYhu5z80vIKiFxMr3poNY=
token:
Request parameters
Date: Wed, 28 Jun 2023 02:41:59 GMT
Content-Length: 111
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.18)
{
"sn": "00FFC0011557002",
"month": "2023-06"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": [
{
"id": "1306507149539028553",
"money": 0.000,
"energy": 0.000,
"energyStr": "kWh",
"energyPec": "1",
Return parameters "epmSellEnergy": 0,
"epmBuyEnergy": 0,
"date": 1687924800000,
"dateStr": "2023-06-28",
"timeZone": 8,
"gridPurchasedEnergy": 0,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0,
"gridSellIncome": 0.000,
"consumeEnergy": 0,
"produceEnergy": 0,
"offSetEnergy": 0,

- 64 -
 SolisCloud Platform API Document V2.0

"offSetIncome": 0,
"errorFlag": 0
}
]
}

3.17 Obtaining Monthly Data of a Single EPM for a Certain Year

Interface Name Obtaining Monthly Data of a Single EPM for a Certain Year
Interface Description Corresponding SolisCloud Platform EPM Annual Chart
Request URL https://www.soliscloud.com:13333/v1/api/epm/year
Interface frequency
2 times/sec
limit
Request parameters [Body]
Data
Parameter Name Required Description
Type
sn String Y EPM_SN
year String Y Specify to query data for a certain year, format: yyyy
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent failure.
code String Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Array Y Data identification
Data update time under UTC+8. The format is a
date number Y
timestamp.
dateStr String Y Data, format string
energy number N Power generation
epmSellEnergy number N Sell Energy of EPM
epmBuyEnergy number N Buy Energy of EPM
Code example
POST /v1/api/year
Connection: keep-alive
Time: Wed, 28 Jun 2023 02:41:59 GMT
Content-MD5: P3y0vBtI9DkzBxNo6BXInw==
Content-Type: application/json
Authorization:API
Request parameters
1300386381676644416:eSyNqUbYhu5z80vIKiFxMr3poNY=
token:
Date: Wed, 28 Jun 2023 02:41:59 GMT
Content-Length: 111
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.18)

- 65 -
 SolisCloud Platform API Document V2.0

{
"sn": "00FFC0011557002",
"year": "2023"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": [
{
"id": "1306507149551593479",
"money": 0.000,
"energy": 0.000,
"energyStr": "kWh",
"energyPec": "1",
"epmSellEnergy": 0,
"epmBuyEnergy": 0,
"date": 1685592000000,
Return parameters
"dateStr": "2023-06",
"timeZone": 8,
"gridPurchasedEnergy": 0,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0,
"gridSellIncome": 0.000,
"consumeEnergy": 0,
"produceEnergy": 0,
"offSetEnergy": 0,
"offSetIncome": 0,
"errorFlag": 0
}
]
}

3.18 Obtaining Annual Data for a Single EPM

Interface Name Obtaining Annual Data for a Single EPM
Interface Description Corresponding SolisCloud Platform EPM Overall Chart
Request URL https://www.soliscloud.com:13333/v1/api/epm/all
Interface frequency
2 times/sec
limit
Request parameters [Body]
Data
Parameter Name Required Description
Type
sn String Y EPM_SN
Return parameters [Body]

- 66 -
 SolisCloud Platform API Document V2.0

Data
Parameter Name Required Description
Type
0 represents success, while others represent failure.
code String Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Array Y Data identification
year number Y Year
energy number N Power generation
epmSellEnergy number N Sell Energy of EPM
epmBuyEnergy number N Buy Energy of EPM
Code example
POST /v1/api/epm/all
Connection: keep-alive
Time: Wed, 28 Jun 2023 02:46:19 GMT
Content-MD5: TopIFbbEpLD0N0xViocHCw==
Content-Type: application/json
Authorization:API
1300386381676644416:6IlPSU37PZ0+0UnjQ8NE4DTLYFI=
Request parameters token:
Date: Wed, 28 Jun 2023 02:46:19 GMT
Content-Length: 24
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"sn": "00FFC0011557002"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": [
{
"id": "1306507149559981588",
"money": 0.000,
Return parameters "energy": 0.000,
"energyStr": "kWh",
"energyPec": "1",
"epmSellEnergy": 0,
"epmBuyEnergy": 0,
"year": 2023,
"timeZone": 8,
"gridPurchasedEnergy": 0,
"gridPurchasedIncome": 0.000,

- 67 -
 SolisCloud Platform API Document V2.0

"gridSellEnergy": 0,
"gridSellIncome": 0.000,
"consumeEnergy": 0,
"produceEnergy": 0,
"offSetEnergy": 0,
"offSetIncome": 0,
"errorFlag": 0
}
]
}

3.19 Obtain a list of meteorological instruments under the account

Interface Name Obtain a list of meteorological instruments under the account
Interface Description List of meteorological instruments corresponding to SolisCloud platform
Request URL https://www.soliscloud.com:13333/v1/api/weatherList
Interface frequency
2 times/sec
limit
Request parameters [Body]
Data
Parameter Name Required Description
Type
Specify the number of page numbers to return. The
pageNo number Y
default value is 1, representing page 1.
Specify the number of returns per page. The default
pageSize number Y
value is 20, and the maximum value is 100.
1. Specify stationId to represent the information under
this power station, which can be obtained from the list
stationId number N of power stations.
2. If this value is blank, it represents querying all
information under the account.
1. Specify nmiCode to represent the information under
this nmi, which can be obtained from the list of power
nmiCode String N plants.
2. If this value is blank, it represents querying the
information under the account.
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent failure. The
code String Y
failure code is detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
page Object Y result list
total Integer Y Total number of lists

- 68 -
 SolisCloud Platform API Document V2.0

records Array Y Array of record

id number Y Meteorological instrument ID
collectorSn String N Collector SN
collectorId number N Collector ID
name String N Meteorological instrument name
Meteorological instrument model: 1=Jinzhou Sunshine,
weatherModel String N
2=Jinzhou Licheng
userId number N Owner ID
stationId number N Station ID
stationName String N Name of station
state number N Meteorological instrument status: 1=online, 2=offline
Data update time under UTC+8. The format is a
dataTimestamp number N
timestamp.
totalR number N Total radiation, unit W/㎡
directR number N Direct radiation, unit W/㎡
scatteredR number N Scattered radiation, unit W/㎡
sunshineTim number N Sunlight duration, unit m
totalRday number N Total radiation daily accumulation, unit MJ/㎡
directRday number N Direct radiation daily accumulation, unit MJ/㎡
scatteredRday number N Accumulated daily scattered radiation,unit MJ/㎡
temp number N Temperature, unit taken as temperatureUnit
temperatureUnit String N temperature unit
humidity number N Humidity,unit %RH
windDirection number N wind direction
windSpeed number N Wind speed, unit m/s
airPressure number N Air pressure, unit Pa
rainfall number N Rainfall, unit mm
pvTemp number N Component temperature, unit taken as temperatureUnit
Code example
POST /v1/api/weatherList
Connection: keep-alive
Date: Wed, 28 Jun 2023 06:42:38 GMT
Content-MD5: YyrTpXdCTJN377g1hYLcJw==
Authorization: API
1300386381676644416:k+aaQOt5Tr3M4YmLpKjJUoQgum4=
Request parameters
Content-Type: application/json;charset=UTF-8
Content-Length: 45
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"pageNo": "1",

- 69 -
 SolisCloud Platform API Document V2.0

"pageSize": "20",
"stationId":"1306858901386142072"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"page": {
"records": [
{
"id": "1306858901386142611",
"createDate": 1687918406814,
"stationId": "1298491919448631809",
"stationName": "AC显示储能中试设备测试",
"temperatureUnit": "℉",
"collectorId": "1306858901386142611",
"simFlowState": -4,
"isRealtime": 0,
"rs485ComAddr": "3039",
"dataTime": "1630473850",
"weatherModel": "2",
"windSpeed": 1.2,
Return parameters "windDirection": 12,
"pvTemp": 36.1,
"temp": 36.0,
"humidity": 0.2,
"totalR": 834,
"scatteredR": 3389,
"directR": 3389,
"totalRday": 5.24,
"scatteredRday": 2.38,
"directRday": 3.38,
"rainfall": 0.1,
"dewTemp": 100.09,
"airPressure": 10.0,
"sunshineTim": 5.83,
"dataTimestamp": "1687918466519",
"dataTimestampStr": "2023-06-28 12:14:26
(UTC+10:00)",
"dataCleaningState": 2,
"collectorSn": "FFC00115570",
"state": 2,
"stateExceptionFlag": 0,

- 70 -
 SolisCloud Platform API Document V2.0

"timeZone": 10.00,
"timeZoneStr": "(UTC+10:00)",
"timeZoneName": "(UTC+10:00) ",
"sunshineTimStr": "5h50m"
}
],
"total": 1,
"size": 20,
"current": 1,
"orders": [ ],
"optimizeCountSql": false,
"searchCount": true,
"pages": 1
}
}
}

3.20 Obtaining Details of a Single Meteorological Instrument

Interface Name Obtaining Details of a Single Meteorological Instrument
Interface Description Corresponding SolisCloud platform meteorological instrument details
Request URL https://www.soliscloud.com:13333/v1/api/weatherDetail
Interface frequency
2 times/sec
limit
Request parameters [Body]
Data
Parameter Name Required Description
Type
sn String N Meteorological instrument SN
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent failure. The
code String Y
failure code is detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
id number Y Meteorological instrument ID
collectorSn String N Collector SN
collectorId number N Collector ID
name String N Meteorological instrument name
Meteorological instrument model: 1=Jinzhou Sunshine,
weatherModel String N
2=Jinzhou Licheng
userId number N Owner ID
stationId number N Station ID
stationName String N Name of station

- 71 -
 SolisCloud Platform API Document V2.0

state number N Meteorological instrument status: 1=online, 2=offline

Data update time under UTC+8. The format is a
dataTimestamp number N
timestamp.
totalR number N Total radiation, unit W/㎡
directR number N Direct radiation, unit W/㎡
scatteredR number N Scattered radiation, unit W/㎡
sunshineTim number N Sunlight duration, unit m
totalRday number N Total radiation daily accumulation, unit MJ/㎡
directRday number N Direct radiation daily accumulation, unit MJ/㎡
scatteredRday number N Accumulated daily scattered radiation,unit MJ/㎡
temp number N Temperature, unit taken as temperatureUnit
temperatureUnit String N temperature unit
humidity number N Humidity,unit %RH
windDirection number N wind direction
windSpeed number N Wind speed, unit m/s
airPressure number N Air pressure, unit Pa
rainfall number N Rainfall, unit mm
pvTemp number N Component temperature, unit taken as temperatureUnit
Code example
POST /v1/api/weatherDetail
Connection: keep-alive
Date: Wed, 28 Jun 2023 06:42:38 GMT
Content-MD5: YyrTpXdCTJN377g1hYLcJw==
Authorization:API
1300386381676644416:k+aaQOt5Tr3M4YmLpKjJUoQgum4=
Request parameters Content-Type: application/json;charset=UTF-8
Content-Length: 45
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"sn": "FFC00115570"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
Return parameters
"collectorId": "1306858901386142611",
"simFlowState": -4,
"stationId": "1298491919448631809",
"stationName": "123",
"stationType": 0,

- 72 -
 SolisCloud Platform API Document V2.0

"stationTypeNew": 3,
"synchronizationType": 0,
"gridSwitch1": 0,
"sno": "1085AC",
"timeZone": 10.00,
"timeZoneStr": "UTC+10:00",
"daylight": 0,
"daylightSwitch": 0,
"epmType": 1,
"isRealtime": 0,
"rs485ComAddr": "3039",
"dataTime": "1630473850",
"weatherModel": "2",
"windSpeed": 1.2,
"windDirection": 12,
"pvTemp": 36.1,
"temp": 36.0,
"temperatureUnit": "℉",
"humidity": 0.2,
"totalR": 834,
"scatteredR": 3389,
"directR": 3389,
"totalRday": 5.24,
"scatteredRday": 2.39,
"directRday": 3.39,
"rainfall": 0.1,
"dewTemp": 100.10,
"airPressure": 10.0,
"windSpeed2": 12.20,
"windSpeed10": 14.20,
"sunshineTim": 5.83,
"dataTimestamp": "1687918466519",
"dataCleaningState": 2,
"collectorSn": "FFC00115570",
"state": 2,
"stateExceptionFlag": 0,
"sunshineTimStr": "5h50m"
}
}

4 PLANT INTERFACE
4.1 Obtain the list of power stations under the account
Interface Name Obtain the list of power stations under the account

- 73 -
 SolisCloud Platform API Document V2.0

Interface Description Corresponding SolisCloud Platform Power Station List

请 URL https://www.soliscloud.com:13333/v1/api/userStationList
Interface frequency limit 2 times/sec
Request parameters [Body]
Req
Data
Parameter Name uire Description
Type
d
Specify the number of page numbers to return.
pageNo number Y
The default value is 1, representing page 1.
Specify the number of returns per page. The
pageSize number Y default value is 20, and the maximum value is
100.
1. Specify nmiCode to represent the information
under this nmi, which can be obtained from the
nmiCode String N list of power plants.
2. If this value is blank, it represents querying all
information under the account.
Return parameters [Body]
Req
Data
Parameter Name uire Description
Type
d
0 represents success, while others represent
code String Y
failure. The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
page Object Y Paging Object
current number Y Current page
pages number Y Total pages
size number Y Maximum number of entries per page
total number Y Total number
records array Y Array of record
id number N Station ID
stationName String N Name of station
addr String N Station address
userId number N Owner ID
capacity Number N Installed capacity
capacityStr String N Unit of Installed capacity
capacity1 Number N Installed capacity of plant, without carrying
Full power hours, power generation divided by
fullHour Number N
Installed capacity
picName String N Picture name
installerId number N Installer Id

- 74 -
 SolisCloud Platform API Document V2.0

installer String N Installer

installerMobile String N Installer Mobile
installerEmail String N Installer Email
sno String N Plant sno
dip Number N Component inclination angle
azimuth Number N Component azimuth
timeZone Number N Time Zone
timeZoneName String N Time Zone Name
timeZoneStr String N Time zone in string format
timeZoneId number N Time Zone Id
daylight Number N daylight saving time
createDate number N Date of data creation
price Number N Revenue per kWh
module number N Number of components
pic1Url String N Power Station Photo URL
power Number N Power
powerStr String N Unit of power
dayEnergy Number N Daily power generation
dayEnergyStr String N Unit of daily power generation
dayIncome Number N Daily Income
dayIncomeUnit String N Unit of daily Income
monthEnergy Number N Monthly Energy
monthEnergyStr String N Unit of monthly Energy
yearEnergy Number N Yearly Energy
yearEnergyStr String N Unit of yearly energy
allEnergy Number N Total power generation
allEnergyStr String N Unit of total power generation
allEnergy1 Number N Accumulated energy raw value
allIncome Number N Total Income
allIncomeUnit String N Unit of total income
Grid connection type: 0=Full online, 1=Self use,
synchronizationType number N
2=Off grid
stationTypeNew number N Type of power station, see Appendix 2 for details
batteryTotalDischargeEnergy Number N Total battery discharging energy
batteryTotalChargeEnergy Number N Total battery charging energy
gridPurchasedTotalEnergy Number N Total grid purchased energy
gridSellTotalEnergy Number N Total grid selling energy
homeLoadTotalEnergy Number N Total load consumption
oneSelf Number N Self use
batteryTodayDischargeEnergy Number N Daily battery discharging energy

- 75 -
 SolisCloud Platform API Document V2.0

batteryTodayChargeEnergy Number N Daily battery charging energy

gridPurchasedTodayEnergy Number N Daily grid purchased energy
gridSellTodayEnergy Number N Daily grid selling energy
homeLoadTodayEnergy Number N Daily load consumption
money String N Used to calculate revenue, e.g. EUR, CNY
fisPowerTime number N First power on time, format timestamp
fisGenerateTime number N First generation time, format timestamp
remark1 String N Remark 1
remark2 String N Remark 2
remark3 String N Remark 3
state number N Plant station status: 1=online, 2=offline, 3=alarm
Data update time under UTC+8. The format is a
dataTimestamp number N
timestamp.
inverterPower String N Total rated power of inverter
nmiCode String N NMI Code
stationStatusVo Object N Power station status object
all number N Total number of power stations
normal number N Number of normal power stations
offline number N Number of offline power stations
fault number N Number of faulty power stations
Code example
POST /v1/api/userStationList
Connection: keep-alive
Date: Wed, 31 May 2023 09:12:23 GMT
Content-MD5: nyUAGqC1qeRnZ4vvgxK2ow==
Authorization: API 1300386381676565707:PqHiyhsQ8BILCrfIHshkS
ue5yzg=
Content-Type: application/json;charset=UTF-8
Request parameters Content-Length: 70
Host: www.soliscloud.com:13333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"pageNo": 1,
"pageSize": 10,
"nmiCode": ""
}
{
"code": "0",
"msg": "success",
Return parameters
"data": {
"stationStatusVo": {
"all": 0,

- 76 -
 SolisCloud Platform API Document V2.0

"normal": 0,
"fault": 0,
"offline": 0,
"building": 0,
"mppt": 0
},
"page": {
"records": [ ],
"total": 0,
"size": 10,
"current": 1,
"orders": [ ],
"optimizeCountSql": false,
"searchCount": true,
"pages": 0
},
"mpptSwitch": 0
}
}

4.2 Obtaining Details of Individual Power Stations

Interface Name 4.2 Obtaining Details of Individual Power Stations
Interface Description Corresponding SolisCloud Platform Power Station Details
Request URL https://www.soliscloud.com:13333/v1/api/stationDetail
Interface frequency limit 2 times/sec
Request parameters [Body]
Req
Data
Parameter Name uire Description
Type
d
id number Y Query the detailed data of the specified Station
ID or Station nmiCode, both ID and nmiCode
nmiCode String N
cannot be empty at the same time
Return parameters [Body]
Req
Data
Parameter Name uire Description
Type
d
0 represents success, while others represent
code String Y failure. The failure code is detailed in Appendix
1.
msg String Y Description of code values
data Object Y Data identification
id number Y Station ID
stationName number Y Name of station

- 77 -
 SolisCloud Platform API Document V2.0

addr String Y Station address

userId Integer Y Owner ID
capacity String N Installed capacity
capacityStr String N Unit of Installed capacity
dayEnergy Number N Daily power generation
dayEnergyStr String N Unit of daily power generation
monthEnergy Number N Monthly power generation
monthEnergyStr String N Unit of monthly power generation
yearEnergy Number N Yearly power generation
yearEnergyStr String N Unit of yearly power generation
allEnergy Number N Total power generation
allEnergyStr String N Unit of total power generation
dayInCome Number N Daily Income
dayInComeUnit String N Unit of daily Income
monthInCome Number N Monthly Income
monthInComeUnit String N Unit of monthly Income
yearInCome Number N Yearly Income
yearInComeUnit String N Unit of yearly Income
allInCome Number N Total Income
allInComeUnit String N Unit of total income
Full power hours, power generation divided by
fullHour Number N
Installed capacity
picName String N Picture name
power Number N Power
powerStr String N Unit of power
dip Number N Component inclination angle
azimuth Number N Component azimuth
price String N Revenue per kWh
state Integer N Plant station status: 1=online, 2=offline, 3=alarm
Data update time under UTC+8. The format is a
dataTimestamp Integer N
timestamp.
money String N Used to calculate revenue, e.g. EUR, CNY
brand String N Brand
condTxtN String N Night weather
condTxtD String N Daytime weather
tmpMax String N maximum temperature
tmpMin String N Lowest temperature
tmpUnit String N temperature unit
powerStationNumTree String N Equivalent Tree Planting
powerStationNumTreeUnit String N Unit of equivalent Tree Planting

- 78 -
 SolisCloud Platform API Document V2.0

powerStationAvoidedCo2 String N carbon dioxide emission reduction

powerStationAvoidedCo2Unit String N Units of reducing carbon dioxide emissions
module Integer N Number of components
installerEmail String N Installer Email
installerMobile Integer N Installer Mobile
batteryPower Number N Battery power
batteryPowerStr String N Unit of battery power
batteryPowerPec Number N Battery power percentage
batteryDischargeEnergy Number N Battery discharge energy
batteryDischargeEnergyStr String N Unit of battery discharge energy
batteryChargeEnergy Number N Battery charging energy
batteryChargeEnergyStr String N Unit of battery charging energy
batteryPercent Number N Battery SOC
psum Number N Total active power of the grid
psumStr String N Unit of total active power of the grid
Percentage of total active power of the power
psumPec Number N
grid
gridPurchasedDayEnergy Number N Daily energy purchased of grid
gridPurchasedDayEnergyStr String N Unit of daily energy purchased of grid
gridPurchasedMonthEnergy Number N Monthly energy purchased of grid
gridPurchasedMonthEnergyStr String N Monthly energy purchased of grid unit
gridPurchasedYearEnergy Number N Yearly energy purchased of grid
gridPurchasedYearEnergyStr String N Yearly energy purchased of grid unit
gridPurchasedTotalEnergy Number N Total energy purchased of grid
gridPurchasedTotalEnergyStr String N Total energy purchased of grid unit
gridSellDayEnergy Number N Daily energy sell of grid
gridSellDayEnergyStr String N Daily energy sell of grid unit
gridSellMonthEnergy Number N Monthly energy sell of grid
gridSellMonthEnergyStr String N Monthly energy sell of grid unit
gridSellYearEnergy Number N Yearly energy sell of grid
gridSellYearEnergyStr String N Yearly energy sell of grid unit
gridSellTotalEnergy Number N Total energy sell of grid
gridSellTotalEnergyStr String N Total energy sell of grid unit
familyLoadPower Number N Family load power
familyLoadPowerStr String N Unit of family load power
familyLoadPowerPec Number N Family load power percentage
homeLoadEnergy Number N Daily load energy
homeLoadEnergyStr String N Daily load energy unit
inverterPower String N Total rated power of inverter
nmiCode String N NMI Code

- 79 -
 SolisCloud Platform API Document V2.0

dip Number N Component inclination angle

azimuth Number N Component azimuth
The time zone where the device is located.
timeZone Number N
Example: 8
timeZoneName String N Time Zone Name
timeZoneStr String N Time zone in string format
timeZoneId Integer N Time Zone Id
daylight Number N daylight saving time
createDate Integer N Date of data creation
stationTypeNew Integer N Type of power station, see Appendix 2 for details
fisPowerTime Integer N First power on time, format timestamp
fisGenerateTime Integer N First generation time, format timestamp
Code example
POST /v1/api/stationDetail
Connection: keep-alive
Time: Tue, 27 Jun 2023 05:47:26 GMT
Content-MD5: sAGxE9QzeBN88qPrz+sCZQ==
Content-Type: application/json
Authorization:API
1300386381676644416:SCITzMk7U3gKp05S+d7ETIvyq4g=
token: token_cb23ed9a-ab65-4699-b942-6efbf3a6e666
Request parameters
Date: Tue, 27 Jun 2023 05:47:26 GMT
Content-Length: 30
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"id": "1298491919448631809",
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"id": "1298491919448631809",
"dataTimestamp": "1687844402978",
Return parameters
"fullHour": 2.61,
"monthCarbonDioxide": 69.92,
"installerId": "1298497302686786165",
"installer": "",
"sno": "1085AC",
"country": "15",
"countryStr": "",

- 80 -
 SolisCloud Platform API Document V2.0

"region": "423",
"regionStr": "",
"city": "11393",
"cityStr": "Forster",
"county": "11379",
"state": 1,
"dip": 30.0,
"azimuth": 0.0,
"power": 5.772,
"timeZone": 10.00,
"timeZoneName": "(UTC+10:00) ",
"timeZoneStr": "(UTC+10:00)",
"timeZoneId": "115",
"daylight": 0,
"powerStr": "kW",
"createDate": 1677119648000,
"createDateStr": "2023-02-23 12:34:08 (UTC+10:00)",
"price": 1.0000,
"capacity": 12.000,
"capacityStr": "kWp",
"capacityPercent": 0,
"capacity1": 0,
"dayEnergy": 31.300,
"dayEnergyStr": "kWh",
"monthEnergy": 839.000,
"monthEnergyStr": "kWh",
"yearEnergy": 5.603,
"yearEnergyStr": "MWh",
"allEnergy": 36.393,
"allEnergyStr": "MWh",
"allEnergy1": 36393.000,
"updateDate": 1687844137000,
"type": 0,
"synchronizationType": 0,
"epmType": 0,
"gridSwitch": 0,
"shareProcess": 1,
"dcInputType": 3,
"stationTypeNew": 0,
"gridPurchasedTotalEnergy": 0.000,
"gridSellTotalEnergy": 0.000,
"homeLoadTotalEnergy": 0.000,
"oneSelf": 0.00000,
"homeLoadTodayEnergy": 31.300,

- 81 -
 SolisCloud Platform API Document V2.0

"money": "AUD",
"condTxtD": "",
"condTxtN": "",
"condCodeD": "305",
"condCodeN": "305",
"simFlowState": -1,
"nmiCode": "41028459350",
"jxbType": 0,
"generateDays": 92,
"generateDaysContinuous": 90,
"inverterCount": 1,
"orgCode": "61BADD",
"visitorCount": 0,
"daylightSwitch": 0,
"daylightType": 1,
"fullHourStr": "h",
"capacityPec": "1",
"dipStr": "30.0°",
"azimuthStr": "0.0°",
"dateTime": "1677119648000",
"offset": 0,
"offsetStr": "kWh",
"dayInCome": 31.300,
"dayInComeUnit": "AUD",
"monthInCome": 839.000,
"monthInComeUnit": "AUD",
"yearInCome": 5.603,
"yearInComeUnit": "KAUD",
"allInCome": 36.393,
"allInCome1": 36393.000,
"allInComeUnit": "KAUD",
"powerStationNumTree": 36.39,
"powerStationNumTreeUnit": "棵",
"powerStationAvoidedCo2": 36.28,
"powerStationAvoidedCo2Unit": "t",
"powerPec": "1",
"porwerPercent": 0.4810,
"batteryPower": 0.000,
"batteryPowerStr": "kW",
"batteryPowerPec": "1",
"batteryPowerZheng": 0,
"batteryPowerFu": 0,
"batteryPercent": 0,
"familyLoadPercent": 0,

- 82 -
 SolisCloud Platform API Document V2.0

"psum": 5.772,
"psumStr": "kW",
"psumPec": "1",
"psumZheng": 5772.0,
"psumFu": 0,
"gridPurchasedTotalEnergyStr": "kWh",
"gridSellTotalEnergyStr": "kWh",
"gridPurchasedEnergy": 0.000,
"gridPurchasedEnergyStr": "kWh",
"gridSellEnergy": 0.000,
"gridSellEnergyStr": "kWh",
"gridPurchasedDayEnergy": 0.000,
"gridPurchasedDayEnergyStr": "kWh",
"gridSellDayEnergy": 0.000,
"gridSellDayEnergyStr": "kWh",
"gridPurchasedMonthEnergy": 0.000,
"gridPurchasedMonthEnergyStr": "kWh",
"gridSellMonthEnergy": 0,
"gridSellMonthEnergyStr": "kWh",
"gridPurchasedYearEnergy": 0.000,
"gridPurchasedYearEnergyStr": "kWh",
"gridSellYearEnergy": 0.000,
"gridSellYearEnergyStr": "kWh",
"batteryDischargeEnergy": 0.000,
"batteryDischargeEnergyStr": "kWh",
"batteryChargeEnergy": 0.000,
"batteryChargeEnergyStr": "kWh",
"batteryDischargeMonthEnergy": 0.000,
"batteryDischargeMonthEnergyStr": "kWh",
"batteryChargeMonthEnergy": 0.000,
"batteryChargeMonthEnergyStr": "kWh",
"batteryDischargeYearEnergy": 0.000,
"batteryDischargeYearEnergyStr": "kWh",
"batteryChargeYearEnergy": 0.000,
"batteryChargeYearEnergyStr": "kWh",
"batteryDischargeTotalEnergy": 0.000,
"batteryDischargeTotalEnergyStr": "kWh",
"batteryChargeTotalEnergy": 0.000,
"batteryChargeTotalEnergyStr": "kWh",
"familyLoadPower": 0.000,
"familyLoadPowerStr": "kW",
"familyLoadPowerPec": "1",
"homeGridTodayEnergy": 31.300,
"homeGridTodayEnergyStr": "kWh",

- 83 -
 SolisCloud Platform API Document V2.0

"homeGridMonthEnergy": 0.000,
"homeGridMonthEnergyStr": "kWh",
"homeGridYearEnergy": 0.000,
"homeGridYearEnergyStr": "kWh",
"homeGridTotalEnergy": 0,
"homeGridTotalEnergyStr": "kWh",
"backupTodayEnergy": 0.000,
"backupTodayEnergyStr": "kWh",
"backupMonthEnergy": 0.000,
"backupMonthEnergyStr": "kWh",
"backupYearEnergy": 0.000,
"backupYearEnergyStr": "kWh",
"backupTotalEnergy": 0,
"backupTotalEnergyStr": "kWh",
"totalLoadPower": 0.000,
"totalLoadPowerStr": "kW",
"bypassLoadPower": 0.000,
"bypassLoadPowerStr": "kW",
"homeLoadEnergy": 31.300,
"homeLoadEnergyStr": "kWh",
"homeLoadTodayEnergyStr": "kWh",
"homeLoadMonthEnergy": 0.000,
"homeLoadYearEnergy": 0.000,
"picUrl":
"https://solis-test.oss-eu-central-1.aliyuncs.com/STATION_default_us
er.png?Expires=1687915551&OSSAccessKeyId=LTAI5tDfhhsnNuC3
fr5HU1rK&Signature=5JAsyO8hbCzqfr1TJ2lvPkMhU%2Bw%3D",
"weather": "",
"sr": "06:19",
"ss": "18:26",
"tmpMax": "82.0",
"tmpMin": "30.0",
"tmpUnit": "℉",
"hum": "77",
"weatherUpdateDate": "1687828212000",
"weatherUpdateDateStr": "2023-06-27 11:10:12
(UTC+10:00)",
"pcpn": "80.0",
"pres": "1011",
"windSpd": "9.1",
"windDir": "SE",
"weatherType": 0,
"windSpeed": 0,
"windDirection": 0,

- 84 -
 SolisCloud Platform API Document V2.0

"humidity": 0,
"temp": 0,
"rainfall": 0,
"airPressure": 0,
"contribution": 0,
"screenMap": 0,
"screenGuideState": 0,
"storedInverterType": 0,
"powerGridAgent": "SAPN",
"countryShortName": "AU",
"inverterPower": 8.000,
"bypassAcOnoffSet": 0,
"priceMap": {
"sell": "1.0000",
"buy": "0"
},
"sysGridPriceList": [
{
"id": "6406",
"createDate": 1677119648000,
"updateDate": 1677119648000,
"deleteFlag": 0,
"unit": "AUD",
"type": 0,
"source": 0,
"sellBuy": 0,
"refId": "1298491919448631809",
"price": 1.0000
},
{
"id": "6412",
"createDate": 1677208349000,
"updateDate": 1677208349000,
"deleteFlag": 0,
"unit": "AUD",
"type": 0,
"source": 0,
"sellBuy": 1,
"refId": "1298491919448631809",
"price": 0.0000
}
],
"generatorPower": 0,
"generatorPowerStr": "kW",

- 85 -
 SolisCloud Platform API Document V2.0

"generatorPowerPec": "1",
"generatorTodayEnergy": 0.000,
"generatorTodayEnergyStr": "kW",
"generatorTodayEnergyPec": "1",
"generatorTotalEnergy": 0,
"generatorTotalEnergyStr": "kWh",
"generatorTotalEnergyPec": "1",
"weatherCount": 0,
"inverterPowerStr": "kW",
"homeLoadMonthEnergyStr": "kWh",
"homeLoadYearEnergyStr": "kWh",
"homeLoadTotalEnergyStr": "kWh",
"gridMonthEnergy": 0.000,
"monthEnergy1": 0,
"dayEnergy1": 0,
"yearEnergy1": 0,
"power1": 0
}
}

4.3 Obtaining Details of Multiple Power Stations

Interface Name Obtaining Details of Multiple Power Stations

Batch access to power station details on the corresponding SolisCloud
Interface Description
platform.
Request URL https://www.soliscloud.com:13333/v1/api/stationDetailList
Interface frequency limit 2 times/sec
Request parameters [Body]
Req
Parameter Name Data Type uire Description
d
Specify the number of page numbers to return. The
pageNo String N
default value is 1, representing page 1.
Specify the number of returns per page. The
pageSize Integereger Y
default value is 20, and the maximum value is 100.
Return parameters [Body]
Req
Parameter Name Data Type uire Description
d
0 represents success, while others represent
code String Y
failure. The failure code is detailed in Appendix 1.
msg String Y Description of code values
data array Y Data identification

- 86 -
 SolisCloud Platform API Document V2.0

id Integereger Y Station ID
stationName String N Name of station
addr String N Station address
userId Integereger N Owner ID
capacity String N Installed capacity
capacityStr String N Unit of Installed capacity
dayEnergy Number N Daily power generation
dayEnergyStr String N Unit of daily power generation
monthEnergy Number N Monthly power generation
monthEnergyStr String N Unit of monthly power generation
yearEnergy Number N Yearly power generation
yearEnergyStr String N Unit of yearly power generation
allEnergy Number N Total power generation
allEnergyStr String N Unit of total power generation
Full power hours, power generation divided by
fullHour Number N
Installed capacity
picName String N Picture name
power Number N Power
powerStr String N Unit of power
dip Number N Component inclination angle
azimuth String N Component azimuth
price Number N Revenue per kWh
state String N Plant station status: 1=online, 2=offline, 3=alarm
Data update time under UTC+8. The format is a
dataTimestamp Number N
timestamp.
money String N Used to calculate revenue, e.g. EUR, CNY
brand String N Brand
condTxtN String N Night weather
condTxtD Integer N Daytime weather
tmpMax Integereger N maximum temperature
tmpMin String N Lowest temperature
tmpUnit String N temperature unit
powerStationNumTree String N Equivalent Tree Planting
powerStationNumTreeUnit String N Unit of equivalent Tree Planting
powerStationAvoidedCo2 String N carbon dioxide emission reduction
powerStationAvoidedCo2Unit String N Units of reducing carbon dioxide emissions
module String N Number of components
installerEmail String N Installer Email
installerMobile String N Installer Mobile
batteryPower String N Battery power

- 87 -
 SolisCloud Platform API Document V2.0

batteryPowerStr String N Unit of battery power

batteryPowerPec String N Battery power percentage
batteryDischargeEnergy String N Battery discharge energy
batteryDischargeEnergyStr Integereger N Unit of battery discharge energy
batteryChargeEnergy Integereger N Battery charging energy
batteryChargeEnergyStr String N Unit of battery charging energy
batteryPercent Integereger N Battery SOC
psum Number N Total active power of the grid
psumStr String N Unit of total active power of the grid
psumPec Number N Percentage of total active power of the power grid
gridPurchasedDayEnergy Number N Daily energy purchased of grid
gridPurchasedDayEnergyStr String N Unit of daily energy purchased of grid
gridPurchasedMonthEnergy Number N Monthly energy purchased of grid
gridPurchasedMonthEnergyStr String N Monthly energy purchased of grid unit
gridPurchasedYearEnergy Number N Yearly energy purchased of grid
gridPurchasedYearEnergyStr Number N Yearly energy purchased of grid unit
gridPurchasedTotalEnergy String N Total energy purchased of grid
gridPurchasedTotalEnergyStr Number N Total energy purchased of grid unit
gridSellDayEnergy Number N Daily energy sell of grid
gridSellDayEnergyStr String N Daily energy sell of grid unit
gridSellMonthEnergy Number N Monthly energy sell of grid
gridSellMonthEnergyStr String N Monthly energy sell of grid unit
gridSellYearEnergy Number N Yearly energy sell of grid
gridSellYearEnergyStr String N Yearly energy sell of grid unit
gridSellTotalEnergy Number N Total energy sell of grid
gridSellTotalEnergyStr String N Total energy sell of grid unit
familyLoadPower Number N Family load power
familyLoadPowerStr String N Unit of family load power
familyLoadPowerPec Number N Family load power percentage
homeLoadEnergy String N Daily load energy
homeLoadEnergyStr Number N Daily load energy unit
inverterPower String N Total rated power of inverter
nmiCode Number N NMI Code
dip Integereger N Component inclination angle
azimuth String N Component azimuth
The time zone where the device is located.
timeZone Integereger N
Example: 8
timeZoneName String N Time Zone Name
timeZoneStr Integereger N Time zone in string format
timeZoneId String N Time Zone Id

- 88 -
 SolisCloud Platform API Document V2.0

daylight Integereger N daylight saving time

createDate String N Date of data creation
stationTypeNew Number N Type of power station, see Appendix 2 for details
fisPowerTime Number N First power on time, format timestamp
fisGenerateTime Number N First generation time, format timestamp
Code example
POST /v1/api/inverterDetailList
Connection: keep-alive
Time: Tue, 27 Jun 2023 05:47:26 GMT
Content-MD5: sAGxE9QzeBN88qPrz+sCZQ==
Content-Type: application/json
Authorization: API 1300386381676644416:SCITzMk7U3gKp05S+d7ETIvyq4g=
token: token_cb23ed9a-ab65-4699-b942-6efbf3a6e666
Request Date: Tue, 27 Jun 2023 05:47:26 GMT
parameters Content-Length: 30
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)

{
"id": "1298491919448631809",
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"id": "1298491919448631809",
"dataTimestamp": "1687844402978",
"fullHour": 2.61,
"monthCarbonDioxide": 69.92,
"installerId": "1298497302686786165",
Return
"installer": "",
parameters
"sno": "1085AC",
"country": "15",
"countryStr": "",
"region": "423",
"regionStr": "",
"city": "11393",
"cityStr": "Forster",
"county": "11379",
"state": 1,
"dip": 30.0,

- 89 -
 SolisCloud Platform API Document V2.0

"azimuth": 0.0,
"power": 5.772,
"timeZone": 10.00,
"timeZoneName": "(UTC+10:00) ",
"timeZoneStr": "(UTC+10:00)",
"timeZoneId": "115",
"daylight": 0,
"powerStr": "kW",
"createDate": 1677119648000,
"createDateStr": "2023-02-23 12:34:08 (UTC+10:00)",
"price": 1.0000,
"capacity": 12.000,
"capacityStr": "kWp",
"capacityPercent": 0,
"capacity1": 0,
"dayEnergy": 31.300,
"dayEnergyStr": "kWh",
"monthEnergy": 839.000,
"monthEnergyStr": "kWh",
"yearEnergy": 5.603,
"yearEnergyStr": "MWh",
"allEnergy": 36.393,
"allEnergyStr": "MWh",
"allEnergy1": 36393.000,
"updateDate": 1687844137000,
"type": 0,
"synchronizationType": 0,
"epmType": 0,
"gridSwitch": 0,
"shareProcess": 1,
"dcInputType": 3,
"stationTypeNew": 0,
"gridPurchasedTotalEnergy": 0.000,
"gridSellTotalEnergy": 0.000,
"homeLoadTotalEnergy": 0.000,
"oneSelf": 0.00000,
"homeLoadTodayEnergy": 31.300,
"money": "AUD",
"condTxtD": "小雨",
"condTxtN": "小雨",
"condCodeD": "305",
"condCodeN": "305",
"simFlowState": -1,
"nmiCode": "41028459350",

- 90 -
 SolisCloud Platform API Document V2.0

"jxbType": 0,
"generateDays": 92,
"generateDaysContinuous": 90,
"inverterCount": 1,
"orgCode": "61BADD",
"visitorCount": 0,
"daylightSwitch": 0,
"daylightType": 1,
"fullHourStr": "h",
"capacityPec": "1",
"dipStr": "30.0°",
"azimuthStr": "0.0°",
"dateTime": "1677119648000",
"offset": 0,
"offsetStr": "kWh",
"dayInCome": 31.300,
"dayInComeUnit": "AUD",
"monthInCome": 839.000,
"monthInComeUnit": "AUD",
"yearInCome": 5.603,
"yearInComeUnit": "KAUD",
"allInCome": 36.393,
"allInCome1": 36393.000,
"allInComeUnit": "KAUD",
"powerStationNumTree": 36.39,
"powerStationNumTreeUnit": "棵",
"powerStationAvoidedCo2": 36.28,
"powerStationAvoidedCo2Unit": "t",
"powerPec": "1",
"porwerPercent": 0.4810,
"batteryPower": 0.000,
"batteryPowerStr": "kW",
"batteryPowerPec": "1",
"batteryPowerZheng": 0,
"batteryPowerFu": 0,
"batteryPercent": 0,
"familyLoadPercent": 0,
"psum": 5.772,
"psumStr": "kW",
"psumPec": "1",
"psumZheng": 5772.0,
"psumFu": 0,
"gridPurchasedTotalEnergyStr": "kWh",
"gridSellTotalEnergyStr": "kWh",

- 91 -
 SolisCloud Platform API Document V2.0

"gridPurchasedEnergy": 0.000,
"gridPurchasedEnergyStr": "kWh",
"gridSellEnergy": 0.000,
"gridSellEnergyStr": "kWh",
"gridPurchasedDayEnergy": 0.000,
"gridPurchasedDayEnergyStr": "kWh",
"gridSellDayEnergy": 0.000,
"gridSellDayEnergyStr": "kWh",
"gridPurchasedMonthEnergy": 0.000,
"gridPurchasedMonthEnergyStr": "kWh",
"gridSellMonthEnergy": 0,
"gridSellMonthEnergyStr": "kWh",
"gridPurchasedYearEnergy": 0.000,
"gridPurchasedYearEnergyStr": "kWh",
"gridSellYearEnergy": 0.000,
"gridSellYearEnergyStr": "kWh",
"batteryDischargeEnergy": 0.000,
"batteryDischargeEnergyStr": "kWh",
"batteryChargeEnergy": 0.000,
"batteryChargeEnergyStr": "kWh",
"batteryDischargeMonthEnergy": 0.000,
"batteryDischargeMonthEnergyStr": "kWh",
"batteryChargeMonthEnergy": 0.000,
"batteryChargeMonthEnergyStr": "kWh",
"batteryDischargeYearEnergy": 0.000,
"batteryDischargeYearEnergyStr": "kWh",
"batteryChargeYearEnergy": 0.000,
"batteryChargeYearEnergyStr": "kWh",
"batteryDischargeTotalEnergy": 0.000,
"batteryDischargeTotalEnergyStr": "kWh",
"batteryChargeTotalEnergy": 0.000,
"batteryChargeTotalEnergyStr": "kWh",
"familyLoadPower": 0.000,
"familyLoadPowerStr": "kW",
"familyLoadPowerPec": "1",
"homeGridTodayEnergy": 31.300,
"homeGridTodayEnergyStr": "kWh",
"homeGridMonthEnergy": 0.000,
"homeGridMonthEnergyStr": "kWh",
"homeGridYearEnergy": 0.000,
"homeGridYearEnergyStr": "kWh",
"homeGridTotalEnergy": 0,
"homeGridTotalEnergyStr": "kWh",
"backupTodayEnergy": 0.000,

- 92 -
 SolisCloud Platform API Document V2.0

"backupTodayEnergyStr": "kWh",
"backupMonthEnergy": 0.000,
"backupMonthEnergyStr": "kWh",
"backupYearEnergy": 0.000,
"backupYearEnergyStr": "kWh",
"backupTotalEnergy": 0,
"backupTotalEnergyStr": "kWh",
"totalLoadPower": 0.000,
"totalLoadPowerStr": "kW",
"bypassLoadPower": 0.000,
"bypassLoadPowerStr": "kW",
"homeLoadEnergy": 31.300,
"homeLoadEnergyStr": "kWh",
"homeLoadTodayEnergyStr": "kWh",
"homeLoadMonthEnergy": 0.000,
"homeLoadYearEnergy": 0.000,
"picUrl":
"https://solis-test.oss-eu-central-1.aliyuncs.com/STATION_default_user.png?Expires=168
7915551&OSSAccessKeyId=LTAI5tDfhhsnNuC3fr5HU1rK&Signature=5JAsyO8hbCzqf
r1TJ2lvPkMhU%2Bw%3D",
"weather": "18:26 30.0 - 82.0 Aquatic Drive Rain",
"sr": "06:19",
"ss": "18:26",
"tmpMax": "82.0",
"tmpMin": "30.0",
"tmpUnit": "℉",
"hum": "77",
"weatherUpdateDate": "1687828212000",
"weatherUpdateDateStr": "2023-06-27 11:10:12 (UTC+10:00)",
"pcpn": "80.0",
"pres": "1011",
"windSpd": "9.1",
"windDir": "SE",
"weatherType": 0,
"windSpeed": 0,
"windDirection": 0,
"humidity": 0,
"temp": 0,
"rainfall": 0,
"airPressure": 0,
"contribution": 0,
"screenMap": 0,
"screenGuideState": 0,
"storedInverterType": 0,

- 93 -
 SolisCloud Platform API Document V2.0

"powerGridAgent": "SAPN",
"countryShortName": "AU",
"inverterPower": 8.000,
"bypassAcOnoffSet": 0,
"priceMap": {
"sell": "1.0000",
"buy": "0"
},
"sysGridPriceList": [
{
"id": "6406",
"createDate": 1677119648000,
"updateDate": 1677119648000,
"deleteFlag": 0,
"unit": "AUD",
"type": 0,
"source": 0,
"sellBuy": 0,
"refId": "1298491919448631809",
"price": 1.0000
},
{
"id": "6412",
"createDate": 1677208349000,
"updateDate": 1677208349000,
"deleteFlag": 0,
"unit": "AUD",
"type": 0,
"source": 0,
"sellBuy": 1,
"refId": "1298491919448631809",
"price": 0.0000
}
],
"generatorPower": 0,
"generatorPowerStr": "kW",
"generatorPowerPec": "1",
"generatorTodayEnergy": 0.000,
"generatorTodayEnergyStr": "kW",
"generatorTodayEnergyPec": "1",
"generatorTotalEnergy": 0,
"generatorTotalEnergyStr": "kWh",
"generatorTotalEnergyPec": "1",
"weatherCount": 0,

- 94 -
 SolisCloud Platform API Document V2.0

"inverterPowerStr": "kW",
"homeLoadMonthEnergyStr": "kWh",
"homeLoadYearEnergyStr": "kWh",
"homeLoadTotalEnergyStr": "kWh",
"gridMonthEnergy": 0.000,
"monthEnergy1": 0,
"dayEnergy1": 0,
"yearEnergy1": 0,
"power1": 0
}
}

4.4 Obtaining real-time data of multiple power stations on a certain day

Interface Name Obtaining real-time data of multiple power stations on a certain day
Obtain daily power generation of power stations in batches on the
Interface Description
corresponding SolisCloud platform.
Request URL https://www.soliscloud.com:13333/v1/api/stationDayEnergyList
Interface frequency limit 2 times/sec
Request parameters [Body]
Parameter Name Data Type Required Description
Specify the number of page numbers to return. The
pageNo String N
default value is 1, representing page 1.
Specify the number of returns per page. The default
pageSize Integereger Y
value is 20, and the maximum value is 100.
Specify to query data for a certain day, format:
time String Y
yyyy-MM-dd
stationIds String N Station Id
Return parameters [Body]
Parameter Name Data Type Required Description
0 represents success, while others represent failure.
code String Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data array Y Data identification
page Object Y result list
total Integer Y Total number of lists
records Array Y Array of record
id Long Y Station ID
energy Number N Power generation
energyStr String N Unit of power generation
Data update time under UTC+8. The format is a
date number Y
timestamp.. The format is a timestamp.

- 95 -
 SolisCloud Platform API Document V2.0

dateStr String Y Data, format string

money String N Income
moneyStr String N Unit of income
batteryDischargeEnergy Number N Battery discharge energy
batteryChargeEnergy Number N Battery charging energy
gridPurchasedEnergy Number N Grid purchased energy
gridSellEnergy Number N Grid sell energy
Code example
POST /v1/api/ stationDayEnergyList
Connection: keep-alive
Date: Wed, 28 Jun 2023 02:22:45 GMT
Content-MD5: 318kyhw+nm7ATa90m1KxyA==
Authorization: API 1300386381676644416:82vsMEy/KAz4p3PhzHhSYnFJQgs=
Content-Type: application/json;charset=UTF-8
Content-Length: 49
Request
Host: test.soliscloud.com:3333
parameters
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"pageNo": "1",
"pageSize": "10",
"time": "2023-5-26"，
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"records": [
{
"id": "1298491919448631809",
"money": 761.000,
"moneyStr": "AUD",
Return parameters
"moneyPec": "1",
"energy": 761.000,
"energyStr": "kWh",
"energyPec": "1",
"fullHour": 63.42,
"date": 1687881600000,
"dateStr": "2023-06-28",
"timeZone": 8,
"batteryDischargeEnergy": 0,
"batteryChargeEnergy": 0,

- 96 -
 SolisCloud Platform API Document V2.0

"gridPurchasedEnergy": 0,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0,
"gridSellIncome": 0.000,
"homeLoadEnergy": 761.000,
"oneSelf": 761.000,
"consumeEnergy": 761.000,
"produceEnergy": 761.000,
"consumePec": 0.00,
"producePec": 0.00,
"offSetEnergy": 0.000,
"offSetIncome": 0.000,
"totalR": 5.243000,
"directR": 3.389000,
"errorFlag": 0
}
],
"total": 1,
"size": 100,
"current": 1,
"orders": [ ],
"optimizeCountSql": true,
"searchCount": true,
"pages": 1
}
}

4.5 Obtaining Daily Data of Multiple Power Stations for a Month

Interface Name Obtaining Daily Data of Multiple Power Stations for a Month
Interface Description Corresponding monthly chart of SolisCloud platform power station
Request URL https://www.soliscloud.com:13333/v1/api/stationMonthEnergyList
Interface frequency
10 times/sec
limit
Request parameters [Body]
Data
Parameter Name Required Description
Type
Specify the number of page numbers to return. The
pageNo number Y
default value is 1, representing page 1.
Specify the number of returns per page. The default
pageSize number Y
value is 20, and the maximum value is 100.
stationIds String N Station Id
nmiCode String N NMI Code
Return parameters [Body]

- 97 -
 SolisCloud Platform API Document V2.0

Data
Parameter Name Required Description
Type
0 represents success, while others represent failure.
code String Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
page Object Y result list
total Integer Y Total number of lists
records Array Y Array of record
id number Y Station ID
energy number Y Power generation
Data update time under UTC+8. The format is a
date number Y
timestamp.. The format is a timestamp.
dateStr String Y Data, format string
money number N Income
moneyStr number N Unit of income
batteryDischargeEnergy number N Battery discharge energy
batteryChargeEnergy number N Battery charging energy
gridPurchasedEnergy number N Grid purchased energy
gridSellEnergy number N Grid sell energy
Code example
POST /v1/api/stationMonthEnergyList
Connection: keep-alive
Date: Wed, 28 Jun 2023 02:27:57 GMT
Content-MD5: +6vavbBiUMIXHUP4LvAhMg==
Authorization:API
1300386381676644416:OjjngNHie/KHBWwAV6mPMti/fFg=
Content-Type: application/json;charset=UTF-8
Content-Length: 72
Request parameters
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"pageNo": "1",
"pageSize": "100",
"time": "2023-06",
"nmiCode": "41028459350"
}
{
"success": true,
Return parameters "code": "0",
"msg": "success",
"data": {

- 98 -
 SolisCloud Platform API Document V2.0

"records": [
{
"id": "1298491919448631809",
"money": 6556.000,
"moneyStr": "KAUD",
"moneyPec": "0.001",
"energy": 6556.000,
"energyStr": "MWh",
"energyPec": "0.001",
"fullHour": 546.33,
"date": 1685548800000,
"dateStr": "2023-06-01",
"timeZone": 8,
"batteryDischargeEnergy": 0,
"batteryChargeEnergy": 0,
"gridPurchasedEnergy": 0,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0,
"gridSellIncome": 0.000,
"homeLoadEnergy": 0,
"oneSelf": 6556.000,
"consumeEnergy": 6556.000,
"produceEnergy": 6556.000,
"consumePec": 0.00,
"producePec": 0.00,
"offSetEnergy": 0.000,
"offSetIncome": 0.000,
"totalR": 5.243000,
"directR": 3.389000,
"errorFlag": 0
}
],
"total": 1,
"size": 100,
"current": 1,
"orders": [ ],
"optimizeCountSql": true,
"searchCount": true,
"pages": 1
}
}

4.6 Obtaining Annual Data from Multiple Power Stations

Interface Name Obtaining Annual Data from Multiple Power Stations

- 99 -
 SolisCloud Platform API Document V2.0

Interface Description Corresponding SolisCloud Platform Power Station Annual Chart

Request URL https://www.soliscloud.com:13333/v1/api/stationYearEnergyList
Interface frequency
10 times/sec
limit
Request parameters [Body]
Data
Parameter Name Required Description
Type
Specify the number of page numbers to return. The
pageNo number Y
default value is 1, representing page 1.
Specify the number of returns per page. The default
pageSize number Y
value is 20, and the maximum value is 100.
stationIds String N Station Id
nmiCode String N NMI Code
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent failure.
code String Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Object Y Data identification
page Object Y result list
total Integer Y Total number of lists
records Array Y Array of record
id number Y Station ID
energy number Y Power generation
year number Y Year
money number N Income
moneyStr number N Unit of income
batteryDischargeEnergy number N Battery discharge energy
batteryChargeEnergy number N Battery charging energy
gridPurchasedEnergy number N Grid purchased energy
gridSellEnergy number N Grid sell energy
Code example
POST /v1/api/stationYearEnergyList
Connection: keep-alive
Date: Wed, 28 Jun 2023 02:27:57 GMT
Content-MD5: +6vavbBiUMIXHUP4LvAhMg==
Request parameters Authorization:API
1300386381676644416:OjjngNHie/KHBWwAV6mPMti/fFg=
Content-Type: application/json;charset=UTF-8
Content-Length: 72
Host: test.soliscloud.com:3333

- 100 -
 SolisCloud Platform API Document V2.0

User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)

{
"pageNo": "1",
"pageSize": "10",
"time": "2023",
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": {
"records": [
{
"id": "1298491919448631809",
"money": 98623.000,
"moneyStr": "KAUD",
"moneyPec": "0.001",
"energy": 98623.000,
"energyStr": "MWh",
"energyPec": "0.001",
"fullHour": 8218.58,
"year": 2023,
"timeZone": 8,
"batteryDischargeEnergy": 0,
Return parameters "batteryChargeEnergy": 0,
"gridPurchasedEnergy": 0,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0,
"gridSellIncome": 0.000,
"homeLoadEnergy": 0,
"oneSelf": 98623.000,
"consumeEnergy": 98623.000,
"produceEnergy": 98623.000,
"consumePec": 0.00,
"producePec": 0.00,
"offSetEnergy": 0.000,
"offSetIncome": 0.000,
"totalR": 5.243000,
"directR": 3.389000,
"errorFlag": 0
}
],
"total": 1,

- 101 -
 SolisCloud Platform API Document V2.0

"size": 10,
"current": 1,
"orders": [ ],
"optimizeCountSql": true,
"searchCount": true,
"pages": 1
}
}

4.7 Obtain real-time data of a single power station on a certain day

Interface Name Obtain real-time data of a single power station on a certain day
Interface Description Daily chart of corresponding SolisCloud platform power station details
Request URL https://www.soliscloud.com:13333/v1/api/stationDay
Interface frequency limit 2 times/sec
Request parameters [Body]
Data
Parameter Name Required Description
Type
Query the information of the specified power station
id Integer N ID or power station NMI , both cannot be empty at
the same time.
money String Y Used to calculate revenue, e.g. EUR, CNY
Specify to query data for a certain day, format:
time String Y
yyyy-MM-dd
The time zone where the device is located. Example:
timeZone Integer Y
8
nmiCode String N NMI Code
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent failure.
code String Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Array Y Data identification
power Number N Power
powerStr String N Unit of power
time Long N
Code example
POST /v1/api/stationDay
Connection: keep-alive
Request parameters Date: Tue, 27 Jun 2023 06:49:36 GMT
Content-MD5: gvXLKbqHkJRwkiPCceCtSA==
Authorization: API

- 102 -
 SolisCloud Platform API Document V2.0

1300386381676644416:N02s7Zy+RIW63m2hyniy/xq6n2c=
Content-Type: application/json;charset=UTF-8
Content-Length: 101
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"id": "1298491919448631809",
"money": "CNY",
"time": "2023-05-26",
"timeZone": "8",
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": [
{
"familyLoadPower": 0.00000,
"bypassLoadPower": 0.00000,
"batteryPower": 0.00000,
"batteryPowerZheng": 0.00000,
"batteryPowerFu": 0,
"psum": 77.00000,
"psumZheng": 77.00000,
"psumFu": 0,
"oneSelf": 0.00000,
"consumeEnergy": 0.00000,
Return parameters
"produceEnergy": 77.00000,
"time": 1685057100000,
"timeStr": "07:25:00",
"money": 0,
"moneyStr": "CNY",
"moneyPec": "1",
"power": 77.000,
"powerStr": "kW",
"powerPec": "0.001",
"timeZone": 8
},
{
"familyLoadPower": 0.00000,
"bypassLoadPower": 0.00000,
"batteryPower": 0.00000,
"batteryPowerZheng": 0.00000,

- 103 -
 SolisCloud Platform API Document V2.0

"batteryPowerFu": 0,
"psum": 78.00000,
"psumZheng": 78.00000,
"psumFu": 0,
"oneSelf": 0.00000,
"consumeEnergy": 0.00000,
"produceEnergy": 78.00000,
"time": 1685057400000,
"timeStr": "07:30:00",
"money": 0,
"moneyStr": "CNY",
"moneyPec": "1",
"power": 78.000,
"powerStr": "kW",
"powerPec": "0.001",
"timeZone": 8
},
{
"familyLoadPower": 0.00000,
"bypassLoadPower": 0.00000,
"batteryPower": 0.00000,
"batteryPowerZheng": 0.00000,
"batteryPowerFu": 0,
"psum": 79.00000,
"psumZheng": 79.00000,
"psumFu": 0,
"oneSelf": 0.00000,
"consumeEnergy": 0.00000,
"produceEnergy": 79.00000,
"time": 1685057700000,
"timeStr": "07:35:00",
"money": 0,
"moneyStr": "CNY",
"moneyPec": "1",
"power": 79.000,
"powerStr": "kW",
"powerPec": "0.001",
"timeZone": 8
},...}

4.8 Obtain daily data of a single power station for a certain month
Interface Name Obtain daily data of a single power station for a certain month
Monthly chart of corresponding SolisCloud platform power station
Interface Description
details

- 104 -
 SolisCloud Platform API Document V2.0

Request URL https://www.soliscloud.com:13333/v1/api/stationMonth

Interface frequency limit 2 times/sec
Request parameters [Body]
Data
Parameter Name Required Description
Type
Query the information of the specified power
id Integer N station ID or power station NMI , both cannot be
empty at the same time.
money String Y Used to calculate revenue, e.g. EUR, CNY
month String Y format: yyyy-MM
The time zone where the device is located.
timeZone Integer Y
Example: 8
nmiCode String N NMI Code
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent
code String Y failure. The failure code is detailed in Appendix
1.
msg String Y Description of code values
data Array Y Data identification
energy Number N Power generation
energyStr String N Unit of power generation
Data update time under UTC+8. The format is a
date number Y
timestamp.. The format is a timestamp.
dateStr String Y Data, format string
money Number N Income
moneyStr String N Unit of income
batteryDischargeEnergy Number N Battery discharge energy
batteryChargeEnergy Number N Battery charging energy
gridPurchasedEnergy Number N Grid purchased energy
gridSellEnergy Number N Grid sell energy
Code example
POST /v1/api/stationMonth
Connection: keep-alive
Date: Tue, 27 Jun 2023 10:36:58 GMT
Content-MD5: hZtPtB6r9W7eGqoUm7yTpA==
Request parameters Authorization:API
1300386381676644416:4+Ci/BiGu+QAnaHn7zAIlQJZl6M=
Content-Type: application/json;charset=UTF-8
Content-Length: 84
Host: test.soliscloud.com:3333

- 105 -
 SolisCloud Platform API Document V2.0

User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)

{
"id": "1298491919448631809",
"money": "CNY",
"month": "2023-06",
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": [
{
"id": "1308652875882403403",
"money": 0.000,
"moneyStr": "CNY",
"moneyPec": "1",
"energy": 0.000,
"energyStr": "kWh",
"energyPec": "1",
"fullHour": 0.00,
"date": 1685592000000,
"dateStr": "2023-06-01",
"timeZone": 8,
"batteryDischargeEnergy": 0.00000,
Return parameters "batteryChargeEnergy": 0.00000,
"gridPurchasedEnergy": 0.00000,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0.00000,
"gridSellIncome": 0.000,
"homeLoadEnergy": 0.00000,
"consumeEnergy": 0,
"produceEnergy": 0,
"offSetEnergy": 0.000,
"offSetIncome": 0.000,
"errorFlag": 0
},
......
{
"id": "1308652875882408134",
"money": 44.900,
"moneyStr": "CNY",
"moneyPec": "1",
"energy": 44.900,

- 106 -
 SolisCloud Platform API Document V2.0

"energyStr": "kWh",
"energyPec": "1",
"fullHour": 3.74,
"date": 1687838400000,
"dateStr": "2023-06-30",
"timeZone": 8,
"batteryDischargeEnergy": 0,
"batteryChargeEnergy": 0,
"gridPurchasedEnergy": 0,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0,
"gridSellIncome": 0.000,
"homeLoadEnergy": 44.900,
"consumeEnergy": 0,
"produceEnergy": 0,
"offSetEnergy": 0.000,
"offSetIncome": 0.000,
"totalR": 0,
"directR": 0,
"errorFlag": 0
}
]
}

4.9 Obtaining Monthly Data of a Single Power Plant for a Certain Year
4.9 Obtaining Monthly Data of a Single Power Plant for a Certain
Interface Name
Year
Interface Description Annual chart of corresponding SolisCloud platform power station details
Request URL https://www.soliscloud.com:13333/v1/api/stationYear
Interface frequency limit 2 times/sec
Request parameters [Body]
Data
Parameter Name Required Description
Type
Query the information of the specified power
id Integer N station ID or power station NMI , both cannot be
empty at the same time.
money String Y Used to calculate revenue, e.g. EUR, CNY
year String Y format: yyyy
The time zone where the device is located.
timeZone Integer Y
Example: 8
nmiCode String N NMI Code
Return parameters [Body]
Parameter Name Data Required Description

- 107 -
 SolisCloud Platform API Document V2.0

Type
0 represents success, while others represent
code String Y failure. The failure code is detailed in Appendix
1.
msg String Y Description of code values
data Array Y Data identification
energy Number N Power generation
energyStr String N Unit of power generation
Data update time under UTC+8. The format is a
date number Y
timestamp.. The format is a timestamp.
dateStr String Y Data, format string
money Number N Income
moneyStr String N Unit of income
batteryDischargeEnergy Number N Battery discharge energy
batteryChargeEnergy Number N Battery charging energy
gridPurchasedEnergy Number N Grid purchased energy
gridSellEnergy Number N Grid sell energy
Code example
POST /v1/api/stationYear
Connection: keep-alive
Date: Tue, 27 Jun 2023 10:57:37 GMT
Content-MD5: NXfNhwGdQe+6lxtZ4WKk/w==
Authorization:API
1300386381676644416:gSbrx4TdYOW0ljdk8Y9fFvI41xM=
Content-Type: application/json;charset=UTF-8
Content-Length: 80
Request parameters
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"id": "1298491919448631809",
"money": "CNY",
"year": "2023",
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
"msg": "success",
Return parameters
"data": [
{
"id": "1308652876059249630",
"money": 755.000,

- 108 -
 SolisCloud Platform API Document V2.0

"moneyStr": "CNY",
"moneyPec": "1",
"energy": 755.000,
"energyStr": "MWh",
"energyPec": "0.001",
"fullHour": 62.92,
"date": 1675224000000,
"dateStr": "2023-02-01",
"timeZone": 8,
"batteryDischargeEnergy": 0.00000,
"batteryChargeEnergy": 0.00000,
"gridPurchasedEnergy": 0.00000,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0.00000,
"gridSellIncome": 0.000,
"homeLoadEnergy": 0.00000,
"consumeEnergy": 0,
"produceEnergy": 0,
"offSetEnergy": 0.000,
"offSetIncome": 0.000,
"errorFlag": 0
},
......
{
"id": "1308652876059257166",
"money": 852.000,
"moneyStr": "CNY",
"moneyPec": "1",
"energy": 852.000,
"energyStr": "MWh",
"energyPec": "0.001",
"fullHour": 71.00,
"date": 1685592000000,
"dateStr": "2023-06-01",
"timeZone": 8,
"batteryDischargeEnergy": 0,
"batteryChargeEnergy": 0,
"gridPurchasedEnergy": 0,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0,
"gridSellIncome": 0.000,
"homeLoadEnergy": 0,
"consumeEnergy": 0,
"produceEnergy": 0,

- 109 -
 SolisCloud Platform API Document V2.0

"offSetEnergy": 0.000,
"offSetIncome": 0.000,
"totalR": 0,
"directR": 0,
"errorFlag": 0
}
]
}

4.10 Obtaining Annual Data of a Power Plant

Interface Name Obtaining Annual Data of a Power Plant
Cumulative Chart of Power Station Details Corresponding to SolisCloud
Interface Description
Platform.
Request URL https://www.soliscloud.com:13333/v1/api/stationAll
Interface frequency limit 2 times/sec
Request parameters [Body]
Data
Parameter Name Required Description
Type
Query the information of the specified power
id Integer N station ID or power station NMI , both cannot be
empty at the same time.
money String Y Used to calculate revenue, e.g. EUR, CNY
The time zone where the device is located.
timeZone Integer Y
Example: 8
nmiCode String N NMI Code
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent
code String Y failure. The failure code is detailed in Appendix
1.
msg String Y Description of code values
data Array Y Data identification
energy Number N Power generation
energyStr String N Unit of power generation
Data update time under UTC+8. The format is a
date number Y
timestamp.. The format is a timestamp.
dateStr String Y Data, format string
money Number N Income
moneyStr String N Unit of income
batteryDischargeEnergy Number N Battery discharge energy
batteryChargeEnergy Number N Battery charging energy

- 110 -
 SolisCloud Platform API Document V2.0

gridPurchasedEnergy Number N Grid purchased energy

gridSellEnergy Number N Grid sell energy
Code example
POST /v1/api/stationAll
Connection: keep-alive
Date: Tue, 27 Jun 2023 11:00:40 GMT
Content-MD5: QEQONshrvlmBcpig9shdPg==
Authorization:API
1300386381676644416:/q0JL/CZU8jwSRL03QbTA9DfYgU=
Content-Type: application/json;charset=UTF-8
Request parameters Content-Length: 66
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"id": "1298491919448631809",
"money": "CNY",
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
"msg": "success",
"data": [
{
"id": "1308652876792594370",
"money": 5616.000,
"moneyStr": "",
"moneyPec": "1",
"energy": 5616.000,
"energyStr": "MWh",
"energyPec": "0.001",
Return parameters
"fullHour": 468.00,
"year": 2023,
"timeZone": 8,
"batteryDischargeEnergy": 0,
"batteryChargeEnergy": 0,
"gridPurchasedEnergy": 0,
"gridPurchasedIncome": 0.000,
"gridSellEnergy": 0,
"gridSellIncome": 0.000,
"homeLoadEnergy": 0,
"oneSelf": 5616.000,
"consumeEnergy": 0,
"produceEnergy": 0,

- 111 -
 SolisCloud Platform API Document V2.0

"offSetEnergy": 0.000,
"offSetIncome": 0.000,
"totalR": 0,
"directR": 0,
"errorFlag": 0
}
]
}

4.11 Newly added power station information

Interface Name Newly added power station information
Corresponding to the newly added power station on the SolisCloud
Interface Description
platform.
Request URL https://www.soliscloud.com:13333/v1/api/addStation
Interface frequency limit 2 times/sec
Request parameters [Body]
Data
Parameter Name Required Description
Type
inverterSn String N
Fill in one inverter SN or collector SN to bind
collectorSn String N
stationName String Y Name of station
userId Integer N Default owner's account
mobile String N Owners' mobile phones
capacity String Y Installed capacity, Unit: kWp
latitude String N latitude
Integeritude String N Integeritude
dip Number N Component inclination angle
azimuth Number N Component azimuth
Currency type, used to calculate revenue, e.g.
money String Y
EUR, CNY
addr String Y Detailed address of the power station
gdAreaCode String N Retrieve address code through Google Map API
countryStr Integer N Country name
regionStr Integer N Region name
cityStr Integer N City name
price Integer Y Revenue per kWh
offset Number N Time zone offset
module String N Number of components
installerEmail String N Installer Email
installerMobile String N Installer Mobile
nmiCode Number N NMI Code

- 112 -
 SolisCloud Platform API Document V2.0

Return parameters [Body]

Data
Parameter Name Required Description
Type
0 represents success, while others represent failure.
code Integer Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Integer Y Data identification
stationId Integer Y Station Id
Code example
POST /v1/api/addStation
Connection: keep-alive
Content-Type: application/json
Date: Tue, 27 Jun 2023 06:45:14 GMT
Content-MD5: TgcpDReudwzrqpKQhQxshw==
Authorization:API
1300386381676644416:Gssn7wg9PuyniGZ5KHf1L3DCC5M=
Content-Length: 545
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"stationName": "autotest22",
"userId": "",
"mobile": "18957465251",
"capacity": "10",
"picName": "",
"longitude": "120.01144",
Request parameters "latitude": "30.320861",
"dip": "45",
"azimuth": "",
"addr": "",
"money": "CNY",
"gdAreaCode": "330110",
"country": 1,
"region": 862,
"city": 863,
"countryStr": "",
"regionStr": "",
"cityStr": "",
"countyStr": "",
"price": "",
"offset": "",
"module": "",
"installerEmail ": "",
"installerMobile": "",

- 113 -
 SolisCloud Platform API Document V2.0

"nmiCode": "",
"language": "1"
}
{
"success": true,
"code": "0",
"msg": "success",
Return parameters
"data": {
"id": 123456
}
}

4.12 Modifying Power Station Information

Interface Name Modifying Power Station Information

Interface Description Corresponding modification of power station information on SolisCloud platform
Request URL https://www.soliscloud.com:13333/v1/api/stationUpdate
Interface frequency
2 times/sec
limit
Request parameters [Body]
Parameter Name Data Type Required Description
id number N Station ID
stationName String Y Name of station
mobile String N Owners' mobile phones
capacity String Y Installed capacity, Unit: kWp
latitude String N latitude
longitude String N Integeritude
dip Number N Component inclination angle
azimuth Number N Component azimuth
Currency type, used to calculate revenue, e.g. EUR,
money String N
CNY
price Number Y Revenue per kWh
addr String Y Detailed address of the power station
gdAreaCode Integereger N Retrieve address code through Google Map API
country Integereger N Country name
region Integereger N Region name
city Integereger N City name
module number N Number of components
installerEmail String N Installer Email
installerMobile number N Installer Mobile
nmiCode String N NMI Code

- 114 -
 SolisCloud Platform API Document V2.0

Return parameters [Body]

Parameter Name Data Type Required Description
0 represents success, while others represent failure. The
code Integer Y
failure code is detailed in Appendix 1.
msg String Y Description of code values
data Integer Y Data identification
Code example
POST /v1/api/stationUpdate
Connection: keep-alive
Content-Type: application/json
Date: Tue, 27 Jun 2023 11:39:26 GMT
Content-MD5: /xODsrSeC4vzAQJYwy3wxQ==
Authorization: API 1300386381676644416:qsdQn7j7OsAzm+5g0NViL2Nf2W0=
Content-Length: 474
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)
{
"id": "1298491919448632027",
"stationName": "autotest",
"addr": "hangzhouzhejiang",
"mobile": "18957465251",
"capacity": 20,
"longitude": "120.01144",
Request "latitude": "30.320861",
parameters "dip": "",
"azimuth": "",
"price": "",
"gdAreaCode": "330110",
"country": 1,
"region": 862,
"city": 863,
"countryStr": "China",
"regionStr": "Zhejiang",
"cityStr": "Hangzhou",
"countyStr": "Binjiang District",
"module": "",
"installerEmail ": "",
"installerMobile": "",
"nmiCode": "",
"language": "1"
}
{
Return parameters "success": true,
"code": "0",

- 115 -
 SolisCloud Platform API Document V2.0

"msg": "success",
"data": null
}

4.13 Binding a new collector to the power station

Interface Name Binding a new collector to the power station

Interface
Corresponding SolisCloud platform power station binding collector.
Description
Request URL https://www.soliscloud.com:13333/v1/api/addStationBindCollector
Interface frequency
2 times/sec
limit
Request parameters [Body]
Parameter Name Data Type Required Description
Collector SN. Fill in the new power station and bind it.
sn String N When there are multiple, please separate them with
commas.
stationName String Y Name of station
userId Number N Default owner's account
capacity String Y Installed capacity, Unit: kWp
picName String N Picture name
latitude String N Latitude
longitude String N Longitude
dip Number N Component inclination angle
azimuth Number N Component azimuth
money String N Currency type, used to calculate revenue, e.g. EUR, CNY
addr String N Detailed address of the power station
高德地图：
gdAreaCode Integereger N Retrieve address code through Google Map API
country Integereger N Country name
region Integereger N Region name
city Integereger N City name
price Number N Revenue per kWh
offset Number N Time zone offset
type Integereger N Type of power station, see Appendix 2 for details
Grid connection type: 0=Full online, 1=Self use, 2=Off
synchronizationType Integereger N
grid
installTime String N Installation time of power station
module Integereger N Number of components
installerEmail String N Installer Email
installerMobile Integereger N Installer Mobile

- 116 -
 SolisCloud Platform API Document V2.0

nmiCode String N NMI Code

Return parameters [Body]
Parameter Name Data Type Required Description
0 represents success, while others represent failure. The
code Integer Y
failure code is detailed in Appendix 1.
msg String Y Description of code values
data Integer Y Data identification
Code example
POST /v1/api/ addStationBindCollector
Connection: keep-alive
Content-Type: application/json
Date: Wed, 28 Jun 2023 00:32:31 GMT
Content-MD5: lcVMJKs5Nsqq7lDfQBrFEA==
Authorization: API 1300386381676644416:l31S6aoTlhIi9yGc9VZesYPnV88=
Content-Length: 555
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)

{
"sn": "FFC00115565",
"stationName": "autotest22",
"userId": "",
"capacity": 20,
"picName": "",
"addr": "zhejiang hangzhouaa",
Request parameters "longitude": "120.01144",
"latitude": "30.320861",
"dip": "",
"azimuth": "",
"money": "",
"gdAreaCode": "330110",
"country": 1,
"region": 862,
"city": 863,
"countryStr": "",
"regionStr": "",
"cityStr": "",
"price": "0.5",
"offset": "",
"type": "",
"contribution": "",
"synchronizationType": "",
"installTime": "",

- 117 -
 SolisCloud Platform API Document V2.0

"module": "",
"installerEmail ": "",
"installerMobile": "",
"nmiCode": "80023601742",
"mobile": "18957465251"
}
{
"success": true,
"code": "0",
Return parameters
"msg": "success",
"data": "1298491919448634915"
}

4.14 Power station unbinding collector

Interface Name Power station unbinding collector

Interface Description Corresponding SolisCloud platform power station unbinding collector
Request URL https://www.soliscloud.com:13333/v1/api/delCollector
Interface frequency
2 times/sec
limit
Request parameters [Body]
Parameter Name Data Type Required Description
sn String N Collector SN
1=delete all inverters together. 0=Do not delete.
deleteInvert Integereger Y
Default not to delete
Return parameters [Body]
Parameter Name Data Type Required Description
0 represents success, while others represent failure.
code Integer Y
The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Integer Y Data identification
Code example
POST /v1/api/delCollector
Connection: keep-alive
Content-Type: application/json
Date: Wed, 28 Jun 2023 01:08:55 GMT
Content-MD5: 98i7tIiBFoRK45MOzLIBKw==
Request parameters Authorization: API 1300386381676644416:2mxDrDd+y3032bL3g6MYX8Utcxc=
Content-Length: 39
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17){
{
"sn": "FFC00115564",

- 118 -
 SolisCloud Platform API Document V2.0

"deleteInvert": "0"
}
or
{
"sn": "FFC00115569",
"deleteInvert": "1"
}
{
"success": true,
"code": "0",
Return parameters
"msg": "success",
"data": null
}

4.15 Power plant binding inverter

Interface Name 4.15 Power plant binding inverter
Interface Description -
Request URL https://www.soliscloud.com:13333/v1/api/addDevice
Interface frequency limit 2 times/sec
Request parameters [Body]
Data
Parameter Name Required Description
Type
id Integer N Choose between power station ID and nmiCode
sn String Y Use commas to separate multiple inverter SNs
nmiCode String N NMI Code
Return parameters [Body]
Data
Parameter Name Required Description
Type
0 represents success, while others represent
code String Y
failure. The failure code is detailed in Appendix 1.
msg String Y Description of code values
data Array Y Data identification
Code example
POST /v1/api/addDevice
Connection: keep-alive
Content-Type: application/json
Date: Tue, 27 Jun 2023 11:13:56 GMT
Content-MD5: K+B2qWZo6EmGpxL+p3A8rA==
Request parameters
Authorization:API
1300386381676644416:Nm6WNyb1BoV8nsdihYbaOMp77rY=
Content-Length: 60
Host: test.soliscloud.com:3333
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.17)

- 119 -
 SolisCloud Platform API Document V2.0

{
"id": "1298491919448631809",
"sn": "FFC00115566",
"nmiCode": "41028459350"
}
{
"success": true,
"code": "0",
Return parameters
"msg": "success",
"data": null
}

- 120 -
 SolisCloud Platform API Document V2.0

APPENDIX 1. ERROR CODES

Return value Description

R0000 No authority

B0001 Has been bound to other users

I0003 Please enter SN

B0049 The collector no exists or has no permissions and cannot be viewed

I0000 The necessary parameters are empty

B0011 The user does not exist

I0012 Incorrect account or password, please re-enter

APPENDIX 2. TYPE OF POWER PLANT

Return value Description

0 Grid type

1 Energy storage

2 AC Couple

3 EPM (grid+meter)

4 Built-in meter (grid+meter)

5 External meter (display meter)

6 S5 offline and parallel energy storage

7 S5 grid and parallel energy storage

8 Grid+AC Couple

9 Off grid energy storage

10 S6 grid and parallel energy storage

11 S6 offline and parallel energy storage

- 121 -
 SolisCloud Platform API Document V2.0

APPENDIX 3. TYPES OF INVERTER METERS

Return value Description

1 Grid type

2 Grid and load side meter

3 Grid connected and grid side electricity meter

4 Energy storage and load side meter

5 Energy storage and grid side meter

6 reserve

7 Off grid energy storage

8 Grid connected energy storage dual meter

1001 AC Couple (without CT)

1002 AC Couple (with CT)

- 122 -