Web Services

Documentation » Fetch Incentives for Renewables & Efficiency

GET /services/api/place/<name>/incentives/v1

The /incentives endpoint returns a list of all insentives offered by utility companies for renewables and efficiency.

You'll need an API key to send a request. You can request a free API key using our signup form.

Standard Request

The request URL provides the endpoint where your request will be sent. You'll need to send a GET request to:

https://openei.org/services/api/place/<name>/incentives/v1?parameters

You'll replace parameters with any of the request parameters.

Request Parameters

Parameter Required Value Description
format No
Type: string
Default:xml
Options: json, xml, csv, html

The format determines how the response will be output.

sectors[] No
Type:Array of strings
Default:All
Options: commercial, residential, and/or industrial

The electric sectors that are included in the search. If no sector is specified, all are included.
categories[] No
Type: Array of strings
Default:All
Options: federal, state, and/or local
The incentive electric categories that are included in the search. If no source category is specified, all are included.
active No
Type: String
Default:yes
Options: yes, no, or all
Choose to include only rates that are active, inactive, or both. The flag is set to active only by default.
get_count No
Type: Integer
Default:0
Options: 0/1
Choose if you would like to include a count of how many matches were found in your search.
limit No
Type: Integer
Default:None
 Choose how many rates to return. You can combine this parameter with offset to page through results.
offset No
Type: Integer
Default:0
 Return a list of records starting from a certain record number. For example, if you have set a limit of 500 records, but would like to return the records 500-1,000, you can set the offset to 500.

Response Fields

Field Value Description
incentive_name
Type: string

The incentive name.
incentive_page
Type: string

The link to the incentive information page at OpenEI.org.
incentive_type
Type: string

The description of the type of incentive.
incentive_descr
Type: string

The longer description of the incentive.
get_count
Type: int

The number of matches that were returned for the given search parameters.

Examples

Get a list of incentives in JSON format

Request

GET /services/api/place/Utah/incentives/v1?format=json&sectors[]=industrial&categories[]=local

Be sure to:

  • Replace industrial with the section you would like to search for.
  • Replace local with the category you would like to search for.

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
{ "head": {
    "link": [],
    "vars": [
      "incentive_name",
      "incentive_page",
      "incentive_type",
      "incentive_descr"] },
  "results": {
    "distinct": false,
    "ordered": true,
    "bindings": [
      {"incentive_name": {
          "type": "literal",
          "value": "Interconnection Standards (Utah)" }	,
       "incentive_page": {
          "type": "uri",
          "value": "https://openei.org/wiki/Interconnection_Standards_(Utah)" },
       "incentive_type": {
         "type": "literal",
         "value": "Rules Regulations Policies Incentive Programs" },
       "incentive_descr": {
         "type": "typed-literal",
         "datatype": "http://www.w3.org/2001/XMLSchema#string",
         "value": "Utah requires the state's only investor-owned util..." }},
      {"incentive_name": {
         "type": "literal",
         "value": "Rocky Mountain Power - Solar Incentive Program (Utah)" },
       "incentive_page": {
         "type": "uri",
         "value": "https://openei.org/wiki/Rocky_Mountain_Power_-_Solar_Incentive_Program_(Utah)" },
       "incentive_type": {
         "type": "literal",
         "value": "Financial Incentive Programs" },
       "incentive_descr": {
         "type": "typed-literal",
         "datatype": "http://www.w3.org/2001/XMLSchema#string",
         "value": "Note: Rocky Mountain Power began accepting applications for..." }} ] } }

Get a list of recommendations in XML format

Request

GET /services/api/place/New Mexico/incentives/v1?sectors[]=commercial&active=All

Be sure to:

  • Replace commercial with the section you would like to search for.
  • Replace active if you would like to see inactive rates.

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
<sparql xmlns="http://www.w3.org/2005/sparql-results#"
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                            xsi:schemaLocation="http://www.w3.org/2001/sw/DataAccess/rf1/result2.xsd">
 <head>
  <variable name="incentive_name"/>
  <variable name="incentive_page"/>
  <variable name="incentive_type"/>
  <variable name="incentive_descr"/>
 </head>
 <results distinct="false" ordered="true">
  <result>
   <binding name="incentive_name">
     <literal>El Paso Electric Company - SCORE Plus Standard Offer Program (New Mexico)</literal>
   </binding>
   <binding name="incentive_page">
     <uri>https://openei.org/wiki/El_Paso_Electric_Company_-_SCORE_Plus_Standard_Offer_Program_(New_Mexico)</uri>
   </binding>
   <binding name="incentive_type">
     <literal>Financial Incentive Programs</literal>
   </binding>
   <binding name="incentive_descr">
     <literal datatype="http://www.w3.org/2001/XMLSchema#string">The El Paso Electric (EPE) SCORE Plus Program is designed...</literal>
   </binding>
  </result>
  <result>
   <binding name="incentive_name">
     <literal>El Paso Electric Company - Small and Medium System Renewable Energy Certificate Purchase Program (New Mexico)</literal>
   </binding>
   <binding name="incentive_page">
     <uri>https://openei.org/wiki/El_Paso_Electric_Company_-_Small_and_Medium_System_Renewable_Energy_Certificate_Purchase_Program_(New_Mexico)</uri>
   </binding>
   <binding name="incentive_type">
     <literal>Financial Incentive Programs</literal>
   </binding>
   <binding name="incentive_descr">
     <literal datatype="http://www.w3.org/2001/XMLSchema#string">Effective January 1, 2010, El Paso Electric is purchasing...</literal>
   </binding>
  </result>
 </results>
</sparql>

Errors

Standard errors may be returned. In addition, the following service-specific errors may be returned:

HTTP Status Code Description
400 Invalid Request — One or more parameters did not pass validation or a parameter may be missing. Check the error section of the response to see how the request URL should be modified to address the error.
500 A problem occurred on the server-side. This is likely due to a failure of a downsteram service. The request cannot be processed at this time.

Additional Resources