API Reference

This endpoint returns information about a particular home's carbon footprint impact. Just enter a home's address information and we'll handle the rest. We look up the building characteristics of that particular home, along with climate characteristics and the fuel mix of the area's electricity generation to provide a personalized estimate.

If you don't need that level of specificity, you can also just enter the state and we'll return the fuel mix to give you a general idea of the carbon impact of electricity in that state.

In the response, "carbon_foot_print" is the estimated annual carbon footprint (in pounds) for that home. Additionally, "estimated_generation_data" represents the estimated mix of fuel sources for that home, where "value" is the percentage of electricity that a particular fuel source generates in that area.

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

Responses

204

Unable to calculate usage

500

No Data found!

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