Scribd
Upload
390 views

SolaxCloud User Monitoring API V6.1

The Solax Cloud User Monitoring API allows clients to access real-time inverter data through HTTP requests. The API returns data in JSON format including inverter details like power output, energy generation, and system status. Users must provide a token ID to authenticate and can request data up to 10 times per minute and 10,000 times daily. The API documentation provides examples and outlines the required parameters, returned parameters, and inverter information codes.

Uploaded by

Victor Vivanco Herranz
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
390 views

SolaxCloud User Monitoring API V6.1

The Solax Cloud User Monitoring API allows clients to access real-time inverter data through HTTP requests. The API returns data in JSON format including inverter details like power output, energy generation, and system status. Users must provide a token ID to authenticate and can request data up to 10 times per minute and 10,000 times daily. The API documentation provides examples and outlines the required parameters, returned parameters, and inverter information codes.

Uploaded by

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

SolaX Cloud

User Monitoring API

Version: V 6.1
Version Information
Version Editor Time Remark
V1.0 Jacob Li 2020-06-30 Creating
V2.0 Jacob Li 2020-07-30 Interface address correction, add frequency
description.
V3.0 Jacob Li 2020-12-08 Add Registration No. example;
Improve parameters Description;
Change the title.
V4.0 Jacob Li 2021-03-13 Add battery power and PV power.
V5.0 Jacob Li 2021-06-01 Add PV3 and PV4 power
V6.1 Jacob Li 2022-06-10 Add Notes, add tokenID Length, add inverter type.

Content
1 Introduction ............................................................................................................................. 3
2 Interface format and protocol ................................................................................................ 3
3 Interface permission ............................................................................................................... 3
4 Interface content ..................................................................................................................... 4
4.1 Request address ................................................................................................... 4
4.2 Request parameter .............................................................................................. 4
4.3 Output parameters .............................................................................................. 4
4.4 Example ................................................................................................................ 5
4.5 Notice.................................................................................................................... 5
Appendix ........................................................................................................................................... 6
1 Introduction

Solax API interface document is a guide for clients to obtaining data from
Solax cloud through Http protocol. Clients can use the Solax API service to obtain
real-time info of your inverters.

2 Interface format and protocol

Solax API interface accesses Solax cloud platform data through the Http
protocol, and the data is returned in JSON format.
Interface address：https://www.solaxcloud.com/proxyApp/proxy/api/
Return object：
Parameter name Type Description

exception String Response from server

result Object Data return

success Boolean Whether the data request is successful


Table 1

3 Interface permission

User can get a specific range of information through the granted tokenID. Please
obtain your tokenID on the API page of Solaxcloud for free.
The tokenID can be used to obtain real-time data of your inverter system. The
obtain frequency need to be lower than 10 times/min and 10,000 times/day.
4 Interface content

4.1 Request address

https://www.solaxcloud.com/proxyApp/proxy/api/getRealtimeInfo.do?tokenId={
tokenId}&sn={sn}

4.2 Request parameter

Parameter name Importance Type Length Description Remark

Registration No.
sn Required STRING 10
(communication module)
ON DONGLE
tokenID Required STRING 23or24 tokenID from SolaxCloud
Table 2

4.3 Output parameters

The Result section of the output parameters is described below.


API items Description Accuracy Unit
inverterSN Unique identifier of inverter (Serial No. of inverter) - -
sn Unique identifier of communication module (Registration No.) - -
acpower Inverter.AC.power.total 1 W
yieldtoday Inverter.AC.energy.out.daily 0.1 KWh
yieldtotal Inverter.AC.energy.out.total 0.1 KWh
feedinpower Grid.power.total 1 W
feedinenergy Grid.energy.toGrid.total 0.01 KWh
consumeenergy Grid.energy.fromGrid.total 0.01 KWh
feedinpowerM2 Inverter.Meter2.AC.power.total 1 W
soc BMS.energy.SOC 1 %
peps1 Inverter.AC.EPS.power.R 1 W
peps2 Inverter.AC.EPS.power.S 1 W
peps3 Inverter.AC.EPS.power.T 1 W
inverterType Inverter type, details refer to Table 4 in appendix - -
inverterStatus Inverter status, details refer to Table 5 in appendix - -
(2016-10-26
uploadTime Update time -
17:33:01)
batPower Inverter.DC.Battery.power.total 1 W
powerdc1 Inverter.DC.PV.power.MPPT1 1 W
powerdc2 Inverter.DC.PV.power.MPPT2 1 W
powerdc3 Inverter.DC.PV.power.MPPT3 1 W
powerdc4 Inverter.DC.PV.power.MPPT4 1 W
Table 3

4.4 Example

https://www.solaxcloud.com/proxyApp/proxy/api/getRealtimeInfo.do?tokenId=
20200722185111234567890&sn=ABCDEFGHIJ
Output:

4.5 Notice

1. The device must be online on the SolaxCloud.


2. Get the tokenId in your account on SolaxCloud.

3. Fill in the Registration No.(on the Pocket WiFi/LAN/4G) as sn to use API.


Appendix
Inverter type Inverter status
Type code Inverter type Status code Inverter status
1 X1-LX 100 Wait Mode
2 X-Hybrid 101 Check Mode
3 X1-Hybiyd/Fit 102 Normal Mode
4 X1-Boost/Air/Mini 103 Fault Mode
5 X3-Hybiyd/Fit 104 Permanent Fault Mode
6 X3-20K/30K 105 Update Mode
7 X3-MIC/PRO 106 EPS Check Mode
8 X1-Smart 107 EPS Mode
9 X1-AC 108 Self-Test Mode
10 A1-Hybrid 109 Idle Mode
11 A1-Fit 110 Standby Mode
12 A1-Grid 111 Pv Wake Up Bat Mode
13 J1-ESS 112 Gen Check Mode
14 X3-Hybrid-G4 113 Gen Run Mode
15 X1-Hybrid-G4
16 X3-MIC/PRO-G2
17 X1-SPT
18 X1-Boost/Mini-G4
19 A1-HYB-G2
20 A1-AC-G2
21 A1-SMT-G2
22 X3-FTH
23 X3-MGA-G2
Table 4 Table 5

Communication
Solax Power Co., Ltd.

T: +86-571-56260033

W: www.solaxpower.com

E: [email protected]

You might also like