ShineServer_English version


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>{     &amp;quot;data&amp;quot;: {         &amp;quot;address1&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;jurisdictionorganization&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;address2&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;installed_dc_capacity&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;city&amp;quot;: &amp;quot;Shenzhen&amp;quot;,         &amp;quot;timezone&amp;quot;: &amp;quot;GMT+8&amp;quot;,         &amp;quot;designerorganization&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;installercontact&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;create_date&amp;quot;: &amp;quot;2018-12-12&amp;quot;,         &amp;quot;image_url&amp;quot;: &amp;quot;2.png&amp;quot;,         &amp;quot;description&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;longitude&amp;quot;: &amp;quot;113.9&amp;quot;,         &amp;quot;fixed_azimuth&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;offtakercontact&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;status&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;postal&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;weathersensor_num&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;weathersensor_man&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;operatorcontact&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;country&amp;quot;: &amp;quot;China&amp;quot;,         &amp;quot;plant_type&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;fixed_tilt&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;inverters&amp;quot;: [             {                 &amp;quot;inverter_md&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;inverter_num&amp;quot;: 1,                 &amp;quot;inverter_man&amp;quot;: &amp;quot;Growatt&amp;quot;             }         ],         &amp;quot;installerorganization&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;jurisdictioncontact&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;installed_ac_capacity&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;latitude&amp;quot;: &amp;quot;22.6&amp;quot;,         &amp;quot;financiercontact&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;ownerorganization&amp;quot;: &amp;quot;rmb&amp;quot;,         &amp;quot;locale&amp;quot;: &amp;quot;en_US&amp;quot;,         &amp;quot;designercontact&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;state&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;weather_type&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;currency&amp;quot;: &amp;quot;rmb&amp;quot;,         &amp;quot;installed_panel_area&amp;quot;: ​​&amp;quot;&amp;quot;,         &amp;quot;name&amp;quot;: &amp;quot;API interface test power station&amp;quot;,         &amp;quot;user_id&amp;quot;: 33,         &amp;quot;grid_type&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;operatororganization&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;elevation&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;irradiationsensor_type&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;ownercontact&amp;quot;: &amp;quot;rmb&amp;quot;,         &amp;quot;weathersensor_md&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;tracker_type&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;offtakerorganization&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;dataloggers&amp;quot;: [             {                 &amp;quot;datalogger_num&amp;quot;: 1,                 &amp;quot;datalogger_man&amp;quot;: &amp;quot;Growatt&amp;quot;,                 &amp;quot;datalogger_md&amp;quot;: &amp;quot;&amp;quot;             }         ],         &amp;quot;financierorganization&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;peak_power&amp;quot;: 20,         &amp;quot;notes&amp;quot;: &amp;quot;&amp;quot;,         &amp;quot;arrays&amp;quot;: [             {                 &amp;quot;num_modules&amp;quot;: 0,                 &amp;quot;module_md&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;module_man&amp;quot;: &amp;quot;Growatt&amp;quot;             }         ]     },     &amp;quot;error_code&amp;quot;: 0,     &amp;quot;error_msg&amp;quot;: &amp;quot;&amp;quot; }</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>

页面列表

ITEM_HTML