2.5 Get a list of all user power stations
<p><strong>A brief description:</strong> </p>
<ul>
<li>Get the interface to all user power station lists</li>
</ul>
<p><strong>Request URL: </strong></p>
<ul>
<li><code>http(s)://test.growatt.com/v1/plant/list</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;">page</td>
<td style="text-align: left;">No</td>
<td style="text-align: left;">int</td>
<td>page number,default 1</td>
</tr>
<tr>
<td style="text-align: left;">perpage</td>
<td style="text-align: left;">No</td>
<td style="text-align: left;">int</td>
<td>Number of pages per page, default 20, max 100</td>
</tr>
<tr>
<td style="text-align: left;">search_type</td>
<td style="text-align: left;">No</td>
<td style="text-align: left;">string</td>
<td>search type</td>
</tr>
<tr>
<td style="text-align: left;">search_keyword</td>
<td style="text-align: left;">No</td>
<td style="text-align: left;">string</td>
<td>search keywords</td>
</tr>
</tbody>
</table>
<p><strong>Call example</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">Parameter name</th>
<th style="text-align: left;">Is it required</th>
<th style="text-align: left;">Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">page</td>
<td style="text-align: left;">No</td>
<td style="text-align: left;">1</td>
<td>Page number, default 1</td>
</tr>
<tr>
<td style="text-align: left;">perpage</td>
<td style="text-align: left;">No</td>
<td style="text-align: left;">100</td>
<td>Number per page, default 20, maximum 100</td>
</tr>
<tr>
<td style="text-align: left;">search_type</td>
<td style="text-align: left;">No</td>
<td style="text-align: left;"></td>
<td>Search type</td>
</tr>
<tr>
<td style="text-align: left;">search_keyword</td>
<td style="text-align: left;">No</td>
<td style="text-align: left;">test</td>
<td>Search keyword</td>
</tr>
</tbody>
</table>
<pre><code>{
&quot;page&quot;: &quot;1&quot;,
&quot;perpage&quot;: &quot;100&quot;,
&quot;search_type&quot;: &quot;&quot;,
&quot;search_keyword&quot;: &quot;test&quot;
}</code></pre>
<p><strong>Return to Example</strong></p>
<pre><code>{
&quot;data&quot;: {
&quot;count&quot;: 1,
&quot;plants&quot;: [
{
&quot;status&quot;: 1,
&quot;locale&quot;: &quot;en-US&quot;,
&quot;total_energy&quot;: 0,
&quot;operator&quot;: &quot;0&quot;,
&quot;country&quot;: &quot;China&quot;,
&quot;city&quot;: &quot;0&quot;,
&quot;current_power&quot;: &quot;&quot;,
&quot;create_date&quot;: &quot;2016-09-15&quot;,
&quot;image_url&quot;: null,
&quot;plant_id&quot;: 1185,
&quot;name&quot;: &quot;9&quot;,
&quot;installer&quot;: &quot;0&quot;,
&quot;user_id&quot;: 31,
&quot;longitude&quot;: &quot;&quot;,
&quot;latitude&quot;: &quot;&quot;,
&quot;peak_power&quot;: 0,
&quot;latitude_d&quot;: null,
&quot;latitude_f&quot;: null
}
]
},
&quot;error_code&quot;: 0,
&quot;error_msg&quot;: &quot;&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;">plant_id</td>
<td style="text-align: left;">int</td>
<td>Plant ID</td>
</tr>
<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 power station 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;">peak_power</td>
<td style="text-align: left;">string</td>
<td>Peak power (kWp)</td>
</tr>
<tr>
<td style="text-align: left;">create_date</td>
<td style="text-align: left;">string</td>
<td>Website creation date</td>
</tr>
<tr>
<td style="text-align: left;">installer</td>
<td style="text-align: left;">string</td>
<td>Installer name</td>
</tr>
<tr>
<td style="text-align: left;">current_power</td>
<td style="text-align: left;">string</td>
<td>Current power (W)</td>
</tr>
<tr>
<td style="text-align: left;">total_energy</td>
<td style="text-align: left;">string</td>
<td>Cumulative power generation (kWh)</td>
</tr>
<tr>
<td style="text-align: left;">count</td>
<td style="text-align: left;">int</td>
<td>Total number of power stations</td>
</tr>
<tr>
<td style="text-align: left;">latitude_d</td>
<td style="text-align: left;">string</td>
<td>Agent name</td>
</tr>
<tr>
<td style="text-align: left;">latitude_f</td>
<td style="text-align: left;">string</td>
<td>Agency area</td>
</tr>
<tr>
<td style="text-align: left;">error_code</td>
<td style="text-align: left;">int</td>
<td>error code</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>
<table>
<thead>
<tr>
<th style="text-align: left;">error_code</th>
<th style="text-align: left;">error_msg</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">0</td>
<td style="text-align: left;">Return normally</td>
</tr>
</tbody>
</table>
<pre><code>{
&quot;data&quot;: {
&quot;count&quot;: 1,
&quot;plants&quot;: [
{
&quot;status&quot;: 1,
&quot;locale&quot;: &quot;en-US&quot;,
&quot;total_energy&quot;: 0,
&quot;operator&quot;: &quot;0&quot;,
&quot;country&quot;: &quot;China&quot;,
&quot;city&quot;: &quot;0&quot;,
&quot;current_power&quot;: &quot;&quot;,
&quot;create_date&quot;: &quot;2016-09-15&quot;,
&quot;image_url&quot;: null,
&quot;plant_id&quot;: 1185,
&quot;name&quot;: &quot;9&quot;,
&quot;installer&quot;: &quot;0&quot;,
&quot;user_id&quot;: 31,
&quot;longitude&quot;: &quot;&quot;,
&quot;latitude&quot;: &quot;&quot;,
&quot;peak_power&quot;: 0,
&quot;latitude_d&quot;: null,
&quot;latitude_f&quot;: null
}
]
},
&quot;error_code&quot;: 0,
&quot;error_msg&quot;: &quot;&quot;
}</code></pre>
<table>
<thead>
<tr>
<th style="text-align: left;">error_code</th>
<th style="text-align: left;">error_msg</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">10001</td>
<td style="text-align: left;">System error</td>
</tr>
</tbody>
</table>
<pre><code>{
&quot;data&quot;: &quot;&quot;,
&quot;error_code&quot;: 10001,
&quot;error_msg&quot;: &quot;error_system error&quot;
}</code></pre>
<p><strong>Remark</strong> </p>
<ul>
<li>The acquisition frequency is once every 5 minutes</li>
<li>This interface is only allowed to be called 10 times a day</li>
</ul>