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

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

Provides information about incentives for renewables and efficiency associated with a specific location.

Request URL
Request Parameters
Response Fields
Examples
- JSON Output Format
- XML Output Format
Errors

Request URL

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

Request Parameters

Parameter	Required	Value	Description
format	No	Type: string Default:xml Options: json, xml, csv, html	The output response format.
sectors[]	No	Type:Array of strings Default:All Options: commercial, residential, and/or industrial	Incentive sectors to include in search. If no sector is specified, all are included.
categories[]	No	Type: Array of strings Default:All Options: federal, state, and/or local	Incentive source categories to include in search. If no source category is specified, all are included.
active	No	Type: String Default:yes Options: yes, no, or all	Flag for inclusion of active only, inactive only, or all. Default is active only.
get_count	No	Type: Integer Default:0 Options: 0/1	Flag to simply include the count of matches.
limit	No	Type: Integer Default:None	Limit number of results. When used with offset, may be used to page through results.
offset	No	Type: Integer Default:0	Return results beginning at specified offset. When used with limit, may be used to page through results.

Response Fields

Field	Value	Description
incentive_name	Type: string	Incentive name.
incentive_page	Type: string	URL for incentive information page at OpenEI.org.
incentive_type	Type: string	Description of the incentive type.
incentive_descr	Type: string	Long description of the incentive.
get_count	Type: int	Number of matches for the given search parameters.

Examples

JSON Output Format

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

    
      
        
      
          { "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..." }} ] } }
          

      

  

XML Output Format

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

    
      
        
        
            <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.

Web Services