The Home Energy Scoring Tool API consists of all the software methods needed to serve the Home Energy Scoring Tool (homeenergyscore.lbl.gov) and all third-party user interfaces in the Home Energy Score Program. These Methods may be accessed through almost any SOAP compatible client found in popular languages like PHP 5, JAVA and .NET.
In order to use the Home Energy Score API you must have previously obtained a 3scale client ID by completing the Licensing process. Access will also be restricted to U. S. DOE approved Qualified Assessors. For information on the Qualified Assessor program see the DOE Home Energy Score website.
Documentation of the methods used in the Scoring Tool v2015 API can be found on the API Methods page.
The general steps for accessing the API, and performing a complete Scoring Tool calculation are described below. The specifics of the methods as well as sample code for each can be found on the API Methods page
March 22, 2015 - Release of version 2015 of the Home Energy Scoring Tool API. Some of the new features in this release include: 2 types of foundations and roofs; modeling 2 HVAC systems; modeling wood heating; and additional assembly codes.
November 26, 2014 - The submit_hpxml_inputs method allowing submission of HPXML to the Home Energy Score is available on Sandbox for user testing.
May 18, 2014 - New polling options added to calculation methods and new polling methods added: calculate_base_building_poll and caluclate_package_building_poll
December 20, 2013 - Release of version 2014 of the Home Energy Scoring Tool API.
November 21, 2013 - The calculate XSD has been revised, combining the previously separate XSD's for calculate_base_building and calculate_package_building. This does not change the methods to be called and existing code should still work; the intent of this change is to eliminate redundancy and complication in the XSD.
October 25, 2013 - The API documentation is feature-complete. The API submit structure and returns are frozen until the new API is released into the Home Energy Score Program. Live calculated energy results are being served for both the base and upgraded building runs. Two new methods have been added to the documentation: retrieve_recommendations() and validate_inputs().
May 29, 2013 Q&A Webinar - During an informational webinar for Scoring Tool API Licensees, LBNL and DOE staff provided an overview of the Program and API in the new version of the Scoring Tool roll out. The meeting Video is posted here (We apologize for technical difficulties cutting off the beginning.) The slide deck is posted here.