Data Access API (User Auth)

Data Access API provides data query interfaces for inverters, collectors, EPMs, weather stations, ammeters, and plants. This document describes the interfaces using User-level Authorization (Custom HMAC-SHA1 Signature).

Item	Description
API Base URL	`https://www.soliscloud.com:13333/`
Authentication	Custom HMAC-SHA1 Signature

Rate Limit Reminder

Data Access API rate limit is 10 requests/second. If this cannot meet your needs, consider switching to queue-based data forwarding (Real-time Data Forwarding).

Common Response Format

All interfaces return a unified JSON structure:

json

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

Field	Type	Description
success	boolean	`true` for success, `false` for failure
code	string	`"0"` for success, others for failure (see appendix)
msg	string	Description of the code value
data	object/array	Specific business data

Pagination

Data access interfaces use cursor-based pagination:

Item	Description
Ordering	Always ascending by the interface-specific business primary key `id` (see the `minId` description of each interface)
First request	Omit `minId` to start from the smallest id
Next page	Pass `minId` = last record's id + 1 (the boundary is inclusive; passing the last record's id will return that record again)
Page size	`pageSize`, default 20, maximum 100
More pages?	If the number of returned records equals `pageSize`, more pages may exist; fewer means you have reached the end
total	Always 0; the real total is no longer returned

Rate Limits

Interface Type	Limit
Data acquisition interfaces	10 times/second
Device data upload frequency	5 minutes

TIP

If rate limits cannot meet your business needs, please refer to Real-time Data Forwarding to switch to queue data forwarding.

Authentication

See Authorization for authentication details.

Request headers require Custom HMAC-SHA1 signature:

Header Parameter	Description
Content-MD5	MD5 hash of the Body content, Base64 encoded
Content-Type	`application/json;charset=UTF-8`
Date	GMT time, format: `EEE, d MMM yyyy HH:mm:ss 'GMT'`
Authorization	`API {apiId}:{sign}`

Interface List

Inverter Interfaces

Interface	Path	Description
Inverter List	`/v1/api/inverterList`	Get inverter list under account
Inverter Detail	`/v1/api/inverterDetail`	Get single inverter detail
Inverter Day Data	`/v1/api/inverterDay`	Get single inverter daily real-time data
Inverter Month Data	`/v1/api/inverterMonth`	Get single inverter monthly daily data
Inverter Year Data	`/v1/api/inverterYear`	Get single inverter yearly monthly data
Inverter All Data	`/v1/api/inverterAll`	Get single inverter cumulative data
Inverter Warranty	`/v1/api/inverter/shelfTime`	Get inverter warranty data
Alarm List	`/v1/api/alarmList`	Get device alarm list

Collector Interfaces

Interface	Path	Description
Collector List	`/v1/api/collectorList`	Get collector list under account
Collector Detail	`/v1/api/collectorDetail`	Get single collector detail
Collector Signal	`/v1/api/collector/day`	Get collector signal values

EPM Interfaces

Interface	Path	Description
EPM List	`/v1/api/epmList`	Get EPM list under account
EPM Detail	`/v1/api/epmDetail`	Get single EPM detail
EPM Day Data	`/v1/api/epm/day`	Get single EPM daily data
EPM Month Data	`/v1/api/epm/month`	Get single EPM monthly data
EPM Year Data	`/v1/api/epm/year`	Get single EPM yearly data
EPM All Data	`/v1/api/epm/all`	Get single EPM cumulative data

Weather Station Interfaces

Interface	Path	Description
Weather Station List	`/v1/api/weatherList`	Get weather station list
Weather Station Detail	`/v1/api/weatherDetail`	Get single weather station detail

Ammeter Interfaces (User-level only)

Interface	Path	Description
Ammeter List	`/v1/api/ammeterList`	Get ammeter list under account
Ammeter Detail	`/v1/api/ammeterDetail`	Get single ammeter detail

Plant Interfaces

Interface	Path	Description
Plant List	`/v1/api/userStationList`	Get plant list under account
Plant Detail	`/v1/api/stationDetail`	Get single plant detail
Plant Day Energy List	`/v1/api/stationDayEnergyList`	Get multiple plants daily data
Plant Month Energy List	`/v1/api/stationMonthEnergyList`	Get multiple plants monthly data
Plant Year Energy List	`/v1/api/stationYearEnergyList`	Get multiple plants yearly data
Plant Day Data	`/v1/api/stationDay`	Get single plant daily real-time data
Plant Month Data	`/v1/api/stationMonth`	Get single plant monthly daily data
Plant Year Data	`/v1/api/stationYear`	Get single plant yearly monthly data
Plant All Data	`/v1/api/stationAll`	Get single plant cumulative data

Inverter Interface Details

Get Inverter List

Get inverter list under the account, up to 100 devices per call.

Endpoint: POST /v1/api/inverterList

Request Parameters:

Parameter	Type	Required	Description
stationId	Integer	No	Plant ID. Empty for all inverters
plantId	String	No	Plant code, available from plant list or data forwarding. Same effect as stationId
nmiCode	String	No	NMI code (Australia only)
snList	Array	No	Batch SN query. Empty for all inverters
minId	Long	No	Starting ID (inclusive); paging is ordered by `inverter_id` ascending. Omit to start from the smallest ID.

Response Parameters (data):

Parameter	Type	Description
page	Object	Pagination result
page.total	Integer	Always 0 (cursor pagination does not return the real total)
page.records	Array	Inverter list
inverterStatusVo	Object	Inverter status statistics
inverterStatusVo.all	Integer	Total inverters
inverterStatusVo.normal	Integer	Normal count
inverterStatusVo.offline	Integer	Offline count
inverterStatusVo.fault	Integer	Fault count

records fields:

Parameter	Type	Description
id	Number	Inverter ID
sn	String	Inverter SN
stationId	Integer	Plant ID
stationName	String	Plant name
power	String	Installed capacity
powerStr	String	Capacity unit
etoday	Number	Today's energy
etodayStr	Number	Energy unit
etotal	Number	Total energy
etotalStr	Number	Total energy unit
fullHour	Number	Full load hours
pac	Number	Power
pacStr	Number	Power unit
state	Integer	Status: 1=online, 2=offline, 3=alarm
dataTimestamp	Integer	Update time
collectorSn	String	Collector SN
productModel	String	Inverter type
dcInputType	Integer	DC input channels (value+1=actual)
acOutputType	Integer	AC output type: 0=single phase, other=three phase
inverterMeterModel	Integer	Inverter meter type, see Appendix 3

Get Inverter Detail

Endpoint: POST /v1/api/inverterDetail

Request Parameters:

Parameter	Type	Required	Description
id	Number	No	Inverter ID, id and sn cannot both be empty
sn	String	No	Inverter SN

Response Parameters (data): Includes all list fields plus:

Parameter	Type	Description
eToday/eMonth/eYear/eTotal	Number	Today/Month/Year/Total energy
fac	Number	Grid frequency
pac	Number	Real-time power
iAc1/iAc2/iAc3	Number	AC current R/S/T
uAc1/uAc2/uAc3	Number	AC voltage R/S/T
iPv1~iPv32	Number	DC current 1~32
uPv1~uPv32	Number	DC voltage 1~32
batteryCapacitySoc	Number	Battery SOC
batteryPower	Number	Battery power
batteryCapacity	Number	Battery capacity
gridPurchasedTodayEnergy	Number	Today's grid purchased energy
gridSellTodayEnergy	Number	Today's grid sold energy
familyLoadPower	Number	Home load power
pSum	Number	Grid total active power
inverterMeterModel	Integer	Meter type, see Appendix 3
type	Integer	Inverter type: 1=grid-tied, 2=energy storage
hmiVersionAll	String	Full HMI version

Inverter Day/Month/Year/All Data

Inverter Day Data

Endpoint: POST /v1/api/inverterDay

Parameter	Type	Required	Description
id	Number	No	Inverter ID
sn	String	No	Inverter SN
money	String	Yes	Currency unit, e.g. CNY
time	String	Yes	Date, format yyyy-MM-dd
timeZone	Integer	Yes	Plant timezone

Response Parameters (data array):

Parameter	Type	Description
dataTimestamp	Integer	Update time
timeStr	String	Time string
pac	Number	Power
eToday	Number	Today's energy
eTotal	Number	Total energy
uPv1~uPv4	Number	DC voltage 1~4
iPv1~iPv4	Number	DC current 1~4
batteryCapacitySoc	Number	Battery SOC
batteryPower	Number	Battery power

Inverter Month Data

Endpoint: POST /v1/api/inverterMonth

Parameter	Type	Required	Description
id/sn	-	No	Inverter ID or SN
money	String	Yes	Currency unit
month	String	Yes	Month, format yyyy-MM

Response Parameters (data array):

Parameter	Type	Description
energy	Number	Energy
energyStr	String	Energy unit
date	String	Date
money	Number	Revenue
moneyStr	String	Revenue unit
batteryDischargeEnergy	Number	Battery discharge energy
batteryChargeEnergy	Number	Battery charge energy
gridPurchasedEnergy	Number	Grid purchased energy
gridSellEnergy	Number	Grid sold energy

Inverter Year Data

Endpoint: POST /v1/api/inverterYear

Parameter	Type	Required	Description
id/sn	-	No	Inverter ID or SN
money	String	Yes	Currency unit
year	String	Yes	Year, format yyyy

Response Parameters (data array): Same as month data.

Inverter All Data

Endpoint: POST /v1/api/inverterAll

Parameter	Type	Required	Description
id/sn	-	No	Inverter ID or SN
money	String	Yes	Currency unit

Response Parameters (data array):

Parameter	Type	Description
year	String	Year
energy	Number	Energy
batteryDischargeEnergy	Number	Battery discharge energy
batteryChargeEnergy	Number	Battery charge energy
gridPurchasedEnergy	Number	Grid purchased energy
gridSellEnergy	Number	Grid sold energy

Get Inverter Warranty Data

Endpoint: POST /v1/api/inverter/shelfTime

Parameter	Type	Required	Description
sn	String	No	Single or multiple SNs, comma-separated, max 1000
minId	Long	No	Starting ID (inclusive); paging is ordered by `id` ascending. Omit to start from the smallest ID.

Response Parameters (data.page.records):

Parameter	Type	Description
id	Number	Inverter ID
sn	String	Inverter SN
shelfBeginTime	String	Warranty start time
shelfEndTime	String	Warranty end time
shelfTime	String	Warranty duration
shelfState	Integer	Warranty state: 0=warranty, 1=expired

Get Alarm List

Endpoint: POST /v1/api/alarmList

Parameter	Type	Required	Description
stationId	Integer	No	Plant ID
plantId	String	No	Plant code, same effect as stationId
alarmDeviceSn	String	No	Inverter SN
alarmBeginTime	String	No	Start date, yyyy-MM-dd
alarmEndTime	String	No	End date, yyyy-MM-dd
nmiCode	String	No	NMI code
State	Integer	No	0=unprocessed, 1=processed, 2=recovered
minId	Long	No	Starting ID (inclusive); paging is ordered by `alarmId` ascending. Omit to start from the smallest ID.

Response Parameters (data.page.records):

Parameter	Type	Description
stationId	Integer	Plant ID
stationName	String	Plant name
alarmDeviceSn	String	Alarm device SN
alarmCode	String	Alarm code
alarmLevel	Integer	Alarm level: 1=info, 2=normal, 3=urgent
alarmBeginTime	String	Alarm start time
alarmEndTime	String	Alarm end time
alarmMsg	String	Alarm message
advice	String	Handling advice
state	Integer	State: 0=unhandled, 1=handled, 2=recovered
warningInfoData	Object	Alarm extended data

Collector Interface Details

Get Collector List

Retrieve the list of collectors under the account. Maximum 100 devices per call.

Endpoint: POST /v1/api/collectorList

Request Parameters:

Parameter	Type	Required	Description
stationId	Integer	No	Plant ID
plantId	String	No	Plant code, same effect as stationId
nmiCode	String	No	NMI code (Australia only)
minId	Long	No	Starting ID (inclusive); paging is ordered by `collector_id` ascending. Omit to start from the smallest ID.

Response Parameters (data):

Parameter	Type	Description
page	Object	Pagination result
page.total	Integer	Always 0 (cursor pagination does not return the real total)
page.records	Array	Collector list
collectionStatusVo	Object	Collector status summary
collectionStatusVo.all	Integer	Total count
collectionStatusVo.normal	Integer	Normal count
collectionStatusVo.offline	Integer	Offline count
collectionStatusVo.fault	Integer	Fault count

records fields:

Parameter	Type	Description
id	Number	Collector ID
sn	String	Collector SN
stationId	Integer	Plant ID
stationName	String	Plant name
model	String	Collector model
name	String	Collector name
rssiLevel	Integer	Signal strength level
state	Integer	Status: 1=online, 2=offline, 3=alarm
dataTimestamp	Integer	Data update timestamp
contractTime	String	Expiry time

Get Collector Detail

Endpoint: POST /v1/api/collectorDetail

Request Parameters:

Parameter	Type	Required	Description
id	Number	No	Collector ID, id and sn cannot both be empty
sn	String	No	Collector SN

Response Parameters (data): Contains all list fields, plus:

Parameter	Type	Description
maximumNumber	Integer	Max connected devices
actualNumber	Integer	Actual connected devices
currentWorkingTime	Integer	Current session uptime
totalWorkingTime	Integer	Cumulative uptime
dataUploadCycle	Integer	Data upload interval (seconds)
factoryTime	String	Manufacturing date

Get Collector Signal Values

Endpoint: POST /v1/api/collector/day

Request Parameters:

Parameter	Type	Required	Description
sn	String	Yes	Collector SN
time	String	Yes	Date, format yyyy-MM-dd
timeZone	Integer	Yes	Plant timezone

Response Parameters (data array):

Parameter	Type	Description
collectorId	Number	Collector ID
collectorSn	String	Collector SN
dataTimestamp	Integer	Data timestamp
timeStr	String	Time string
pec	Number	Signal quality (%)
rssi	Number	Received signal strength
rssiLevel	Integer	Signal level

EPM Interface Details

Get EPM List

Retrieve the list of EPM devices under the account. Maximum 100 devices per call.

Endpoint: POST /v1/api/epmList

Request Parameters:

Parameter	Type	Required	Description
stationId	Integer	No	Plant ID
plantId	String	No	Plant code, same effect as stationId
nmiCode	String	No	NMI code (Australia only)
minId	Long	No	Starting ID (inclusive); paging is ordered by `epm_id` ascending. Omit to start from the smallest ID.

Response Parameters (data.page.records):

Parameter	Type	Description
id	Number	EPM ID
sn	String	EPM SN
collectorId	Number	Collector ID
collectorSn	String	Collector SN
stationId	Integer	Plant ID
state	Integer	Status: 1=online, 2=offline, 3=alarm
dataTimestamp	Integer	Data update timestamp
failSafe	Integer	Fail-safe status
pEpmTotal	Number	EPM total power
pEpmTotalStr	String	Power unit
eTotalBuy	Number	Total grid purchase energy
eTotalBuyStr	String	Purchase energy unit
eTotalSell	Number	Total grid sell energy
eTotalSellStr	String	Sell energy unit

Get EPM Detail

Endpoint: POST /v1/api/epmDetail

Request Parameters:

Parameter	Type	Required	Description
sn	String	Yes	EPM SN

Response Parameters (data): Contains all list fields, plus:

Parameter	Type	Description
empSoftwareVersion	String	EPM firmware version
pLimit	Number	Power limit
ctRatio	Number	CT ratio
pSet	Number	Power setpoint
pInverterTotal	Number	Total inverter power
eToaalInverter	Number	Total inverter energy
pLoad	Number	Load power
eTotalLoad	Number	Total load energy
iAc1 / iAc2 / iAc3	Number	AC current U/V/W (A)
uAc1 / uAc2 / uAc3	Number	AC voltage U/V/W (V)
pAc1 / pAc2 / pAc3	Number	Active power U/V/W (W)
powerFactor	Number	Grid power factor
facMeter	Number	Grid frequency (Hz)

Get EPM Day Data

Endpoint: POST /v1/api/epm/day

Parameter	Type	Required	Description
sn	String	Yes	EPM SN
searchinfo	String	Yes	Query fields, comma-separated
time	String	Yes	Date, yyyy-MM-dd
timeZone	Number	Yes	Plant timezone

searchinfo field mapping:

searchinfo	Response field	Description
u_ac1/u_ac2/u_ac3	uAc1/uAc2/uAc3	AC voltage U/V/W
i_ac1/i_ac2/i_ac3	iAc1/iAc2/iAc3	AC current U/V/W
p_ac1/p_ac2/p_ac3	pAc1/pAc2/pAc3	Active power U/V/W
power_factor	powerFactor	Grid power factor
fac_meter	facMeter	Grid frequency
p_load	pLoad	Total load power
e_epm_total	pEpmTotal	EPM total power
e_total_buy	eTotalBuy	Grid purchased energy
e_total_sell	eTotalSell	Grid sold energy

EPM Month Data

Endpoint: POST /v1/api/epm/month

Parameter	Type	Required	Description
sn	String	Yes	EPM SN
month	String	Yes	Month, format yyyy-MM

Response Parameters (data array):

Parameter	Type	Description
date	String	Date
energy	Number	Energy
epmSellEnergy	Number	Sell energy
epmBuyEnergy	Number	Purchase energy

EPM Year Data

Endpoint: POST /v1/api/epm/year

Parameter	Type	Required	Description
sn	String	Yes	EPM SN
year	String	Yes	Year, format yyyy

Response Parameters (data array): Same fields as month data.

EPM All Data

Endpoint: POST /v1/api/epm/all

Parameter	Type	Required	Description
sn	String	Yes	EPM SN

Response Parameters (data):

Parameter	Type	Description
energy	Number	Cumulative energy
epmSellEnergy	Number	Cumulative sell energy
epmBuyEnergy	Number	Cumulative purchase energy

Weather Station Interface Details

Get Weather Station List

Retrieve the list of weather stations under the account.

Endpoint: POST /v1/api/weatherList

Request Parameters:

Parameter	Type	Required	Description
stationId	Integer	No	Plant ID
plantId	String	No	Plant code, same effect as stationId
nmiCode	String	No	NMI code (Australia only)
minId	Long	No	Starting ID (inclusive); paging is ordered by `weather_id` ascending. Omit to start from the smallest ID.

Response Parameters (data.page.records):

Parameter	Type	Description
id	Number	Weather station ID
collectorSn	String	Collector SN
name	String	Weather station name
weatherModel	Integer	Model: 1=Jinzhou Yangguang, 2=Jinzhou Licheng
stationId	Integer	Plant ID
state	Integer	Status: 1=online, 2=offline
dataTimestamp	Integer	Data update timestamp
totalR	Number	Total radiation (W/㎡)
directR	Number	Direct radiation
scatteredR	Number	Scattered radiation
sunshineTim	Number	Sunshine duration (minutes)
totalRday	Number	Daily total radiation (MJ/㎡)
temp	Number	Ambient temperature
temperatureUnit	String	Temperature unit
humidity	Number	Humidity (%RH)
windDirection	String	Wind direction
windSpeed	Number	Wind speed (m/s)
airPressure	Number	Air pressure (Pa)
rainfall	Number	Rainfall (mm)
pvTemp	Number	Module temperature

Get Weather Station Detail

Endpoint: POST /v1/api/weatherDetail

Request Parameters:

Parameter	Type	Required	Description
sn	String	Yes	Weather station SN

Response Parameters (data): Same fields as list.

Ammeter Interface Details (User-level only)

Get Ammeter List

Retrieve the list of ammeters under the account.

Endpoint: POST /v1/api/ammeterList

Request Parameters:

Parameter	Type	Required	Description
stationId	Integer	No	Plant ID
plantId	String	No	Plant code, same effect as stationId
nmiCode	String	No	NMI code (Australia only)
minId	Long	No	Starting ID (inclusive); paging is ordered by `ammeter_id` ascending. Omit to start from the smallest ID.

Response Parameters (data.page.records):

Parameter	Type	Description
id	Number	Ammeter ID
sn	String	Ammeter SN
collectorId	Number	Collector ID
collectorSn	String	Collector SN
name	String	Ammeter name
stationId	Integer	Plant ID
state	Integer	Status: 1=online, 2=offline
dataTimestamp	Integer	Data update timestamp
psum	Number	Total active power
psumStr	String	Power unit
eTodayPositiveActive	Number	Today's positive active energy
eTodayReverseActive	Number	Today's reverse active energy
eTotalPositiveActive	Number	Cumulative positive active energy
eTotalReverseActive	Number	Cumulative reverse active energy

Get Ammeter Detail

Endpoint: POST /v1/api/ammeterDetail

Request Parameters:

Parameter	Type	Required	Description
sn	String	Yes	Ammeter SN

Response Parameters (data): Contains all list fields, plus:

Parameter	Type	Description
currentTransformer	Number	CT ratio
electricMeter	Integer	Meter type: 0=single-phase, other=three-phase
pA / pB / pC	Number	Phase A/B/C active power (W)
aReactivePower / bReactivePower / cReactivePower	Number	Phase A/B/C reactive power (Var)
aLookedPower / bLookedPower / cLookedPower	Number	Phase A/B/C apparent power (VA)
uA / uB / uC	Number	Phase A/B/C voltage (V)
iA / iB / iC	Number	Phase A/B/C current (A)
totalReactivePower	Number	Total reactive power
totalViewPower	Number	Total apparent power
fAc	Number	Grid frequency (Hz)
averagePowerFactor	Number	Average power factor

Plant Interface Details

Get Plant List

Retrieve the list of plants under the account.

Endpoint: POST /v1/api/userStationList

Request Parameters:

Parameter	Type	Required	Description
plantId	String	No	Plant code
nmiCode	String	No	NMI code (Australia only)
idList	Array	No	Plant ID list for batch query
minId	Long	No	Starting ID (inclusive); paging is ordered by `station_id` ascending. Omit to start from the smallest ID.

Response Parameters (data.page.records):

Parameter	Type	Description
id	Number	Plant ID
stationName	String	Plant name
addr	String	Plant address
userId	Number	User ID
userName	String	User name
capacity	Number	Installed capacity
capacityStr	String	Capacity unit
fullHour	Number	Full-power hours
latitude	String	Latitude
longitude	String	Longitude
timeZone	Integer	Timezone
timeZoneStr	String	Timezone description
money	String	Currency unit
price	Number	Electricity price
power	Number	Real-time power
powerStr	String	Power unit
dayEnergy	Number	Today's energy
monthEnergy	Number	This month's energy
yearEnergy	Number	This year's energy
allEnergy	Number	Cumulative energy
state	Integer	Status
dataTimestamp	Integer	Data update timestamp
stationTypeNew	Integer	Plant type, see Appendix 2
nmiCode	String	NMI code
inverterPower	Number	Inverter power
synchronizationType	Integer	Grid connection type
daylightSwitch	Integer	Daylight switch
timeZoneStandardId	String	Standard timezone, e.g. Asia/Shanghai

Get Plant Detail

Endpoint: POST /v1/api/stationDetail

Request Parameters:

Parameter	Type	Required	Description
id	Number	No	Plant ID, one of id/plantId/nmiCode required
plantId	String	No	Plant code
nmiCode	String	No	NMI code

Response Parameters (data): Contains all list fields, plus:

Parameter	Type	Description
dayInCome	Number	Today's revenue
monthInCome	Number	This month's revenue
yearInCome	Number	This year's revenue
allInCome	Number	Cumulative revenue
batteryPower	Number	Battery power
batteryDischargeEnergy	Number	Battery discharge energy
batteryChargeEnergy	Number	Battery charge energy
batteryPercent	Number	Battery SOC (%)
psum	Number	Total grid power
gridPurchasedDayEnergy	Number	Today's grid purchase energy
gridSellDayEnergy	Number	Today's grid sell energy
familyLoadPower	Number	Home load power
homeLoadEnergy	Number	Home load energy
inverterBatteryCapacity	Number	Battery capacity
batteryCapacity	Number	Battery capacity
timeZoneStandardId	String	Standard timezone, e.g. Asia/Shanghai

Plant Day Energy List

Retrieve daily energy data for multiple plants.

Endpoint: POST /v1/api/stationDayEnergyList

Request Parameters:

Parameter	Type	Required	Description
time	String	Yes	Date, format yyyy-MM-dd
stationIds	String	No	Plant IDs, comma-separated
plantId	String	No	Plant code
idList	Array	No	Plant ID list
minId	Long	No	Starting ID (inclusive); paging is ordered by `station_id` ascending. Omit to start from the smallest ID.
beginTime	String	No	Start time, format: yyyy-MM-dd, default: 30 days ago
endTime	String	No	End time, format: yyyy-MM-dd, default: today

Response Parameters (data.page.records):

Parameter	Type	Description
id	Number	Plant ID
energy	Number	Energy
energyStr	String	Energy unit
date	String	Date
money	Number	Revenue
batteryDischargeEnergy	Number	Battery discharge energy
batteryChargeEnergy	Number	Battery charge energy
gridPurchasedEnergy	Number	Grid purchase energy
gridSellEnergy	Number	Grid sell energy
totalRKwh	Number	Radiation per area (kWh/㎡)

Plant Month Energy List

Retrieve monthly energy data for multiple plants. Rate limit: 10 times/sec.

Endpoint: POST /v1/api/stationMonthEnergyList

Request Parameters:

Parameter	Type	Required	Description
time	String	Yes	Month, format yyyy-MM
stationIds	String	No	Plant IDs, comma-separated
plantId	String	No	Plant code
nmiCode	String	No	NMI code
idList	Array	No	Plant ID list
minId	Long	No	Starting ID (inclusive); paging is ordered by `station_id` ascending. Omit to start from the smallest ID.

Response Parameters: Same fields as day energy list.

Plant Year Energy List

Retrieve yearly energy data for multiple plants. Rate limit: 10 times/sec.

Endpoint: POST /v1/api/stationYearEnergyList

Request Parameters:

Parameter	Type	Required	Description
time	String	Yes	Year, format yyyy
stationIds	String	No	Plant IDs, comma-separated
plantId	String	No	Plant code
nmiCode	String	No	NMI code
idList	Array	No	Plant ID list
minId	Long	No	Starting ID (inclusive); paging is ordered by `station_id` ascending. Omit to start from the smallest ID.

Response Parameters: Same fields as day energy list.

Plant Day Data

Retrieve real-time data for a single plant on a specific day.

Endpoint: POST /v1/api/stationDay

Request Parameters:

Parameter	Type	Required	Description
id	Number	No	Plant ID, one of id/plantId/nmiCode required
plantId	String	No	Plant code
nmiCode	String	No	NMI code
money	String	Yes	Currency unit, e.g. CNY
time	String	Yes	Date, format yyyy-MM-dd
timeZone	Integer	Yes	Plant timezone

Response Parameters (data array):

Parameter	Type	Description
power	Number	Power
time	String	Time point
totalR	Number	Instantaneous radiation
batteryCapacitySoc	Number	Battery SOC (%)
familyLoadPower	Number	Home load power
batteryPower	Number	Battery power
psum	Number	Total grid power

Plant Month Data

Endpoint: POST /v1/api/stationMonth

Request Parameters:

Parameter	Type	Required	Description
id	Number	No	Plant ID, one of three required
plantId	String	No	Plant code
nmiCode	String	No	NMI code
money	String	Yes	Currency unit
month	String	Yes	Month, format yyyy-MM
timeZone	Integer	Yes	Plant timezone

Response Parameters (data array):

Parameter	Type	Description
energy	Number	Energy
date	String	Date
money	Number	Revenue
batteryDischargeEnergy	Number	Battery discharge energy
batteryChargeEnergy	Number	Battery charge energy
gridPurchasedEnergy	Number	Grid purchase energy
gridSellEnergy	Number	Grid sell energy
totalRKwh	Number	Radiation per area (kWh/㎡)

Plant Year Data

Same parameters as month data, using year (format yyyy) instead of month. Same response fields.

Endpoint: POST /v1/api/stationYear

Plant All Data

Endpoint: POST /v1/api/stationAll

Request Parameters:

Parameter	Type	Required	Description
id	Number	No	Plant ID, one of three required
plantId	String	No	Plant code
nmiCode	String	No	NMI code
money	String	Yes	Currency unit
timeZone	Integer	Yes	Plant timezone

Response Parameters (data):

Parameter	Type	Description
year	String	Year
energy	Number	Cumulative energy
money	Number	Cumulative revenue
batteryDischargeEnergy	Number	Cumulative battery discharge
batteryChargeEnergy	Number	Cumulative battery charge
gridPurchasedEnergy	Number	Cumulative grid purchase
gridSellEnergy	Number	Cumulative grid sell
totalRKwh	Number	Cumulative radiation per area (kWh/㎡)

Appendix

Appendix 1: Error Codes

Code	Description
R0000	No permission
B0001	Already bound to another user
I0003	Please enter SN
B0049	Collector does not exist or no permission
I0000	Required parameter is empty
B0011	User does not exist
I0012	Account or password error

Appendix 2: Plant Types

Code	Description
0	Grid-tied plant
1	Energy storage plant
2	AC Couple plant
3	EPM plant (grid-tied + meter)
4	Built-in meter (grid-tied + meter)
5	External meter
6	S5 Off-grid parallel storage
7	S5 Grid-tied parallel storage
8	Grid-tied + AC Couple plant
9	Off-grid storage
10	S6 Grid-tied parallel storage
11	S6 Off-grid parallel storage

Appendix 3: Inverter Meter Types

Code	Description
1	Grid-tied
2	Grid-tied + load-side meter
3	Grid-tied + grid-side meter
4	Storage + load-side meter
5	Storage + grid-side meter
7	Off-grid storage
8	Grid-tied storage dual meter
1001	AC Couple (without CT)
1002	AC Couple (with CT)

Data Access API (User Auth) ​

Common Response Format ​

Pagination ​

Rate Limits ​

Authentication ​

Interface List ​

Inverter Interfaces ​

Collector Interfaces ​

EPM Interfaces ​

Weather Station Interfaces ​

Ammeter Interfaces (User-level only) ​

Plant Interfaces ​

Inverter Interface Details ​

Get Inverter List ​

Get Inverter Detail ​

Inverter Day/Month/Year/All Data ​

Inverter Day Data ​

Inverter Month Data ​

Inverter Year Data ​

Inverter All Data ​

Get Inverter Warranty Data ​

Get Alarm List ​

Collector Interface Details ​

Get Collector List ​

Get Collector Detail ​

Get Collector Signal Values ​

EPM Interface Details ​

Get EPM List ​

Get EPM Detail ​

Get EPM Day Data ​

EPM Month Data ​

EPM Year Data ​

EPM All Data ​

Weather Station Interface Details ​

Get Weather Station List ​

Get Weather Station Detail ​

Ammeter Interface Details (User-level only) ​

Get Ammeter List ​

Get Ammeter Detail ​

Plant Interface Details ​

Get Plant List ​

Get Plant Detail ​

Plant Day Energy List ​

Plant Month Energy List ​

Plant Year Energy List ​

Plant Day Data ​

Plant Month Data ​

Plant Year Data ​

Plant All Data ​

Appendix ​

Appendix 1: Error Codes ​

Appendix 2: Plant Types ​

Appendix 3: Inverter Meter Types ​

Data Access API (User Auth)

Common Response Format

Pagination

Rate Limits

Authentication

Interface List

Inverter Interfaces

Collector Interfaces

EPM Interfaces

Weather Station Interfaces

Ammeter Interfaces (User-level only)

Plant Interfaces

Inverter Interface Details

Get Inverter List

Get Inverter Detail

Inverter Day/Month/Year/All Data

Inverter Day Data

Inverter Month Data

Inverter Year Data

Inverter All Data

Get Inverter Warranty Data

Get Alarm List

Collector Interface Details

Get Collector List

Get Collector Detail

Get Collector Signal Values

EPM Interface Details

Get EPM List

Get EPM Detail

Get EPM Day Data

EPM Month Data

EPM Year Data

EPM All Data

Weather Station Interface Details

Get Weather Station List

Get Weather Station Detail

Ammeter Interface Details (User-level only)

Get Ammeter List

Get Ammeter Detail

Plant Interface Details

Get Plant List

Get Plant Detail

Plant Day Energy List

Plant Month Energy List

Plant Year Energy List

Plant Day Data

Plant Month Data

Plant Year Data

Plant All Data

Appendix

Appendix 1: Error Codes

Appendix 2: Plant Types

Appendix 3: Inverter Meter Types