Developer Network NREL NREL Developer Network

Installs Rankings API (GET /api/solar/open_pv/installs/rankings)

Returns a list of install costs and counts by state.

Request URL

GET /api/solar/open_pv/installs/rankings?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

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 costs and counts by state.

Examples

JSON Output Format

GET /api/solar/open_pv/installs/rankings?api_key=DEMO_KEY&state=TN&county=Hamilton
{
  "inputs": {
    "state": "TN",
    "county": "Hamilton"
  },
  "metadata": {
    "version": "2.0.0",
    "resultset": {
      "count": 8
    }
  },
  "status": 200,
  "result": [
    {
      "count": 2,
      "name": "37343",
      "cap": 7.799999714,
      "cost": 0.0
    },
    {
      "count": 3,
      "name": "37363",
      "cap": 14.260000114,
      "cost": 0.0
    },
    .
    .
    .
  ]
}

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