The Home Energy Saver API enables software developers to access the calculation engine of the Home Energy Saver, the first web-base home energy calculator. The HES API can be used to build applications that support home inspections or comprehensive energy assessment. There is a project gallery on the developers.buildingsapi.lbl.gov site displaying the work of third party developers using the HES API. The Home Energy Saver API also powers the existing (or Legacy) Home Energy Saver professional and consumer websites.
The main Home Energy Saver API documentation site isdevelopers.buildingsapi.lbl.gov. This page provides a brief overview of the object model and the WSDL's for the Scoring Tool API for detailed descriptions of the methods see the developers.buildingsapi.lbl.gov site.
Note that in order to use the HES-SF API you must have previously obtained an API key by completing the Licensing process. This will be a 32 digit hexadecimal key.
The general steps for accessing the API, and performing a calculation are as follows:
An updated version of the API - the HES single family API - is under development. A first version of the single family API powers the current (now v2015) version of the Home Energy Score website, and the model will be expanded to accommodate the needs of the professional and consumer Home Energy Saver websites. See the "HES Pro API v2.0" pages on this site for early documentation of the new API structure.
Home Energy Saver >