Documentation » Get Utility Companies

https://api.openei.org/utility_companies?params

This service returns all entries in the OpenEI category EIA Utility Companies and Aliases. It includes alias names (e.g. Xcel Energy of Colorado is an alias for Public Service Co of Colorado). The utility rate web service accepts a utility company or utility company alias for its "ratesforutility" parameter.

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

Request URL

GET https://api.openei.org/utility_companies?parameters

Request Parameters

Parameter	Required	Value	Description
version	Yes	Options: latest, 1, 2 or 3
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
api_key	Yes	Type: String	Register for a key here, it's free!
limit	No	Type: Integer	Maximum record count is 1000.
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_companies

Examples

JSON Output Format

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

    
          {"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 Format

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

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

Errors

Returns a description of the error

Web Services