Get All Electricity Details For A Property

This endpoint combines our electricity estimation, solar, cost, and carbon footprint APIs into one call. This allows us to efficiently re-use components of the calculations and return all data quicker than calling all the APIs separately.

If given address not found it will return 204 status

If given address has mutliple matches it will return 400 status with relavent addresses

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Our identifier for this home

string

The street address of the property

string

City of the property

string

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

string
required

5-digit zip code of the property

number

EID of Utility which is getting in electricity info API

number

Year the home was built

number

Number of bedrooms in the home

number

Number of bathrooms in the home

number

Square footage of livable indoor area

number

Number of floors in the home

number

Square footage of the lot

number
enum
Allowed:
string
string
string
enum
Allowed:
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.

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.

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.

string

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

boolean
enum
Allowed:
boolean
enum
Allowed:
boolean
enum
Allowed:
boolean
enum
Allowed:
boolean
enum
Allowed:
boolean
enum
Allowed:
boolean
enum
Allowed:
boolean
enum
Allowed:
Responses

204

Unable to find address

500

Internal server error

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json