Electricity Usage Estimate

get https://apis.wattbuy.com/v3/electricity/estimation

This endpoint returns a home’s expected electricity usage (in kWh) over a 12-month period, as well as the carbon footprint, utility rate, expected bill, and more. Our best-in-class machine learning model is trained on millions of data points and is constantly being updated with new information to create a personalized estimation output to every home.

There are a number of ways this API can be used, depending on the amount of data you already have.

Case 1 (Zip Code Only): The minimum input required is a zip code. This allows us to apply weather and climate data in order to return a usage prediction for the average home in the area

Case 2 (Full Address): This is the most common use case. You provide the address of the user and we take care of the rest! We use the address to fill in the rest of the fields for you.

Case 3 (Housing Data): If you don't have the address but you know some other characteristics of the home (square footage, bedrooms, etc), you can manually enter those as well and we'll apply whatever you have to the model.

Case 4 (Address and Housing Data): For the best results, you can enter both the address and the housing data. We'll trust any housing data you give us, and use the address to attempt to fill in any empty fields.

Query Params

wattkey

string

Our identifier for this home

address

string

The street address of the property

city

string

City of the property

state

string

State of the property as a two letter code (e.g. "TX")

zip

string

required

5-digit zip code of the property

year_built

number

The year the home was built. Should be four digits.

bedrooms

number

The number of bedrooms in the home.

bathrooms

number

The number of bathrooms in the home.

sq_ft

number

The square footage of the home.

stories

number

The number of stories in the home.

house_type

string

The house type. Either house or apartment.

heating_fuel_source

string

assuming_kwh_usage

number

This field indicates the monthly average kWh usage on the given address. If the date range is provided, the usage ML model will consider it accordingly.

assuming_bill

number

This field indicates the monthly average bill in dollars on the given address. If the date range is provided, the usage ML model will consider it accordingly. This field is not allowed if assuming_kwh_usage is present.

start_date

string

The start date for the estimation period, formatted as MM/DD/YYYY. This field is required only if either assuming_kwh_usage or assuming_bill is provided.

end_date

string

The end date for the estimation period, formatted as MM/DD/YYYY. This field is required only if start_date is present.

Responses

204

Unable to calculate usage

500

Internal server error

200OK

400Bad request