2.6 Get basic information about a power station
<p><strong>A brief description:</strong> </p>
<ul>
<li>Interface to obtain basic information about a power station</li>
</ul>
<p><strong>Request URL: </strong></p>
<ul>
<li><code>http(s)://test.growatt.com/v1/plant/details</code>
<strong>Request method: </strong></li>
<li>get</li>
</ul>
<p><strong>Parameters: </strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">Parameter Name</th>
<th style="text-align: left;">Whether Required</th>
<th style="text-align: left;">Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">plant_id</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">int</td>
<td>Power Station ID</td>
</tr>
</tbody>
</table>
<p> <strong>Back to example</strong></p>
<pre><code>{
"data": {
"address1": "",
"jurisdictionorganization": "",
"address2": "",
"installed_dc_capacity": "",
"city": "Shenzhen",
"timezone": "GMT+8",
"designerorganization": "",
"installercontact": "",
"create_date": "2018-12-12",
"image_url": "2.png",
"description": "",
"longitude": "113.9",
"fixed_azimuth": "",
"offtakercontact": "",
"status": "",
"postal": "",
"weathersensor_num": "",
"weathersensor_man": "",
"operatorcontact": "",
"country": "China",
"plant_type": "",
"fixed_tilt": "",
"inverters": [
{
"inverter_md": "",
"inverter_num": 1,
"inverter_man": "Growatt"
}
],
"installerorganization": "",
"jurisdictioncontact": "",
"installed_ac_capacity": "",
"latitude": "22.6",
"financiercontact": "",
"ownerorganization": "rmb",
"locale": "en_US",
"designercontact": "",
"state": "",
"weather_type": "",
"currency": "rmb",
"installed_panel_area": "",
"name": "API interface test power station",
"user_id": 33,
"grid_type": "",
"operatororganization": "",
"elevation": "",
"irradiationsensor_type": "",
"ownercontact": "rmb",
"weathersensor_md": "",
"tracker_type": "",
"offtakerorganization": "",
"dataloggers": [
{
"datalogger_num": 1,
"datalogger_man": "Growatt",
"datalogger_md": ""
}
],
"financierorganization": "",
"peak_power": 20,
"notes": "",
"arrays": [
{
"num_modules": 0,
"module_md": "",
"module_man": "Growatt"
}
]
},
"error_code": 0,
"error_msg": ""
}</code></pre>
<p> <strong>Return parameter description</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">Parameter Name</th>
<th style="text-align: left;">Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">name</td>
<td style="text-align: left;">string</td>
<td>power station name</td>
</tr>
<tr>
<td style="text-align: left;">user_id</td>
<td style="text-align: left;">int</td>
<td>User ID to which the plant belongs</td>
</tr>
<tr>
<td style="text-align: left;">country</td>
<td style="text-align: left;">string</td>
<td>country name</td>
</tr>
<tr>
<td style="text-align: left;">longitude</td>
<td style="text-align: left;">string</td>
<td>Longitude</td>
</tr>
<tr>
<td style="text-align: left;">latitude</td>
<td style="text-align: left;">string</td>
<td>Latitude</td>
</tr>
<tr>
<td style="text-align: left;">create_date</td>
<td style="text-align: left;">string</td>
<td>Building date</td>
</tr>
<tr>
<td style="text-align: left;">image_url</td>
<td style="text-align: left;">string</td>
<td>Picture url</td>
</tr>
<tr>
<td style="text-align: left;">peak_power</td>
<td style="text-align: left;">string</td>
<td>peak power (kWp)</td>
</tr>
<tr>
<td style="text-align: left;">currency</td>
<td style="text-align: left;">string</td>
<td>currency unit</td>
</tr>
<tr>
<td style="text-align: left;">timezone</td>
<td style="text-align: left;">string</td>
<td>Time Zone</td>
</tr>
<tr>
<td style="text-align: left;">plant_type</td>
<td style="text-align: left;">int</td>
<td>Plant type(0-Residential Plant,1-Commercial Plant,2-Ground-Mounted Plants)</td>
</tr>
<tr>
<td style="text-align: left;">address1</td>
<td style="text-align: left;">string</td>
<td>Plant address</td>
</tr>
<tr>
<td style="text-align: left;">error_code</td>
<td style="text-align: left;">int</td>
<td>0: Normal return, 10001: System error， 10002: Power station does not exist, 10003: Power station ID is empty, 10004: User does not exist</td>
</tr>
<tr>
<td style="text-align: left;">error_msg</td>
<td style="text-align: left;">string</td>
<td>Error message prompt</td>
</tr>
</tbody>
</table>
<p> <strong>Remarks</strong></p>
<ul>
<li>Get the frequency once every 5 minutes</li>
</ul>