Electricity

Utility Information Lookup

Changed on

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

Request

  • Base URL
    https://apis.wattbuy.com/v3
  • Auth
    API key in header x-api-key

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' | 'regulated_zip'

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.

Example response

{
  "utility_info": [
    {
      "phones": [
        {
          "number": "+18007435002",
          "display": "(800) 743-5002",
          "extension": "333",
          "label": "Billing and Payments",
          "hours": "Mon-Fri 7am-4:30pm"
        }
      ],
      "eid": 6452,
      "country": "ca",
      "utility_key": "bchydro",
      "avg_price": "15.6",
      "customers": 2122790,
      "subdivisions": [
        {
          "id": "climate_x",
          "label": "Climate Zone X",
          "type": "climate_zone",
          "varies": [
            "baseline_allowance"
          ],
          "aliases": [
            "X",
            "Zone X"
          ]
        }
      ],
      "subdivision_id": "climate_x",
      "subdivision_type": "climate_zone",
      "subdivision_confidence": 0.75,
      "subdivision_candidates": [
        {
          "subdivision_id": "climate_6",
          "confidence": 0.333,
          "share": 0.333
        }
      ]
    }
  ],
  "utility_list": [
    {
      "utility_eid": 3278
    }
  ]
}

Changes

    • breaking

      the // response's property type changed from string to integer for status

    • breaking

      the // response's property type changed from string to integer for status

    • warning

      added the new regulated_zip enum value to the response property for the response status

    11 more changes in this revision