Home Energy Scoring‎ > ‎API Definitions‎ > ‎API Methods‎ > ‎2017.2‎ > ‎

retrieve_extended_results

Retrieves a set of values that provide more detailed information about the results of a building's simulation run than are available from retrieve_label_results

Parameters

NameDescriptionTypeRequiredOptions
 session_token Get from the get_session_token methodstringYes 
user_keyAPI key for accessstringYes
 building_id ID of building to retrieve intYes 



Response

ElementDescription
label_numberThe building ID
 building_id The building ID (identical to label_number, both are included for historical reasons)
 weather_station_location The location of the weather station associated with the home
 create_label_date The date on which the label was generated, in YYYY-MM-DD format (e.g. 2012-12-31)
 cooling_present 0 or 1, represents whether the home has a cooling system
 source_energy_total_base Base building total source energy use (MBtu)
 source_energy_total_package Package building total source energy use (MBtu)
 source_energy_asset_base Base building asset (heating, cooling, hot water) source energy use (MBtu)
 source_energy_asset_package Package building asset (heating, cooling, hot water) source energy use (MBtu)
 base_cost Utility cost of the base building ($)
 package_cost Utility cost of the package building ($)
 source_eui_base Source energy use intensity of the base building (kBtu/sqft)
 source_eui_package Source energy use intensity of the package building (kBtu/sqft)
 base_score Score of the base building (1-10)
 package_score Score of the package building (1-10)
 site_energy_base Total site energy use of the base building (MBtu)
 site_energy_package Total site energy use of the package building (MBtu)
 site_eui_base Site energy use intensity of the base building (kBtu/sqft)
 site_eui_package Site energy use intensity of the package building (kBtu/sqft)
 carbon_base Carbon emissions of the base building (lb. CO2)
 carbon_package Carbon emissions of the package building (lb. CO2)
 utility_electric_base Electricity use for the base building (kWh)
 utility_natural_gas_base Natural gas use for the base building (therms)
 utility_fuel_oil_base Fuel oil use for the base building (gallons)
 utility_lpg_base LPG use for the base building (gallons)
 utility_cord_wood_base Cord wood use for the base building (cords)
 utility_pellet_wood_base Pellet wood use for the base building (pounds)
 utility_generated_base Electricity generated by the base building (kWh)
 utility_electric_package Electricity use for the package building (kWh)
 utility_natural_gas_package Natural gas use for the package building (therms)
 utility_fuel_oil_package Fuel oil use for the package building (gallons)
 utility_lpg_package LPG use for the package building (gallons)
 utility_cord_wood_packageCord wood use for the package building (cords)
 utility_pellet_wood_package Pellet wood use for the package building (pounds)
 utility_generated_package Electricity generated by the package building (kWh)



Roles

Method access is limited by the roles assigned the user to whom the session token was assigned

RoleAccess
AssessorMay only call for buildings created by the Assessor
PartnerMay only call for buildings created by an Assessor associated with the same Partner
 Admin May call for any building