Installs Index API (GET /api/solar/open_pv/installs/index)
Returns a list of all installs matching optional criteria passed or all installs if no optional criteria is passed. The response can be paged or exported.
Request URL
GET /api/solar/open_pv/installs/index?parameters
Request Parameters
| Parameter | Required | Value | Description |
|---|---|---|---|
| api_key | Yes |
Type: string
Default: None
|
Your developer API key. See API keys for more information. |
| state | No |
Type: string
Default: None
|
Two uppercase character state codes |
| zipcode | No |
Type: string
Default: None
|
Postal code |
| minsize | No |
Type: float
Default: None
|
Floating point number for the minimum size in kw for an install |
| maxsize | No |
Type: float
Default: None
|
Floating point number for the maximum size in kw for an install |
| mindate | No |
Type: integer
Default: None
|
Unix timestamp for the minimum date installed |
| maxdate | No |
Type: integer
Default: None
|
Unix timestamp for the maximum date installed |
| user_id | No |
Type: integer
Default: None
|
Valid OpenPV web application user ID |
| organization_id | No |
Type: integer
Default: None
|
Valid OpenPV web application organization ID |
| export | No |
Type: boolean
Default: None
|
Indicator if the data should be exported as a CSV file |
| sort | No |
Type: string
Default: None
|
Name indicating what to sort the response data on. Name can be any of the install fields including but not limited to _id, size_kw, lon, lat, date_installed |
| order | No |
Type: string
Default: None
|
Either ASCE to indicate ascending sort order or DESC to indicate descending sort order |
| pagenum | No |
Type: integer
Default: None
|
Number indicating the page number to return. This is based on the number of installs per page as well as indicated by the optional parameter nppage. So if nppage is 5 and pagenum is 2, you will get back installs 6 to 10. |
| nppage | No |
Type: integer
Default: None
|
Number indicating the number of installs per page to return. |
Response Fields
| Field | Value | Description |
|---|---|---|
| inputs | Type: collection | The input parameters received in the request. |
| metadata | Type: collection | The meta data about the response such as version of the API and resultset which is a collection of it's own that has the result size count |
| status | Type: string | The HTTP status code of the response |
| warnings | Type: array of strings | Present only when any warning messages resulting from the request. |
| errors | Type: array of strings | Present only when any error messages resulting from the request. |
| result | Type: collection | List of all installs matching optional criteria passed or all installs if no optional criteria is passed. |
Examples
JSON Output Format
GET /api/solar/open_pv/installs/index?api_key=DEMO_KEY&state=CA&minsize=10&maxsize=100&pagenum=1&nppage=25&sort=size_kw&order=DESC
{
"inputs": {
"state": "CA",
"minsize": "10",
"maxsize": "100",
"pagenum": "1",
"nppage": "25",
"sort": "size_kw",
"order": "DESC"
},
"metadata": {
"version": "2.0.0",
"resultset": {
"total_pages": 939,
"count": 23471,
"limit": 25,
"offset": 0
}
},
"status": 200,
"result": [
{
"_id": "5049033e27a49b219200a142",
"cost": 391488.0,
"date_installed": 1281506400,
"size_kw": 100.0,
"state": "CA",
"zipcode": "91355"
},
{
"_id": "53fcc75427a49b2255377b7b",
"cost": 576041.0,
"date_installed": 1370498400,
"size_kw": 99.96,
"state": "CA",
"zipcode": "93725"
},
.
.
.
]
}
Rate Limits
Standard rate limits apply. No more than 1,000 requests may be made in any hour.
Errors
Standard errors may be returned.