OpenEI Web Services

https://openei.org/services/doc/
Admin
OpenEI Web Services provide access to high-value data and information through various APIs,...
Tokens:12,423
Snippets:32
Trust Score:9.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Utility Rates API Example

Source: https://openei.org/services/doc/rest/util_rates

Example of how to retrieve utility rate data using the OpenEI API. This demonstrates a GET request with parameters for version, format, limit, and API key, returning a JSON object containing a list of utility rate items.

```HTTP
GET https://api.openei.org/utility_rates?version=5&format=json&limit=3&api_key=EXAMPLE_API_KEY
```

--------------------------------

### Get Utility Rates API Example

Source: https://openei.org/services/doc/rest/util_rates_version=7

Example of how to retrieve utility rate data using the OpenEI API. This demonstrates a GET request with parameters for version, format, limit, and API key, returning a JSON object containing a list of utility rate items.

```HTTP
GET https://api.openei.org/utility_rates?version=5&format=json&limit=3&api_key=EXAMPLE_API_KEY
```

--------------------------------

### Get Utility Companies - JSON Output Example

Source: https://openei.org/services/doc/rest/util_cos_version=3

This example demonstrates how to request utility company data in JSON format from the OpenEI API. It specifies the API version, desired format, and requires an API key for authentication.

```HTTP
GET https://api.openei.org/utility_companies?version=latest&format=json&api_key=EXAMPLE_API_KEY
```

--------------------------------

### JSON Output Example

Source: https://openei.org/services/doc/rest/util_rates_version=3

This is an example of the JSON response format when requesting utility rate data. It shows a list of items, each with a label, URI, and type.

```JSON
{
  "items": [
          {"label": "5374efea9bef51471a6965d0",
           "uri":"https://openei.org/apps/USURDB/rate/view/5374efea9bef51471a6965d0",
           "type":"Utility_Rates"},
          {"label": "5374efea9bef51471a6965d2",
             "uri":"https://openei.org/apps/USURDB/rate/view/5374efea9bef51471a6965d2",
             "type":"Utility_Rates"},
          {"label": "5374efea9bef51471a6965d4",
           "uri":"https://openei.org/apps/USURDB/rate/view/5374efea9bef51471a6965d4",
           "type":"Utility_Rates"}]
}
```

--------------------------------

### Get Utility Companies - JSON Response Example

Source: https://openei.org/services/doc/rest/util_cos_version=3

This is an example of the JSON response format returned by the OpenEI utility companies web service. It includes a list of utility companies, each with a 'label' and a 'uri'.

```JSON
{
      "properties": {},
      "items": [
          {"label": "3 Phases Energy Services",
           "uri":"https://openei.org/wiki/3 Phases Energy Services"},
          {"label": "4-County Electric Power Assn",
           "uri":"https://openei.org/wiki/4-County Electric Power Assn"},
          {"label": "A & N Electric Coop",
           "uri":"https://openei.org/wiki/A & N Electric Coop"}
      ]

}
```

--------------------------------

### CSV Output Example

Source: https://openei.org/services/doc/rest/util_rates_version=3

This example illustrates the CSV response format for utility rate data. It typically includes a header row followed by the data, with each row representing a utility rate entry.

```CSV
PageName
5374efea9bef51471a6965d0
5374efea9bef51471a6965d2
5374efea9bef51471a6965d4
```

--------------------------------

### Fetch Utility Rates (JSON)

Source: https://openei.org/services/doc/rest/util_rates_version=3

This example demonstrates how to fetch utility rate data from the OpenEI API in JSON format. It includes parameters for version, format, limit, and API key.

```HTTP
GET https://api.openei.org/utility_rates?version=3&format=json&limit=3&api_key=EXAMPLE_API_KEY
```

--------------------------------

### Get Utility Companies - JSON Output

Source: https://openei.org/services/doc/rest/util_cos_version=2

This example demonstrates how to request utility company data from the OpenEI API in JSON format. It requires specifying the API version, desired format, and an API key.

```HTTP
GET https://api.openei.org/utility_companies?version=latest&format=json&api_key=EXAMPLE_API_KEY
```

```JSON
{
      "items": [
          {"label": "3 Phases Energy Services",
           "uri":"https://openei.org/wiki/3 Phases Energy Services"},
          {"label": "4-County Electric Power Assn",
           "uri":"https://openei.org/wiki/4-County Electric Power Assn"},
          {"label": "A & N Electric Coop",
           "uri":"https://openei.org/wiki/A & N Electric Coop"}
      ]

}
```

--------------------------------

### Get New Mexico Incentives API Request

Source: https://openei.org/services/doc/rest/incentives

This snippet shows an example GET request to the OpenEI API to retrieve incentives for New Mexico, specifically filtering for commercial sectors and all active incentives. It demonstrates how to construct the URL with query parameters.

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

--------------------------------

### Get Utility Rates API Request (JSON)

Source: https://openei.org/services/doc/rest/util_rates

Example of a GET request to the OpenEI utility_rates API to retrieve rate information in JSON format. This demonstrates the basic structure and required parameters.

```HTTP
GET https://api.openei.org/utility_rates?version=3&format=json&api_key=YOUR_API_KEY&sector=Residential
```

--------------------------------

### Get Utility Rates API Request (CSV)

Source: https://openei.org/services/doc/rest/util_rates

Example of a GET request to the OpenEI utility_rates API to retrieve rate information in CSV format. This shows how to specify the output format for tabular data.

```HTTP
GET https://api.openei.org/utility_rates?version=latest&format=csv&api_key=YOUR_API_KEY&ratesforutility=Detroit Edison Co.
```

--------------------------------

### Utility Rates JSON Output Example

Source: https://openei.org/services/doc/rest/util_rates

Example JSON output format for utility rate data retrieved from the OpenEI API. The structure includes an 'items' array, where each item has a 'label', 'uri', and 'type'.

```JSON
{
  "items": [
          {"label": "5374efea9bef51471a6965d0",
           "uri":"https://openei.org/apps/USURDB/rate/view/5374efea9bef51471a6965d0",
           "type":"Utility_Rates"},
          {"label": "5374efea9bef51471a6965d2",
             "uri":"https://openei.org/apps/USURDB/rate/view/5374efea9bef51471a6965d2",
             "type":"Utility_Rates"},
          {"label": "5374efea9bef51471a6965d4",
           "uri":"https://openei.org/apps/USURDB/rate/view/5374efea9bef51471a6965d4",
           "type":"Utility_Rates"}]
}
```

--------------------------------

### Content Assist Recommend API JSON Output

Source: https://openei.org/services/doc/rest/recommend

Example of the JSON output format for the Content Assist Recommend API. It includes recommended terms with definitions, raw terms with relevance scores, and a list of recommended pages with their names, links, and types.

```JSON
callback({
    "terms": [
        {
            "term": "Energy",
            "definition": "Broadly defined as the capacity to do work. There are many forms of energy..."
        },
        {
            "term": "Solar energy",
            "definition": "Radiant energy emitted by the sun"
        }
    ],
    "terms_raw": [
        [
            "solar",
            100
        ],
        [
            "energy",
            61
        ]
    ],
    "pages": [
        {
            "name": "ECOWAS Clean Energy Gateway",
            "link": "/wiki/Gateway:ECOWAS_Clean_Energy_Gateway",
            "type": "Articles"
        },
        {
            "name": "Approve Page",
            "link": "/wiki/Help:Approve_Page",
            "type": "Help Pages"
        },
        {
            "name": "Enhanced Geothermal Systems",
            "link": "/wiki/Definition:Enhanced_Geothermal_Systems",
            "type": "Definitions"
        },
        {
            "name": "Wilson Eric Bio Photo2.jpg",
            "link": "/wiki/File:Wilson_Eric_Bio_Photo2.jpg",
            "type": "Images"
        },
        {
            "name": "0383(2011).pdf",
            "link": "/wiki/File:0383(2011).pdf",
            "type": "Documents"
        },
        {
            "name": "Ryan's response",
            "link": "community/node/12#comment-2",
            "type": "Community"
        },
        {
            "name": "NREL-nv-80m.jpg",
            "link": "/wiki/File:NREL-nv-80m.jpg",
            "type": "Map Files"
        },
        {
            "name": "STIL2 Swedish Office Buildings Survey",
            "link": "/datasets/node/37",
            "type": "Datasets"
        }
    ]
})
```

--------------------------------

### CSV Output Example for Utility Rates

Source: https://openei.org/services/doc/rest/util_rates

This snippet illustrates the expected structure of the CSV output when requesting utility rates from the OpenEI API. It shows a header row and subsequent data rows, with each row representing a record.

```CSV
PageName
5374efea9bef51471a6965d0
5374efea9bef51471a6965d2
5374efea9bef51471a6965d4
```

--------------------------------

### Utility Rates JSON Output Example

Source: https://openei.org/services/doc/rest/util_rates_version=7

Example JSON output format for utility rate data retrieved from the OpenEI API. The structure includes an 'items' array, where each item has a 'label', 'uri', and 'type'.

```JSON
{
  "items": [
          {"label": "5374efea9bef51471a6965d0",
           "uri":"https://openei.org/apps/USURDB/rate/view/5374efea9bef51471a6965d0",
           "type":"Utility_Rates"},
          {"label": "5374efea9bef51471a6965d2",
             "uri":"https://openei.org/apps/USURDB/rate/view/5374efea9bef51471a6965d2",
             "type":"Utility_Rates"},
          {"label": "5374efea9bef51471a6965d4",
           "uri":"https://openei.org/apps/USURDB/rate/view/5374efea9bef51471a6965d4",
           "type":"Utility_Rates"}]
}
```

--------------------------------

### Fetch Utility Rates (CSV)

Source: https://openei.org/services/doc/rest/util_rates_version=3

This example shows how to request utility rate data from the OpenEI API in CSV format. Similar to the JSON request, it uses version, format, limit, and API key parameters.

```HTTP
GET https://api.openei.org/utility_rates?version=3&format=csv&limit=3&api_key=EXAMPLE_API_KEY
```

--------------------------------

### Retrieve Utility Rates with Pagination (JSON)

Source: https://openei.org/services/doc/rest/util_rates_version=3

This example illustrates fetching utility rate data in JSON format with pagination. It uses the 'limit' and 'offset' parameters to retrieve specific subsets of data, which is useful for handling large datasets.

```json
{
  "request": {
    "url": "https://api.openei.org/utility_rates",
    "parameters": {
      "api_key": "YOUR_API_KEY",
      "format": "json",
      "limit": 500,
      "offset": 501,
      "orderby": "label",
      "direction": "desc"
    }
  }
}
```

--------------------------------

### Access Utility Rates API (GET Request)

Source: https://openei.org/services/doc/rest/util_rates_version=7

This snippet demonstrates how to make a GET request to the OpenEI Utility Rates API to retrieve utility rate information. It includes common parameters for filtering and formatting the results.

```HTTP
GET https://api.openei.org/utility_rates?version=latest&format=json&api_key=YOUR_API_KEY&sector=Residential&country=USA
```

--------------------------------

### Get Utility Companies (JSON)

Source: https://openei.org/services/doc/rest/util_cos_version=1

Retrieves a list of utility companies in JSON format. Requires an API key and allows specifying version, limit, and other parameters.

```HTTP
GET https://api.openei.org/utility_companies?version=latest&format=json&api_key=EXAMPLE_API_KEY&limit=3
```

```JSON
{
      "properties": {},
      "items": [
          {"label": "3 Phases Energy Services",
           "uri":"https://openei.org/wiki/3 Phases Energy Services",
           "type":"EIA_Utility_Companies_and_Aliases"},
          {"label": "4-County Electric Power Assn",
           "uri":"https://openei.org/wiki/4-County Electric Power Assn",
           "type":"EIA_Utility_Companies_and_Aliases"},
          {"label": "A & N Electric Coop",
           "uri":"https://openei.org/wiki/A & N Electric Coop",
           "type":"EIA_Utility_Companies_and_Aliases"}]

}
```

--------------------------------

### CSV Output Example for Utility Rates

Source: https://openei.org/services/doc/rest/util_rates_version=7

This snippet illustrates the expected structure of the CSV output when requesting utility rates from the OpenEI API. It shows a header row and subsequent data rows, with each row representing a record.

```CSV
PageName
5374efea9bef51471a6965d0
5374efea9bef51471a6965d2
5374efea9bef51471a6965d4
```

--------------------------------

### Get Utility Companies (CSV)

Source: https://openei.org/services/doc/rest/util_cos_version=1

Retrieves a list of utility companies in CSV format. Requires an API key and allows specifying version, limit, and other parameters.

```HTTP
GET https://api.openei.org/utility_companies?version=latest&format=csv&limit=3&api_key=EXAMPLE_API_KEY
```

```CSV
PageName
"3 Phases Energy Services"
"4-County Electric Power Assn"
"A & N Electric Coop"
```

--------------------------------

### Get Location Incentives (JSON)

Source: https://openei.org/services/doc/rest/incentives

Retrieves incentive information for a specified location in JSON format. Supports filtering by sectors and categories, and pagination.

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

--------------------------------

### Request Utility Rates in CSV Format

Source: https://openei.org/services/doc/rest/util_rates

This snippet shows how to make a GET request to the OpenEI API to retrieve utility rates in CSV format. It specifies parameters like version, format, limit, and requires an API key. The response is expected to be a CSV formatted string.

```HTTP
GET https://api.openei.org/utility_rates?version=5&format=csv&limit=3&api_key=EXAMPLE_API_KEY
```

--------------------------------

### Request Utility Rates in CSV Format

Source: https://openei.org/services/doc/rest/util_rates_version=7

This snippet shows how to make a GET request to the OpenEI API to retrieve utility rates in CSV format. It specifies parameters like version, format, limit, and requires an API key. The response is expected to be a CSV formatted string.

```HTTP
GET https://api.openei.org/utility_rates?version=5&format=csv&limit=3&api_key=EXAMPLE_API_KEY
```

--------------------------------

### OpenEI SPARQL XML Output Format

Source: https://openei.org/services/doc/rest/incentives

This snippet displays the structure of the XML response returned by the OpenEI API for incentive data. It includes the SPARQL namespace, head section defining variables, and results section with bindings for incentive name, page, type, and description.

```XML
<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>
```

--------------------------------

### Retrieve Utility Rates (JSON)

Source: https://openei.org/services/doc/rest/util_rates_version=3

This snippet demonstrates how to request utility rate data in JSON format from the OpenEI API. It requires an API key and allows filtering by various parameters such as sector, location, and approval status.

```json
{
  "request": {
    "url": "https://api.openei.org/utility_rates",
    "parameters": {
      "api_key": "YOUR_API_KEY",
      "format": "json",
      "sector": "Residential",
      "address": "1600 Pennsylvania Ave NW, Washington, DC"
    }
  }
}
```

--------------------------------

### Retrieve Utility Rates (CSV)

Source: https://openei.org/services/doc/rest/util_rates_version=3

This snippet shows how to request utility rate data in CSV format from the OpenEI API. Similar to JSON requests, it requires an API key and supports various filtering options for targeted data retrieval.

```csv
"https://api.openei.org/utility_rates?api_key=YOUR_API_KEY&format=csv&sector=Commercial&ratesforutility=Con Edison"
```

--------------------------------

### Retrieve Utility Rates by Location (JSON)

Source: https://openei.org/services/doc/rest/util_rates_version=3

This snippet demonstrates how to retrieve utility rate data based on geographical coordinates (latitude and longitude) in JSON format. It requires both 'lat' and 'lon' parameters to be set, and the 'address' parameter should not be used simultaneously.

```json
{
  "request": {
    "url": "https://api.openei.org/utility_rates",
    "parameters": {
      "api_key": "YOUR_API_KEY",
      "format": "json",
      "lat": 38.897675,
      "lon": -77.036547,
      "detail": "full"
    }
  }
}
```

--------------------------------

### General Error Response in XML

Source: https://openei.org/services/doc/rest/web_service_errors

This snippet demonstrates the general structure of an error response when the requested format is XML. It typically contains an error message indicating an issue, such as an invalid API key.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>An invalid api_key was supplied. Get one at https://developer.nrel.gov/</error>
</errors>
```

--------------------------------

### General Error Response in Plain Text

Source: https://openei.org/services/doc/rest/web_service_errors

This snippet shows the general format of an error response when the requested format is plain text. It typically prefixes the error message with 'Error:'.

```text
Error: An invalid api_key was supplied. Get one at https://developer.nrel.gov/
```

--------------------------------

### General Error Response in JSON

Source: https://openei.org/services/doc/rest/web_service_errors

This snippet shows the general structure of an error response when the requested format is JSON. It includes a list of error messages.

```json
{
  "errors":[
    "An error has occurred."
  ]
}
```

--------------------------------

### General Error Response in CSV

Source: https://openei.org/services/doc/rest/web_service_errors

This snippet illustrates the general format of an error response when the requested format is CSV. It usually includes a header and the error message.

```csv
Error
An invalid api_key was supplied. Get one at https://developer.nrel.gov/
```
Tokens:
Raw