Sign in

v1

latestOpenAPI 3.0.22026-07-141713124.8 KB
Electricity

Utility Information Lookup

This endpoint returns the key details about the electric utility serving a particular location. Pass in a user’s location and return the utility name, phone number, web address, and any other key information available.

Both US and Canadian locations are supported. For a Canadian location the response includes a country field set to "ca".

get/electricity/info

Query parameters

wattkeystring

Our identifier for this home

addressstring

The street address of the property

citystring

City of the property

statestring

US state as a two-letter code (e.g. "TX") or a Canadian province/territory code (e.g. "NS", "QC").

zipstring required

US 5-digit ZIP (e.g. "75001") or Canadian postal code (e.g. "B3J 2A8").

zip_fallbackboolean

Search utility by zipcode if address search fails

housing_charstrue | false
utility_listtrue | false

Response

OK

type'regulated' | 'deregulated'

The type of energy service for the address, either regulated or deregulated.

esiidstring

The Electric Service Identifier (ESID) of the address.

exact_matchboolean

Indicates whether the search results are an exact match to the address searched.

exact_match_reason'success' | 'multiple_addresses_found' | 'unknown' | 'address_unavailable'

The reason for the exact match result, if applicable.

wattkeystring

The unique identifier for the address used to call the address again in other API endpoints.