What are the Web Services for Single Family Homes?

In September 2022, EPA launched a new Score for Single Family Homes in Portfolio Manager. The score model was based on the previous ENERGY STAR Home Energy Yardstick. ENERGY STAR Certification is not be available for existing Single Family Homes.

Web service providers will be able to assess the performance of Single Family Homes in two ways:
  1. As a persistent (saved) property record within Portfolio Manager
    • Uses the existing singleFamilyHome.xsd schema for the creation or editing of this property use and use details.
    • totalGrossFloorArea and numberOfPeople will be used to calculate the score.
      • totalGrossFloorArea is a required use detail.
      • numberOfPeople will be defaulted to “2” if a value is not provided.
    • numberOfBedrooms is optional (not a required value), and will not be assigned a default if no value is entered.
    • Providers and/or building owners will need to review and correct default values as appropriate.
    • All other calls (including GET …/metrics) will continue to function as they do now, with the addition of “score” as a metric that can be returned for this property use.
  2. As a “one-off” assessment
    • A web service (POST /hey) allows the calculation of a 1-100 score for a Single Family Home, without previously creating a property record in Portfolio Manager.
    • Similar to the “Target Finder Services” available in the API, results from this pathway will not be saved within Portfolio Manager for future reference.
    • This API call requires authentication.
Documentation for the HEY API: https://portfoliomanager.energystar.gov/webservices/home/api/hey.
 

Was this article helpful?