v1
latestOpenAPI 3.0.22026-07-141713124.8 KBGet 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
Query parameters
Our identifier for this home
The street address of the property
City of the property
State of the property as a two letter code (e.g. "TX")
5-digit zip code of the property
EID of Utility which is getting in electricity info API
Year the home was built
Number of bedrooms in the home
Number of bathrooms in the home
Square footage of livable indoor area
Number of floors in the home
Square footage of the lot
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.
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.
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.
The end date for the estimation period, formatted as MM/DD/YYYY. This field is required only if start_date is present.
Response
OK