SmartPVMS 24.2.0 Northbound API Reference
Monitoring
Real-Time Plant Data API
API Description
This API is used to obtain real-time plant data by plant ID set. Data of a maximum of 100 plants can be queried at a time.
For details about the data list that can be queried through this API, see the real-time plant data list below.
Request URL
https://Domain name of the management system/thirdData/getStationRealKpi
Request Mode
HTTP method: POST
Request Parameters
Parameter |
Description |
Data Type |
Mandatory/Optional |
---|---|---|---|
stationCodes |
Plant ID list. Multiple plant IDs are separated by commas (,). The plant IDs are obtained from plantCode in Plant List API. |
String |
Mandatory |
Response Packet
Parameter |
Description |
Type |
Remarks |
|
---|---|---|---|---|
success |
Request success or failure flag true: The request succeeded. false: The request failed. |
Boolean |
Request success or failure flag |
|
failCode |
Error code Value 0 indicates that the status is normal. For other error codes, see Error Code List. |
Integer |
- |
|
params |
Parameters |
- |
- |
- |
stationCodes |
Plant ID list in the request parameter |
String |
- |
|
currentTime |
Current system time, in milliseconds |
Long |
- |
|
message |
Optional message |
String |
- |
|
data |
Parameters |
Returned data. The data contains the real-time data object list of each plant. |
List |
- |
stationCode |
Plant ID |
String |
- |
|
dataItemMap |
Content of each data item, which is returned in the key-value format. For details about the data item list, see the real-time plant data list below. |
Map |
- |
Real-Time Plant Data List
Key |
Name |
Unit |
Return Value Type |
---|---|---|---|
day_power |
Yield today |
kWh |
Double |
month_power |
Yield this month |
kWh |
Double |
total_power |
Total yield |
kWh |
Double |
day_income |
Revenue today |
The currency specified in the management system |
Double |
total_income |
Total revenue |
The currency specified in the management system |
Double |
real_health_state |
Plant health status The following plant health states are supported: 1: disconnected 2: faulty 3: healthy |
None |
Integer |
Example
Request example:
{ "stationCodes":"BA4372D08E014822AB065017416F254C,5D02E8B40AD342159AC8D8A2BCD4FAB5" }
Response example:
Example 1: An error code is returned.
{ "success":false, "data":null, "failCode":20009, "params":{ "stationCodes":"BA4372D08E014822AB065017416F254C,5D02E8B40AD342159AC8D8A2BCD4FAB5", "currentTime":1503046597854 }, "message":null }
Example 2: Real-time plant data is returned.
{ "success":true, "data":[ { "dataItemMap":{ "real_health_state":"3", "day_power":"10000", "total_power":"900.000", "day_income":"0.000", "month_power":"900.000", "total_income":"2088.000" }, "stationCode":"BA4372D08E014822AB065017416F254C" }, { "dataItemMap":{ "real_health_state":"1", "day_power":"16770.000", "total_power":"35100.000", "day_income":"26832.000", "month_power":"35100.000", "total_income":"61152.000" }, "stationCode":"5D02E8B40AD342159AC8D8A2BCD4FAB5" } ], "failCode":0, "params":{ "stationCodes":"BA4372D08E014822AB065017416F254C,5D02E8B40AD342159AC8D8A2BCD4FAB5", "currentTime":1503046597854 }, "message":null }
Prerequisites for obtaining data: The API account has the permission to access this API.
Request example:
Real-Time Device Data API
API Description
This API is used to obtain real-time device data by device type and device ID set. The data varies depending on device types. Data of a maximum of 100 devices of the same type can be queried at a time.
For details about the data list that can be queried through this API, see the real-time device data list below.
Request URL
https://Domain name of the management system/thirdData/getDevRealKpi
Request Mode
HTTP method: POST
Request Parameters
Parameter |
Description |
Data Type |
Mandatory/Optional |
---|---|---|---|
devIds |
List of device IDs. The device IDs are obtained from id in Device List API. Use commas (,) to separate multiple device IDs. Either sns or devIds must be set. |
String |
Optional |
sns |
Device SN list. Multiple device SNs are separated by commas (,). Either sns or devIds must be set. |
String |
Optional |
devTypeId |
Device type ID. The values of devTypeId obtained in Device List API are used. The following device types are supported: 1: string inverter 10: EMI 17: grid meter 38: residential inverter 39: battery 41: ESS 47: power sensor 60001: mains 60003: genset 60043: SSU group 60044: SSU 60092: power converter 60014: lithium battery rack 60010: AC output power distribution |
Integer |
Mandatory |
Response Packet
Parameter |
Description |
Data Type |
Remarks |
|
---|---|---|---|---|
success |
Request success or failure flag true: The request succeeded. false: The request failed. |
Boolean |
Request success or failure flag |
|
failCode |
Error code Value 0 indicates that the status is normal. For other error codes, see Error Code List. |
Integer |
- |
|
params |
Parameters |
- |
- |
- |
devIds |
Device ID list in the request parameter |
String |
- |
|
sns |
Device SN list in the request parameter |
String |
- |
|
devTypeId |
Device type ID in the request parameter |
Integer |
- |
|
currentTime |
Current system time, in milliseconds |
Long |
- |
|
message |
Optional message |
String |
- |
|
data |
Parameters |
Returned data. The data contains the real-time data object list of each device. |
List |
- |
devId |
Device ID |
Long |
- |
|
sn |
Device SN |
String |
||
dataItemMap |
Content of data items, which are returned in the key-value format. Content of each data item, which is returned in the key-value format. The data item content varies depending on the device type. For details about the data item list, see the real-time device data list below. |
Map |
Real-time device data |
Real-Time Device Data List
Device Type |
Key |
Name |
Unit |
Return Value Type |
Remarks |
---|---|---|---|---|---|
ID: 1 String inverter |
inverter_state |
Inverter state. For details, see Table 5-1. |
None |
Double |
|
ab_u |
A-B line voltage of grid |
V |
Double |
||
bc_u |
B-C line voltage of grid |
V |
Double |
||
ca_u |
C-A line voltage of grid |
V |
Double |
||
a_u |
Phase A voltage |
V |
Double |
||
b_u |
Phase B voltage |
V |
Double |
||
c_u |
Phase C voltage |
V |
Double |
||
a_i |
Phase A current of grid |
A |
Double |
||
b_i |
Phase B current of grid |
A |
Double |
||
c_i |
Phase C current of grid |
A |
Double |
||
efficiency |
Inverter conversion efficiency (manufacturer) |
% |
Double |
||
temperature |
Internal temperature |
°C |
Double |
||
power_factor |
Power factor |
None |
Double |
||
elec_freq |
Grid frequency |
Hz |
Double |
||
active_power |
Active power |
kW |
Double |
||
reactive_power |
Output reactive power |
kVar |
Double |
||
day_cap |
Yield today |
kWh |
Double |
||
mppt_power |
MPPT total input power |
kW |
Double |
||
pv1_u |
PV1 input voltage |
V |
Double |
||
pv2_u |
PV2 input voltage |
V |
Double |
||
pv3_u |
PV3 input voltage |
V |
Double |
||
pv4_u |
PV4 input voltage |
V |
Double |
||
pv5_u |
PV5 input voltage |
V |
Double |
||
pv6_u |
PV6 input voltage |
V |
Double |
||
pv7_u |
PV7 input voltage |
V |
Double |
||
pv8_u |
PV8 input voltage |
V |
Double |
||
pv9_u |
PV9 input voltage |
V |
Double |
||
pv10_u |
PV10 input voltage |
V |
Double |
||
pv11_u |
PV11 input voltage |
V |
Double |
||
pv12_u |
PV12 input voltage |
V |
Double |
||
pv13_u |
PV13 input voltage |
V |
Double |
||
pv14_u |
PV14 input voltage |
V |
Double |
||
pv15_u |
PV15 input voltage |
V |
Double |
||
pv16_u |
PV16 input voltage |
V |
Double |
||
pv17_u |
PV17 input voltage |
V |
Double |
||
pv18_u |
PV18 input voltage |
V |
Double |
||
pv19_u |
PV19 input voltage |
V |
Double |
||
pv20_u |
PV20 input voltage |
V |
Double |
||
pv21_u |
PV21 input voltage |
V |
Double |
||
pv22_u |
PV22 input voltage |
V |
Double |
||
pv23_u |
PV23 input voltage |
V |
Double |
||
pv24_u |
PV24 input voltage |
V |
Double |
||
pv25_u |
PV25 input voltage |
V |
Double |
||
pv26_u |
PV26 input voltage |
V |
Double |
||
pv27_u |
PV27 input voltage |
V |
Double |
||
pv28_u |
PV28 input voltage |
V |
Double |
||
pv1_i |
PV1 input current |
A |
Double |
||
pv2_i |
PV2 input current |
A |
Double |
||
pv3_i |
PV3 input current |
A |
Double |
||
pv4_i |
PV4 input current |
A |
Double |
||
pv5_i |
PV5 input current |
A |
Double |
||
pv6_i |
PV6 input current |
A |
Double |
||
pv7_i |
PV7 input current |
A |
Double |
||
pv8_i |
PV8 input current |
A |
Double |
||
pv9_i |
PV9 input current |
A |
Double |
||
pv10_i |
PV10 input current |
A |
Double |
||
pv11_i |
PV11 input current |
A |
Double |
||
pv12_i |
PV12 input current |
A |
Double |
||
pv13_i |
PV13 input current |
A |
Double |
||
pv14_i |
PV14 input current |
A |
Double |
||
pv15_i |
PV15 input current |
A |
Double |
||
pv16_i |
PV16 input current |
A |
Double |
||
pv17_i |
PV17 input current |
A |
Double |
||
pv18_i |
PV18 input current |
A |
Double |
||
pv19_i |
PV19 input current |
A |
Double |
||
pv20_i |
PV20 input current |
A |
Double |
||
pv21_i |
PV21 input current |
A |
Double |
||
pv22_i |
PV22 input current |
A |
Double |
||
pv23_i |
PV23 input current |
A |
Double |
||
pv24_i |
PV24 input current |
A |
Double |
||
pv25_i |
PV25 input current |
A |
Double |
||
pv26_i |
PV26 input current |
A |
Double |
||
pv27_i |
PV27 input current |
A |
Double |
||
pv28_i |
PV28 input current |
A |
Double |
||
total_cap |
Total yield |
kWh |
Double |
||
open_time |
Inverter startup time |
ms |
Double |
||
close_time |
Inverter shutdown time |
ms |
Double |
||
mppt_total_cap |
Total DC input energy |
kWh |
Double |
||
mppt_1_cap |
MPPT 1 DC total yield |
kWh |
Double |
||
mppt_2_cap |
MPPT 2 DC total yield |
kWh |
Double |
||
mppt_3_cap |
MPPT 3 DC total yield |
kWh |
Double |
||
mppt_4_cap |
MPPT 4 DC total yield |
kWh |
Double |
||
mppt_5_cap |
MPPT 5 DC total yield |
kWh |
Double |
||
mppt_6_cap |
MPPT 6 DC total yield |
kWh |
Double |
||
mppt_7_cap |
MPPT 7 DC total yield |
kWh |
Double |
||
mppt_8_cap |
MPPT 8 DC total yield |
kWh |
Double |
||
mppt_9_cap |
MPPT 9 DC total yield |
kWh |
Double |
||
mppt_10_cap |
MPPT 10 DC total yield |
kWh |
Double |
||
run_state |
State (0: Disconnected 1: Connected) |
None |
Long |
||
ID: 38 Residential inverter |
inverter_state |
Inverter state. For details, see Table 5-1. |
None |
Double |
|
ab_u |
A-B line voltage of grid |
V |
Double |
||
bc_u |
B-C line voltage of grid |
V |
Double |
||
ca_u |
C-A line voltage of grid |
V |
Double |
||
a_u |
Phase A voltage |
V |
Double |
||
b_u |
Phase B voltage |
V |
Double |
||
c_u |
Phase C voltage |
V |
Double |
||
a_i |
Phase A current of grid |
A |
Double |
||
b_i |
Phase B current of grid |
A |
Double |
||
c_i |
Phase C current of grid |
A |
Double |
||
efficiency |
Inverter conversion efficiency (manufacturer) |
% |
Double |
||
temperature |
Internal temperature |
°C |
Double |
||
power_factor |
Power factor |
None |
Double |
||
elec_freq |
Grid frequency |
Hz |
Double |
||
active_power |
Active power |
kW |
Double |
||
reactive_power |
Output reactive power |
kVar |
Double |
||
day_cap |
Yield today |
kWh |
Double |
||
mppt_power |
MPPT total input power |
kW |
Double |
||
pv1_u |
PV1 input voltage |
V |
Double |
||
pv2_u |
PV2 input voltage |
V |
Double |
||
pv3_u |
PV3 input voltage |
V |
Double |
||
pv4_u |
PV4 input voltage |
V |
Double |
||
pv5_u |
PV5 input voltage |
V |
Double |
||
pv6_u |
PV6 input voltage |
V |
Double |
||
pv7_u |
PV7 input voltage |
V |
Double |
||
pv8_u |
PV8 input voltage |
V |
Double |
||
pv1_i |
PV1 input current |
A |
Double |
||
pv2_i |
PV2 input current |
A |
Double |
||
pv3_i |
PV3 input current |
A |
Double |
||
pv4_i |
PV4 input current |
A |
Double |
||
pv5_i |
PV5 input current |
A |
Double |
||
pv6_i |
PV6 input current |
A |
Double |
||
pv7_i |
PV7 input current |
A |
Double |
||
pv8_i |
PV8 input current |
A |
Double |
||
total_cap |
Total yield |
kWh |
Double |
||
open_time |
Inverter startup time |
ms |
Double |
||
close_time |
Inverter shutdown time |
ms |
Double |
||
mppt_1_cap |
MPPT 1 DC total yield |
kWh |
Double |
||
mppt_2_cap |
MPPT 2 DC total yield |
kWh |
Double |
||
mppt_3_cap |
MPPT 3 DC total yield |
kWh |
Double |
||
mppt_4_cap |
MPPT 4 DC total yield |
kWh |
Double |
||
run_state |
State (0: Disconnected 1: Connected) |
None |
Long |
||
ID: 10 Environmental monitoring instrument (EMI) |
temperature |
Temperature |
°C |
Double |
|
pv_temperature |
PV temperature |
°C |
Double |
||
wind_speed |
Wind speed |
m/s |
Double |
||
wind_direction |
Wind direction |
Degree |
Double |
||
radiant_total |
Daily irradiation |
MJ/m2 |
Double |
||
radiant_line |
Irradiance |
W/m2 |
Double |
||
horiz_radiant_line |
Horizontal irradiance |
W/m2 |
Double |
Invalid field. The default value is null. |
|
horiz_radiant_total |
Horizontal irradiation |
MJ/m2 |
Double |
Invalid field. The default value is null. |
|
run_state |
State (0: Disconnected 1: Connected) |
None |
Long |
||
ID: 17 Grid meter |
ab_u |
A-B line voltage of grid |
V |
Double |
|
bc_u |
B-C line voltage of grid |
V |
Double |
||
ca_u |
C-A line voltage of grid |
V |
Double |
||
a_u |
Phase A voltage (AC output) |
V |
Double |
||
b_u |
Phase B voltage (AC output) |
V |
Double |
||
c_u |
Phase C voltage (AC output) |
V |
Double |
||
a_i |
Phase A current of grid (IA) |
A |
Double |
||
b_i |
Phase B current of grid (IB) |
A |
Double |
||
c_i |
Phase C current of grid (IC) |
A |
Double |
||
active_power |
Active power |
kW |
Double |
||
power_factor |
Power factor |
None |
Double |
||
active_cap |
Active energy (positive active energy) |
kWh |
Double |
||
reactive_power |
Reactive power |
kVar |
Double |
||
reverse_active_cap |
Negative active energy |
kWh |
Double |
||
forward_reactive_cap |
Positive reactive energy |
kWh |
Double |
||
reverse_reactive_cap |
Negative reactive energy |
kWh |
Double |
||
active_power_a |
Active power PA |
kW |
Double |
||
active_power_b |
Active power PB |
kW |
Double |
||
active_power_c |
Active power PC |
kW |
Double |
||
reactive_power_a |
Reactive power QA |
kVar |
Double |
Invalid field. The default value is null. |
|
reactive_power_b |
Reactive power QB |
kVar |
Double |
Invalid field. The default value is null. |
|
reactive_power_c |
Reactive power QC |
kVar |
Double |
Invalid field. The default value is null. |
|
total_apparent_power |
Total apparent power |
kVA |
Double |
||
grid_frequency |
Grid frequency |
Hz |
Double |
Invalid field. The default value is null. |
|
reverse_active_peak |
Negative active energy (peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_power |
Negative active energy (shoulder) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_valley |
Negative active energy (off-peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_top |
Negative active energy (sharp) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_peak |
Positive active energy (peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_power |
Positive active energy (shoulder) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_valley |
Positive active energy (off-peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_top |
Positive active energy (sharp) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_peak |
Negative reactive energy (peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_power |
Negative reactive energy (shoulder) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_valley |
Negative reactive energy (off-peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_top |
Negative reactive energy (sharp) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_peak |
Positive reactive energy (peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_power |
Positive reactive energy (shoulder) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_valley |
Positive reactive energy (off-peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_top |
Positive reactive energy (sharp) |
kVar |
Double |
Invalid field. The default value is null. |
|
ID: 47 Power sensor |
meter_status |
Meter state (0: offline; 1: normal) |
None |
Double |
|
meter_u |
Phase A voltage (AC output) |
V |
Double |
||
meter_i |
Phase A current of grid (IA) |
A |
Double |
||
active_power |
Active power |
W |
Double |
||
reactive_power |
Reactive power |
Var |
Double |
||
power_factor |
Power factor |
None |
Double |
||
grid_frequency |
Grid frequency |
Hz |
Double |
||
active_cap |
Active energy (positive active energy) |
kWh |
Double |
||
reverse_active_cap |
Negative active energy |
kWh |
Double |
||
run_state |
State (0: Disconnected 1: Connected) |
None |
Long |
||
ab_u |
A-B line voltage of grid |
V |
Double |
||
bc_u |
B-C line voltage of grid |
V |
Double |
||
ca_u |
C-A line voltage of grid |
V |
Double |
||
b_u |
Phase B voltage (AC output) |
V |
Double |
||
c_u |
Phase C voltage (AC output) |
V |
Double |
||
b_i |
Phase B current of grid (IB) |
A |
Double |
||
c_i |
Phase C current of grid (IC) |
A |
Double |
||
forward_reactive_cap |
Positive reactive energy |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_cap |
Negative reactive energy |
kWh |
Double |
Invalid field. The default value is null. |
|
active_power_a |
Active power PA |
kW |
Double |
||
active_power_b |
Active power PB |
kW |
Double |
||
active_power_c |
Active power PC |
kW |
Double |
||
reactive_power_a |
Reactive power QA |
kVar |
Double |
Invalid field. The default value is null. |
|
reactive_power_b |
Reactive power QB |
kVar |
Double |
Invalid field. The default value is null. |
|
reactive_power_c |
Reactive power QC |
kVar |
Double |
Invalid field. The default value is null. |
|
total_apparent_power |
Total apparent power |
kVA |
Double |
Invalid field. The default value is null. |
|
reverse_active_peak |
Negative active energy (peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_power |
Negative active energy (shoulder) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_valley |
Negative active energy (off-peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_top |
Negative active energy (sharp) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_peak |
Positive active energy (peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_power |
Positive active energy (shoulder) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_valley |
Positive active energy (off-peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_top |
Positive active energy (sharp) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_peak |
Negative reactive energy (peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_power |
Negative reactive energy (shoulder) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_valley |
Negative reactive energy (off-peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_top |
Negative reactive energy (sharp) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_peak |
Positive reactive energy (peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_power |
Positive reactive energy (shoulder) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_valley |
Positive reactive energy (off-peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_top |
Positive reactive energy (sharp) |
kVar |
Double |
Invalid field. The default value is null. |
|
ID: 39 Residential battery |
battery_status |
Battery running state (0: offline; 1: standby; 2: running; 3: faulty; 4: hibernating) |
None |
Double |
|
max_charge_power |
Maximum charge power |
W |
Double |
||
max_discharge_power |
Maximum discharge power |
W |
Double |
||
ch_discharge_power |
Charge/Discharge power |
W |
Double |
||
busbar_u |
Battery voltage |
V |
Double |
||
battery_soc |
Battery SOC |
% |
Double |
||
battery_soh |
Battery SOH (supported only by LG batteries) |
None |
Double |
||
ch_discharge_model |
Charge/Discharge mode (0: none; 1: forced charge/discharge; 2: time-of-use price; 3: fixed charge/discharge; 4: automatic charge/discharge; 5: fully fed to grid; 6: TOU; 7: remote scheduling–max. self-consumption; 8: remote scheduling–fully fed to grid; 9: remote scheduling–TOU; 10: EMMA) |
None |
Double |
||
charge_cap |
Charged energy |
kWh |
Double |
||
discharge_cap |
Discharged energy |
kWh |
Double |
||
run_state |
State (0: Disconnected 1: Connected) |
None |
Long |
||
ID: 41 C&I and utility ESS |
ch_discharge_power |
Charge/Discharge power |
W |
Double |
|
battery_soc |
Battery SOC |
% |
Double |
||
battery_soh |
Battery SOH |
None |
Double |
||
charge_cap |
Charged energy |
kWh |
Double |
||
discharge_cap |
Discharged energy |
kWh |
Double |
||
run_state |
State (0: Disconnected 1: Connected) |
None |
Long |
||
ID: 60001 Mains (supported only in the Power-M scenario) |
mains_state |
Mains status (0: mains unavailable; 1: mains available) |
None |
Double |
|
ac_voltage |
AC voltage |
V |
Double |
||
ac_current |
AC current |
A |
Double |
||
active_power |
Active power |
kW |
Double |
||
ac_frequency |
AC frequency |
Hz |
Double |
||
grid_quality_grade |
Power grid quality level (0: Unknown; 1: Class 1; 2: Class 2; 3: Class 3; 4: Class 4) |
None |
Double |
||
total_energy_consumption |
Total energy consumption |
kWh |
Double |
||
supply_duration_per_total |
Total power supply duration |
h |
Double |
||
ID: 60003 Genset (supported only in the Power-M scenario) |
running_state |
Running status (0: unknown; 1: stopped; 2: running) |
None |
Double |
|
output_power |
Output power |
kW |
Double |
||
load_rate |
Load rate |
% |
Double |
||
ID: 60043 SSU group (supported only in the Power-M scenario) |
total_output_current |
Total output current |
A |
Double |
|
total_output_power |
Total output power |
kW |
Double |
||
D: 60044 SSU (supported only in the Power-M scenario) |
input_voltage |
Input voltage |
V |
Double |
|
output_voltage |
Output voltage |
V |
Double |
||
output_current |
Output current |
A |
Double |
||
on_off_state |
Power-on/off status (0: on; 1: off) |
None |
Double |
||
ID: 60092 Power converter (supported only in the Power-M scenario) |
total_runtime |
Total runtime |
h |
Double |
|
pv_input_voltage |
PV input voltage |
V |
Double |
||
pv_input_current |
PV input current |
A |
Double |
||
pv_input_power |
PV input power |
kW |
Double |
||
inverter_voltage |
Inverter voltage |
V |
Double |
||
inverter_frequency |
Inverter frequency |
Hz |
Double |
||
ac_output_voltage |
AC output voltage |
V |
Double |
||
ac_output_current |
AC output current |
A |
Double |
||
ac_output_frequency |
AC output frequency |
kW |
Double |
||
ac_output_apparent_power |
AC output apparent power |
kVA |
Double |
||
ID: 60014 Lithium battery rack (supported only in the Power-M scenario) |
battery_state |
Battery status (0: initial power-on; 1: power-off; 2: float charging; 3: boost charging; 4: discharging; 5: charging; 6: testing; 7: hibernation; 8: standby) |
None |
Double |
|
soc |
SOC |
% |
Double |
||
charge_discharge_power |
Charge/Discharge power |
kW |
Double |
||
total_discharge |
Total energy discharged |
kWh |
Double |
||
voltage |
Voltage |
V |
Double |
||
current |
Current |
A |
Double |
||
remaining_backup_time |
Remaining power reserve duration |
h |
Double |
||
total_discharge_times |
Total discharge times |
times |
Double |
||
total_capacity |
Total capacity |
kWh |
Double |
||
ID: 60010 AC output power distribution (supported only in the Power-M scenario) |
ac_voltage |
AC voltage |
V |
Double |
|
ac_current |
AC current |
A |
Double |
||
ac_frequency |
AC frequency |
Hz |
Double |
||
active_power |
Active power |
kW |
Double |
State Value |
Description |
---|---|
0 |
Standby: initializing |
1 |
Standby: insulation resistance detecting |
2 |
Standby: irradiation detecting |
3 |
Standby: grid detecting |
256 |
Start |
512 |
Grid-connected |
513 |
Grid-connected: power limited |
514 |
Grid-connected: self-derating |
768 |
Shutdown: on fault |
769 |
Shutdown: on command |
770 |
Shutdown: OVGR |
771 |
Shutdown: communication interrupted |
772 |
Shutdown: power limited |
773 |
Shutdown: manual startup required |
774 |
Shutdown: DC switch disconnected |
1025 |
Grid scheduling: cosψ-P curve |
1026 |
Grid scheduling: Q-U curve |
1280 |
Ready for terminal test |
1281 |
Terminal testing... |
1536 |
Inspection in progress |
1792 |
AFCI self-check |
2048 |
I-V scanning |
2304 |
DC input detection |
40960 |
Standby: no irradiation |
45056 |
Communication interrupted (written by SmartLogger) |
49152 |
Loading... (written by SmartLogger) |
Examples
Request example:
{ "devIds":"214060404588862,213472461631079", "devTypeId":"1" }
Example 1: An error code is returned.
{ "success":false, "data":null, "failCode":20006, "params":{ "devIds":"214233501711677,214060404588862", "devTypeId":"1", "currentTime":1503046597854 }, "message":null }
{ "success":true, "data":[ { "dataItemMap":{ "pv7_u":0, "pv1_u":0, "b_u":0, "c_u":0, "pv6_u":0, "temperature":0, "open_time":0, "b_i":0, "bc_u":0, "pv9_u":0, "pv8_u":0, "c_i":0, "mppt_total_cap":0, "pv9_i":0, "mppt_3_cap":0, "run_state":0, "mppt_2_cap":0, "inverter_state":0, "pv8_i":0, "mppt_1_cap":0, "pv6_i":0, "mppt_power":0, "pv1_i":0, "total_cap":0, "ab_u":0, "pv7_i":0, "pv13_u":0, "reactive_power":0, "pv10_u":0, "pv12_i":0, "pv11_i":0, "pv3_i":0, "pv11_u":0, "pv2_i":0, "pv13_i":0, "power_factor":0, "pv12_u":0, "pv5_i":0, "active_power":0, "elec_freq":0, "pv10_i":0, "pv4_i":0, "mppt_4_cap":0, "mppt_5_cap":0, "mppt_6_cap":0, "mppt_7_cap":0, "mppt_8_cap":0, "mppt_9_cap":0, "mppt_10_cap":0, "pv4_u":0, "close_time":0, "day_cap":0, "ca_u":0, "a_i":0, "pv5_u":0, "a_u":0, "pv3_u":0, "pv14_u":0, "pv14_i":0, "pv15_u":0, "pv15_i":0, "pv16_u":0, "pv16_i":0, "pv17_u":0, "pv17_i":0, "pv18_u":0, "pv18_i":0, "pv19_u":0, "pv19_i":0, "pv20_u":0, "pv20_i":0, "pv21_u":0, "pv21_i":0, "pv22_u":0, "pv22_i":0, "pv23_u":0, "pv23_i":0, "pv24_u":0, "pv24_i":0, "pv25_u":0, "pv25_i":0, "pv26_u":0, "pv26_i":0, "pv27_u":0, "pv27_i":0, "pv28_u":0, "pv28_i":0, "efficiency":0, "pv2_u":0 }, "devId":213472461631079 }, { "dataItemMap":{ "pv7_u":0, "pv1_u":0, "b_u":0, "c_u":0, "pv6_u":0, "temperature":0, "open_time":0, "b_i":0, "bc_u":0, "pv9_u":0, "pv8_u":0, "c_i":0, "mppt_total_cap":0, "pv9_i":0, "mppt_3_cap":0, "run_state":0, "mppt_2_cap":0, "inverter_state":0, "pv8_i":0, "mppt_1_cap":0, "pv6_i":0, "mppt_power":0, "pv1_i":0, "total_cap":0, "ab_u":0, "pv7_i":0, "pv13_u":0, "reactive_power":0, "pv10_u":0, "pv12_i":0, "pv11_i":0, "pv3_i":0, "pv11_u":0, "pv2_i":0, "pv13_i":0, "power_factor":0, "pv12_u":0, "pv5_i":0, "active_power":0, "elec_freq":0, "pv10_i":0, "pv4_i":0, "mppt_4_cap":0, "mppt_5_cap":0, "mppt_6_cap":0, "mppt_7_cap":0, "mppt_8_cap":0, "mppt_9_cap":0, "mppt_10_cap":0, "pv4_u":0, "close_time":0, "day_cap":0, "ca_u":0, "a_i":0, "pv5_u":0, "a_u":0, "pv3_u":0, "pv14_u":0, "pv14_i":0, "pv15_u":0, "pv15_i":0, "pv16_u":0, "pv16_i":0, "pv17_u":0, "pv17_i":0, "pv18_u":0, "pv18_i":0, "pv19_u":0, "pv19_i":0, "pv20_u":0, "pv20_i":0, "pv21_u":0, "pv21_i":0, "pv22_u":0, "pv22_i":0, "pv23_u":0, "pv23_i":0, "pv24_u":0, "pv24_i":0, "pv25_u":0, "pv25_i":0, "pv26_u":0, "pv26_i":0, "pv27_u":0, "pv27_i":0, "pv28_u":0, "pv28_i":0, "efficiency":0, "pv2_u":0 }, "devId":214060404588862 } ], "failCode":0, "params":{ "devIds":"214060404588862,213472461631079", "devTypeId":"1", "currentTime":1503046597854 }, "message":null }
Prerequisites for obtaining data: The API account has the permission to access this API.
Request example:
Historical Device Data API
API Description
This API is used to obtain 5-minute device data in a specified time period. The 5-minute data of a maximum of 10 devices of the same type in three days can be queried at a time.
For details about the data list that can be queried through this API, see the historical device data list below.
Request URL
https://Domain name of the management system/thirdData/getDevHistoryKpi
Request Mode
HTTP method: POST
Request Parameters
Parameter |
Description |
Data Type |
Mandatory/Optional |
---|---|---|---|
devIds |
List of device IDs. The device IDs are obtained from id in Device List API. Use commas (,) to separate multiple device IDs. Either sns or devIds must be set. |
String |
Optional |
sns |
Device SN list. Multiple device SNs are separated by commas (,). Either sns or devIds must be set. |
String |
Optional |
devTypeId |
Device type ID. Use the device type ID obtained in Device List API. The following device types are supported: 1: string inverter 10: EMI 17: grid meter 38: residential inverter 39: battery 41: ESS 47: power sensor 60001: mains 60003: genset 60043: SSU group 60014: lithium battery rack 60010: AC output power distribution |
Integer |
Mandatory |
startTime |
Start time, in milliseconds |
Long |
Mandatory |
endTime |
End time, in milliseconds |
Long |
Mandatory |
Response Packet
Parameter |
Description |
Data Type |
Remarks |
|
---|---|---|---|---|
success |
Request success or failure flag true: The request succeeded. false: The request failed. |
Boolean |
Request success or failure flag |
|
failCode |
Error code Value 0 indicates that the status is normal. For other error codes, see Error Code List. |
Integer |
- |
|
params |
Parameters |
- |
- |
- |
devIds |
Device ID list in the request parameter |
String |
- |
|
sns |
Device SN list in the request parameter |
String |
- |
|
devTypeId |
Device type ID in the request parameter |
Integer |
- |
|
startTime |
Start time, in milliseconds |
Long |
- |
|
endTime |
End time, in milliseconds |
Long |
- |
|
currentTime |
Current system time, in milliseconds |
Long |
- |
|
message |
Optional message |
String |
- |
|
data |
Parameters |
Returned data. The data contains the 5-minute data object list of each device. |
List |
5-minute data of a device in a day |
devId |
Device ID |
Long |
- |
|
sn |
Device SN |
String |
||
collectTime |
Collection time in milliseconds in the request parameter |
Long |
- |
|
dataItemMap |
Content of each data item, which is returned in the key-value format. The data item content varies depending on the device type. For details about the data item list, see the historical device data list below. |
Map |
5-minute device data |
Historical Device Data List
Device Type |
Key |
Name |
Unit |
Return Value Type |
Remarks |
---|---|---|---|---|---|
ID: 1 String inverter |
inverter_state |
Inverter state. For details, see the following: |
None |
Double |
|
ab_u |
A-B line voltage of grid |
V |
Double |
||
bc_u |
B-C line voltage of grid |
V |
Double |
||
ca_u |
C-A line voltage of grid |
V |
Double |
||
a_u |
Phase A voltage |
V |
Double |
||
b_u |
Phase B voltage |
V |
Double |
||
c_u |
Phase C voltage |
V |
Double |
||
a_i |
Phase A current of grid |
A |
Double |
||
b_i |
Phase B current of grid |
A |
Double |
||
c_i |
Phase C current of grid |
A |
Double |
||
efficiency |
Inverter conversion efficiency (manufacturer) |
% |
Double |
||
temperature |
Internal temperature |
°C |
Double |
||
power_factor |
Power factor |
None |
Double |
||
elec_freq |
Grid frequency |
Hz |
Double |
||
active_power |
Active power |
kW |
Double |
||
reactive_power |
Output reactive power |
kVar |
Double |
||
day_cap |
Yield today |
kWh |
Double |
||
mppt_power |
MPPT total input power |
kW |
Double |
||
pv1_u |
PV1 input voltage |
V |
Double |
||
pv2_u |
PV2 input voltage |
V |
Double |
||
pv3_u |
PV3 input voltage |
V |
Double |
||
pv4_u |
PV4 input voltage |
V |
Double |
||
pv5_u |
PV5 input voltage |
V |
Double |
||
pv6_u |
PV6 input voltage |
V |
Double |
||
pv7_u |
PV7 input voltage |
V |
Double |
||
pv8_u |
PV8 input voltage |
V |
Double |
||
pv9_u |
PV9 input voltage |
V |
Double |
||
pv10_u |
PV10 input voltage |
V |
Double |
||
pv11_u |
PV11 input voltage |
V |
Double |
||
pv12_u |
PV12 input voltage |
V |
Double |
||
pv13_u |
PV13 input voltage |
V |
Double |
||
pv14_u |
PV14 input voltage |
V |
Double |
||
pv15_u |
PV15 input voltage |
V |
Double |
||
pv16_u |
PV16 input voltage |
V |
Double |
||
pv17_u |
PV17 input voltage |
V |
Double |
||
pv18_u |
PV18 input voltage |
V |
Double |
||
pv19_u |
PV19 input voltage |
V |
Double |
||
pv20_u |
PV20 input voltage |
V |
Double |
||
pv21_u |
PV21 input voltage |
V |
Double |
||
pv22_u |
PV22 input voltage |
V |
Double |
||
pv23_u |
PV23 input voltage |
V |
Double |
||
pv24_u |
PV24 input voltage |
V |
Double |
||
pv25_u |
PV25 input voltage |
V |
Double |
||
pv26_u |
PV26 input voltage |
V |
Double |
||
pv27_u |
PV27 input voltage |
V |
Double |
||
pv28_u |
PV28 input voltage |
V |
Double |
||
pv1_i |
PV1 input current |
A |
Double |
||
pv2_i |
PV2 input current |
A |
Double |
||
pv3_i |
PV3 input current |
A |
Double |
||
pv4_i |
PV4 input current |
A |
Double |
||
pv5_i |
PV5 input current |
A |
Double |
||
pv6_i |
PV6 input current |
A |
Double |
||
pv7_i |
PV7 input current |
A |
Double |
||
pv8_i |
PV8 input current |
A |
Double |
||
pv9_i |
PV9 input current |
A |
Double |
||
pv10_i |
PV10 input current |
A |
Double |
||
pv11_i |
PV11 input current |
A |
Double |
||
pv12_i |
PV12 input current |
A |
Double |
||
pv13_i |
PV13 input current |
A |
Double |
||
pv14_i |
PV14 input current |
A |
Double |
||
pv15_i |
PV15 input current |
A |
Double |
||
pv16_i |
PV16 input current |
A |
Double |
||
pv17_i |
PV17 input current |
A |
Double |
||
pv18_i |
PV18 input current |
A |
Double |
||
pv19_i |
PV19 input current |
A |
Double |
||
pv20_i |
PV20 input current |
A |
Double |
||
pv21_i |
PV21 input current |
A |
Double |
||
pv22_i |
PV22 input current |
A |
Double |
||
pv23_i |
PV23 input current |
A |
Double |
||
pv24_i |
PV24 input current |
A |
Double |
||
pv25_i |
PV25 input current |
A |
Double |
||
pv26_i |
PV26 input current |
A |
Double |
||
pv27_i |
PV27 input current |
A |
Double |
||
pv28_i |
PV28 input current |
A |
Double |
||
total_cap |
Total yield |
kWh |
Double |
||
open_time |
Inverter startup time |
ms |
Double |
||
close_time |
Inverter shutdown time |
ms |
Double |
||
mppt_total_cap |
Total DC input energy |
kWh |
Double |
||
mppt_1_cap |
MPPT 1 DC total yield |
kWh |
Double |
||
mppt_2_cap |
MPPT 2 DC total yield |
kWh |
Double |
||
mppt_3_cap |
MPPT 3 DC total yield |
kWh |
Double |
||
mppt_4_cap |
MPPT 4 DC total yield |
kWh |
Double |
||
mppt_5_cap |
MPPT 5 DC total yield |
kWh |
Double |
||
mppt_6_cap |
MPPT 6 DC total yield |
kWh |
Double |
||
mppt_7_cap |
MPPT 7 DC total yield |
kWh |
Double |
||
mppt_8_cap |
MPPT 8 DC total yield |
kWh |
Double |
||
mppt_9_cap |
MPPT 9 DC total yield |
kWh |
Double |
||
mppt_10_cap |
MPPT 10 DC total yield |
kWh |
Double |
||
ID: 38 Residential inverter |
inverter_state |
Inverter state. For details, see Table 5-2. |
None |
Double |
|
ab_u |
A-B line voltage of grid |
V |
Double |
||
bc_u |
B-C line voltage of grid |
V |
Double |
||
ca_u |
C-A line voltage of grid |
V |
Double |
||
a_u |
Phase A voltage |
V |
Double |
||
b_u |
Phase B voltage |
V |
Double |
||
c_u |
Phase C voltage |
V |
Double |
||
a_i |
Phase A current of grid |
A |
Double |
||
b_i |
Phase B current of grid |
A |
Double |
||
c_i |
Phase C current of grid |
A |
Double |
||
efficiency |
Inverter conversion efficiency (manufacturer) |
% |
Double |
||
temperature |
Internal temperature |
°C |
Double |
||
power_factor |
Power factor |
None |
Double |
||
elec_freq |
Grid frequency |
Hz |
Double |
||
active_power |
Active power |
kW |
Double |
||
reactive_power |
Output reactive power |
kVar |
Double |
||
day_cap |
Yield today |
kWh |
Double |
||
mppt_power |
MPPT total input power |
kW |
Double |
||
pv1_u |
PV1 input voltage |
V |
Double |
||
pv2_u |
PV2 input voltage |
V |
Double |
||
pv3_u |
PV3 input voltage |
V |
Double |
||
pv4_u |
PV4 input voltage |
V |
Double |
||
pv5_u |
PV5 input voltage |
V |
Double |
||
pv6_u |
PV6 input voltage |
V |
Double |
||
pv7_u |
PV7 input voltage |
V |
Double |
||
pv8_u |
PV8 input voltage |
V |
Double |
||
pv1_i |
PV1 input current |
A |
Double |
||
pv2_i |
PV2 input current |
A |
Double |
||
pv3_i |
PV3 input current |
A |
Double |
||
pv4_i |
PV4 input current |
A |
Double |
||
pv5_i |
PV5 input current |
A |
Double |
||
pv6_i |
PV6 input current |
A |
Double |
||
pv7_i |
PV7 input current |
A |
Double |
||
pv8_i |
PV8 input current |
A |
Double |
||
total_cap |
Total yield |
kWh |
Double |
||
open_time |
Inverter startup time |
ms |
Double |
||
close_time |
Inverter shutdown time |
ms |
Double |
||
mppt_1_cap |
MPPT 1 DC total yield |
kWh |
Double |
||
mppt_2_cap |
MPPT 2 DC total yield |
kWh |
Double |
||
mppt_3_cap |
MPPT 3 DC total yield |
kWh |
Double |
||
mppt_4_cap |
MPPT 4 DC total yield |
kWh |
Double |
||
ID: 10 EMI |
temperature |
Temperature |
°C |
Double |
|
pv_temperature |
PV temperature |
°C |
Double |
||
wind_speed |
Wind speed |
m/s |
Double |
||
wind_direction |
Wind direction |
Degree |
Double |
||
radiant_total |
Daily irradiation |
MJ/m2 |
Double |
||
radiant_line |
Irradiance |
W/m2 |
Double |
||
horiz_radiant_line |
Horizontal irradiance |
W/m2 |
Double |
Invalid field. The default value is null. |
|
horiz_radiant_total |
Horizontal irradiation |
MJ/m2 |
Double |
Invalid field. The default value is null. |
|
ID: 17 Grid meter |
ab_u |
A-B line voltage of grid |
V |
Double |
|
bc_u |
B-C line voltage of grid |
V |
Double |
||
ca_u |
C-A line voltage of grid |
V |
Double |
||
a_u |
Phase A voltage (AC output) |
V |
Double |
||
b_u |
Phase B voltage (AC output) |
V |
Double |
||
c_u |
Phase C voltage (AC output) |
V |
Double |
||
a_i |
Phase A current of grid (IA) |
A |
Double |
||
b_i |
Phase B current of grid (IB) |
A |
Double |
||
c_i |
Phase C current of grid (IC) |
A |
Double |
||
active_power |
Active power |
kW |
Double |
||
power_factor |
Power factor |
None |
Double |
||
active_cap |
Active energy (positive active energy) |
kWh |
Double |
||
reactive_power |
Reactive power |
kVar |
Double |
||
reverse_active_cap |
Negative active energy |
kWh |
Double |
||
forward_reactive_cap |
Positive reactive energy |
kWh |
Double |
||
reverse_reactive_cap |
Negative reactive energy |
kWh |
Double |
||
active_power_a |
Active power PA |
kW |
Double |
||
active_power_b |
Active power PB |
kW |
Double |
||
active_power_c |
Active power PC |
kW |
Double |
||
reactive_power_a |
Reactive power QA |
kVar |
Double |
Invalid field. The default value is null. |
|
reactive_power_b |
Reactive power QB |
kVar |
Double |
Invalid field. The default value is null. |
|
reactive_power_c |
Reactive power QC |
kVar |
Double |
Invalid field. The default value is null. |
|
total_apparent_power |
Total apparent power |
kVA |
Double |
||
grid_frequency |
Grid frequency |
Hz |
Double |
Invalid field. The default value is null. |
|
reverse_active_peak |
Negative active energy (peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_power |
Negative active energy (shoulder) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_valley |
Negative active energy (off-peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_top |
Negative active energy (sharp) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_peak |
Positive active energy (peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_power |
Positive active energy (shoulder) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_valley |
Positive active energy (off-peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_top |
Positive active energy (sharp) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_peak |
Negative reactive energy (peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_power |
Negative reactive energy (shoulder) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_valley |
Negative reactive energy (off-peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_top |
Negative reactive energy (sharp) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_peak |
Positive reactive energy (peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_power |
Positive reactive energy (shoulder) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_valley |
Positive reactive energy (off-peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_top |
Positive reactive energy (sharp) |
kVar |
Double |
Invalid field. The default value is null. |
|
ID: 47 Power sensor |
meter_status |
Meter state (0: offline; 1: normal) |
None |
Double |
|
meter_u |
Grid voltage |
V |
Double |
||
meter_i |
Grid current |
A |
Double |
||
active_power |
Active power |
W |
Double |
||
reactive_power |
Reactive power |
Var |
Double |
||
power_factor |
Power factor |
None |
Double |
||
grid_frequency |
Grid frequency |
Hz |
Double |
||
active_cap |
Active energy (positive active energy) |
kWh |
Double |
||
reverse_active_cap |
Negative active energy |
kWh |
Double |
||
ab_u |
A-B line voltage of grid |
V |
Double |
||
bc_u |
B-C line voltage of grid |
V |
Double |
||
ca_u |
C-A line voltage of grid |
V |
Double |
||
b_u |
Phase B voltage (AC output) |
V |
Double |
||
c_u |
Phase C voltage (AC output) |
V |
Double |
||
b_i |
Phase B current of grid (IB) |
A |
Double |
||
c_i |
Phase C current of grid (IC) |
A |
Double |
||
forward_reactive_cap |
Positive reactive energy |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_cap |
Negative reactive energy |
kWh |
Double |
Invalid field. The default value is null. |
|
active_power_a |
Active power PA |
kW |
Double |
||
active_power_b |
Active power PB |
kW |
Double |
||
active_power_c |
Active power PC |
kW |
Double |
||
reactive_power_a |
Reactive power QA |
kVar |
Double |
Invalid field. The default value is null. |
|
reactive_power_b |
Reactive power QB |
kVar |
Double |
Invalid field. The default value is null. |
|
reactive_power_c |
Reactive power QC |
kVar |
Double |
Invalid field. The default value is null. |
|
total_apparent_power |
Total apparent power |
kVA |
Double |
Invalid field. The default value is null. |
|
reverse_active_peak |
Negative active energy (peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_power |
Negative active energy (shoulder) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_valley |
Negative active energy (off-peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_active_top |
Negative active energy (sharp) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_peak |
Positive active energy (peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_power |
Positive active energy (shoulder) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_valley |
Positive active energy (off-peak) |
kWh |
Double |
Invalid field. The default value is null. |
|
positive_active_top |
Positive active energy (sharp) |
kWh |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_peak |
Negative reactive energy (peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_power |
Negative reactive energy (shoulder) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_valley |
Negative reactive energy (off-peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
reverse_reactive_top |
Negative reactive energy (sharp) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_peak |
Positive reactive energy (peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_power |
Positive reactive energy (shoulder) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_valley |
Positive reactive energy (off-peak) |
kVar |
Double |
Invalid field. The default value is null. |
|
positive_reactive_top |
Positive reactive energy (sharp) |
kVar |
Double |
Invalid field. The default value is null. |
|
ID: 39 Residential battery |
battery_status |
Battery running state (0: offline; 1: standby; 2: running; 3: faulty; 4: hibernating) |
None |
Double |
|
max_charge_power |
Maximum charge power |
W |
Double |
||
max_discharge_power |
Maximum discharge power |
W |
Double |
||
ch_discharge_power |
Charge/Discharge power |
W |
Double |
||
busbar_u |
Battery voltage |
V |
Double |
||
battery_soc |
Battery SOC |
% |
Double |
||
battery_soh |
Battery SOH |
None |
Double |
||
ch_discharge_model |
Charge/Discharge mode (0: none; 1: forced charge/discharge; 2: time-of-use price; 3: fixed charge/discharge; 4: automatic charge/discharge) |
None |
Double |
||
charge_cap |
Charged energy |
kWh |
Double |
||
discharge_cap |
Discharged energy |
kWh |
Double |
||
ID: 41 C&I and utility ESS |
ch_discharge_power |
Charge/Discharge power |
W |
Double |
|
battery_soc |
Battery SOC |
% |
Double |
||
charge_cap |
Charged energy |
kWh |
Double |
||
discharge_cap |
Discharged energy |
kWh |
Double |
||
ID: 60001 Mains (supported only in the Power-M scenario) |
mains_state |
Mains status (0: mains unavailable; 1: mains available) |
None |
Double |
|
ac_voltage |
AC voltage |
V |
Double |
||
ac_current |
AC current |
A |
Double |
||
active_power |
Active power |
kW |
Double |
||
ac_frequency |
AC frequency |
Hz |
Double |
||
ID: 60003 Genset (supported only in the Power-M scenario) |
load_rate |
Load rate |
% |
Double |
|
running_state |
Running status (0: unknown; 1: stopped; 2: running) |
None |
Double |
||
ID: 60043 SSU group (supported only in the Power-M scenario) |
total_output_current |
Total output current |
A |
Double |
|
total_output_energy |
Total output energy |
kWh |
Double |
||
ID: 60014 Lithium battery rack (supported only in the Power-M scenario) |
soc |
SOC |
% |
Double |
|
voltage |
Voltage |
V |
Double |
||
average_temperature |
Average temperature |
°C |
Double |
||
ID: 60010 AC output power distribution (supported only in the Power-M scenario) |
ac_frequency |
AC frequency |
Hz |
Double |
|
total_load_active_power |
Total load active power |
kW |
Double |
State Value |
Description |
---|---|
0 |
Standby: initializing |
1 |
Standby: insulation resistance detecting |
2 |
Standby: irradiation detecting |
3 |
Standby: grid detecting |
256 |
Start |
512 |
Grid-connected |
513 |
Grid-connected: power limited |
514 |
Grid-connected: self-derating |
768 |
Shutdown: on fault |
769 |
Shutdown: on command |
770 |
Shutdown: OVGR |
771 |
Shutdown: communication interrupted |
772 |
Shutdown: power limited |
773 |
Shutdown: manual startup required |
774 |
Shutdown: DC switch disconnected |
1025 |
Grid scheduling: cosφ-P curve |
1026 |
Grid scheduling: Q-U curve |
1280 |
Ready for terminal test |
1281 |
Terminal testing... |
1536 |
Inspection in progress |
1792 |
AFCI self-check |
2048 |
I-V scanning |
2304 |
DC input detection |
40960 |
Standby: no irradiation |
45056 |
Communication interrupted (written by SmartLogger) |
49152 |
Loading... (written by SmartLogger) |
Examples
Request example:
{ "devIds":"214060404588862,213472461631079", "devTypeId":1, "startTime":1501862400000, "endTime":1501872400000 }
Response examples:
Example 1: An error code is returned.
{ "success":false, "data":null, "failCode":20009, "params":{ "devIds":"214060404588862,213472461631079", "devTypeId":1, "startTime":1501862400000, "endTime":1501872400000, "currentTime":1503046597854 }, "message":null }
Example 2: 5-minute device data is returned.
{ "success":true, "data":[ { "dataItemMap":{ "pv7_u":null, "pv1_u":575.3, "b_u":286.1, "c_u":286.9, "pv6_u":576.1, "temperature":44.6, "open_time":null, "b_i":24.9, "bc_u":495.6, "pv9_u":null, "pv8_u":null, "c_i":25, "mppt_total_cap":null, "pv9_i":null, "mppt_3_cap":null, "mppt_2_cap":null, "inverter_state":512, "pv8_i":null, "mppt_1_cap":null, "pv6_i":7.1, "mppt_power":21.962, "pv1_i":7.1, "total_cap":655.37, "ab_u":495.4, "pv7_i":null, "pv13_u":null, "reactive_power":20.95, "pv10_u":null, "pv12_i":null, "pv11_i":null, "pv3_i":7.1, "pv11_u":null, "pv2_i":7.1, "pv13_i":null, "power_factor":0, "pv12_u":null, "pv5_i":7.2, "active_power":21.05, "elec_freq":50.05, "pv10_i":null, "pv4_i":7, "mppt_4_cap":null, "mppt_5_cap":0, "mppt_6_cap":0, "mppt_7_cap":0, "mppt_8_cap":0, "mppt_9_cap":0, "mppt_10_cap":0, "pv4_u":577.8, "close_time":null, "day_cap":159.26, "ca_u":496.9, "a_i":24.9, "pv5_u":576.1, "a_u":286, "pv3_u":577.8, "pv14_u":null, "pv14_i":null, "pv15_u":0, "pv15_i":0, "pv16_u":0, "pv16_i":0, "pv17_u":0, "pv17_i":0, "pv18_u":0, "pv18_i":0, "pv19_u":0, "pv19_i":0, "pv20_u":0, "pv20_i":0, "pv21_u":0, "pv21_i":0, "pv22_u":0, "pv22_i":0, "pv23_u":0, "pv23_i":0, "pv24_u":0, "pv24_i":0, "pv25_u":0, "pv25_i":0, "pv26_u":0, "pv26_i":0, "pv27_u":0, "pv27_i":0, "pv28_u":0, "pv28_i":0, "efficiency":null, "pv2_u":575.3 }, "devId":213472461631079, "collectTime":1501862400000 }, { "dataItemMap":{ "pv7_u":null, "pv1_u":575.3, "b_u":286.1, "c_u":286.9, "pv6_u":576.1, "temperature":44.6, "open_time":null, "b_i":24.9, "bc_u":495.6, "pv9_u":null, "pv8_u":null, "c_i":25, "mppt_total_cap":null, "pv9_i":null, "mppt_3_cap":null, "mppt_2_cap":null, "inverter_state":512, "pv8_i":null, "mppt_1_cap":null, "pv6_i":7.1, "mppt_power":21.962, "pv1_i":7.1, "total_cap":655.37, "ab_u":495.4, "pv7_i":null, "pv13_u":null, "reactive_power":20.95, "pv10_u":null, "pv12_i":null, "pv11_i":null, "pv3_i":7.1, "pv11_u":null, "pv2_i":7.1, "pv13_i":null, "power_factor":0, "pv12_u":null, "pv5_i":7.2, "active_power":21.05, "elec_freq":50.05, "pv10_i":null, "pv4_i":7, "mppt_4_cap":null, "mppt_5_cap":0, "mppt_6_cap":0, "mppt_7_cap":0, "mppt_8_cap":0, "mppt_9_cap":0, "mppt_10_cap":0, "pv4_u":577.8, "close_time":null, "day_cap":159.26, "ca_u":496.9, "a_i":24.9, "pv5_u":576.1, "a_u":286, "pv3_u":577.8, "pv14_u":null, "pv14_i":null, "pv15_u":0, "pv15_i":0, "pv16_u":0, "pv16_i":0, "pv17_u":0, "pv17_i":0, "pv18_u":0, "pv18_i":0, "pv19_u":0, "pv19_i":0, "pv20_u":0, "pv20_i":0, "pv21_u":0, "pv21_i":0, "pv22_u":0, "pv22_i":0, "pv23_u":0, "pv23_i":0, "pv24_u":0, "pv24_i":0, "pv25_u":0, "pv25_i":0, "pv26_u":0, "pv26_i":0, "pv27_u":0, "pv27_i":0, "pv28_u":0, "pv28_i":0, "efficiency":null, "pv2_u":575.3 }, "devId":213472461631079, "collectTime":1501862700000 } ], "failCode":0, "params":{ "devIds":"214060404588862,213472461631079", "devTypeId":1, "startTime":1501862400000, "endTime":1501872400000, "currentTime":1503046597854 }, "message":null }
Prerequisites for obtaining data: The API account has the permission to access this API.