API Access

A software provider interested in including the Home Energy Score as part of the report output provided by their software may use the Application Programming Interface (API) provided by PNNL. Full documentation can be found here.

Use

The software provider must supply information to DOE about how the Home Energy Score will be used and by whom (e.g. Is the software being used for a single client or multiple clients?). DOE needs to be able to keep track of who is using what software to maintain/verify continued data compliance.

Access

DOE will provide a user account, API evaluation keys, API documentation and implementation support. DOE will provide test scenarios for verification/certification.

Programming

The software provider will build the API functionality within their tool, including HPXML data submissions.

Testing

When that is complete, the software provider will enter the test scenarios into their tool and provide access to their tool and those runs to DOE staff. DOE staff will verify that what the Home Energy Scoring Tool received through the API was as expected based on the inputs into the 3rd party tool. DOE staff will provide test results to the software provider and work with them to correct errors until the data transfers are as expected.

Certification

When confirmed, DOE will provide the production API key to the 3rd party software provider and qualified assessors may begin using that tool.