Documentation » Rest » Get Utility Rates

http://en.openei.org/services/rest/utility_rates?params

Access complex utility rate structure information (across all sectors) for most U.S. utility companies from the National Utility Rate Database. This information is collected and quality controlled on a continual basis by Illinois State University on behalf of DOE and housed within the OpenEI.org platform. To browse available data, see the OpenEI utilities gateway.

Request URL

GET http://en.openei.org/services/rest/utility_rates?parameters

Request Parameters

Parameter Required Value Description
version Yes
Options: latest, 1 or 2
OpenEI upgraded from the version 1 to the version 2 schema on December 1st, 2012. On May 4th, 2013, the version 2 API was released with full access to the version 2 utility rate data. Since the Version 1 API could not access the version 2 schema and data, OpenEI has provided a deprecated API with access to data as of December 1st, 2012. This version 1 API will not be accessible past January 2nd, 2013. Please contact the if you have any questions or concerns. As of September 6th, 2013, ISU in coordination with OpenEI has released new fields to the Version 2 API. Please see this schema change blog entry for more details on changes.
format Yes
Options: json, csv, json_plain, or list (experimental)

  • If format=csv, include the 'realheadernames' variable to return OpenEI semantic property header names; assume simple header names if realheadernames variable is not set.
  • The format parameter will be disregarded if the debug parameter is set

limit No
Type: Integer
Maximum record count 1000.
getpage No
Type: String
Get a specific page name, i.e. getpage=Data:03e2df52-a801-45d6-a09b-dba9e4889e89. This is sometimes referred to as "label" in the results.
ratesforutility No
Type: String
Get rates for a specific utility page name, i.e. ratesforutility=Detroit_Edison_Co. This value can be re-used from the "label" value in the utility_companies results.
offset No
Type: Integer
Default:0
The offset from which to start retrieving records.
callback No
Type:String
callback=<mycallback> - set mycallback as the json callback.
detail No
Type:String
Default:minimal
Options: full, basic or minimal"
  • detail=full - returns every variable possible. Since this results in a lot of data that can time-out returning to your server, use a limit=500 and set an offset (e.g. 501) if you want more data. Variables are set based on a manual update from the Template:_______ page, which shows all variables of interest that the form entry uses and the wiki displays.
  • Compare to detail=basic and detail=minimal, which is the default.
debug No
None
Print the ask query sent to the server.

Response Fields

Field Value Description
label
Type: string

Page label.

uri
Type: URI

Full page URI.

type
Type: string

type=Utility_Rates

Examples

JSON Output Format

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{"properties": {},
      "items": [
          {"label": "Data:001bc920-5a47-46e1-84dd-b03f5fa13dce",
           "uri":"http://en.openei.org/wiki/Data:001bc920-5a47-46e1-84dd-b03f5fa13dce",
           "type":"Utility_Rates"},
          {"label": "Data:0040547f-b53d-4f32-9d99-4332fa248212",
             "uri":"http://en.openei.org/wiki/Data:0040547f-b53d-4f32-9d99-4332fa248212",
             "type":"Utility_Rates"},
          {"label": "Data:0055db46-f535-4dc9-a192-920d1bdf382b",
           "uri":"http://en.openei.org/wiki/Data:0055db46-f535-4dc9-a192-920d1bdf382b",
           "type":"Utility_Rates"}]
}

CSV Output Format

  1
  2
  3
  4
PageName
Data:001bc920-5a47-46e1-84dd-b03f5fa13dce
Data:0040547f-b53d-4f32-9d99-4332fa248212
Data:0055db46-f535-4dc9-a192-920d1bdf382b

Errors

Returns a description of the error