Installs Summaries API (GET /api/solar/open_pv/installs/summaries)

Returns a list of install summary data filtered by optional parameters.

Request URL

GET /api/solar/open_pv/installs/summaries?parameters

Request Parameters

Parameter	Required	Value	Description
api_key	Yes	Type: string Default: None	Your developer API key. See API keys for more information.
county	No	Type: string Default: None	Name of county to filter by
state	No	Type: string Default: None	Two uppercase character state code to filter by
zipcode	No	Type: string Default: None	Postal code to filter by
minsize	No	Type: float Default: None	Floating point number for the minimum size in kw for an install to filter by
maxsize	No	Type: float Default: None	Floating point number for the maximum size in kw for an install to filter by
mindate	No	Type: integer Default: None	Unix timestamp for the minimum date installed to filter by
maxdate	No	Type: integer Default: None	Unix timestamp for the maximum date installed to filter by
user_id	No	Type: integer Default: None	Valid OpenPV web application user ID to filter by
organization_id	No	Type: integer Default: None	Valid OpenPV web application organization ID to filter by
fields	No	Type: string Default: None	A comma delimited list of fields to include in the result. By default all fields are included. This paramter allows callers to limit the number of fields returned with the resultant benefit of faster response times. The following fields can be included: avg_cost_cap_weight - Average cost ($ per watt) for all matched systems calculated as the total cost of all systems divided by the total capacity of all systems. avg_cost_pw - The average cost ($ per watt) for all matched systems calculated as the mean of each system's cost per watt. best_avg_cost_pw - Average cost ($ per watt) for the most recent year with at least 1 install. total_capacity - Total capacity (Mw). total_installs - Total number of installs. total_installs_with_cost - Total number of installs with cost attributes populated.

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 install summary data filtered by optional parameters.

Examples

JSON Output Format

GET /api/solar/open_pv/installs/summaries?api_key=DEMO_KEY&state=CA&minsize=10&maxsize=100

{
  "inputs": {
    "state": "CA",
    "minsize": "10",
    "maxsize": "100"
  },
  "metadata": {
    "version": "2.0.0",
    "resultset": {}
  },
  "status": 200,
  "result": {
    "avg_cost_cap_weight": 6.329,
    "avg_cost_pw": 6.322,
    "best_avg_cost_pw": 4.065,
    "total_capacity": 443.6257,
    "total_installs": 23471,
    "total_installs_with_cost": 22235
  }
}

Rate Limits

Standard rate limits apply. No more than 1,000 requests may be made in any hour.

Errors

Standard errors may be returned.

Help Improve this Content