retrieve_extended_results

Returns more detailed results of the building calculation.

Parameters

NameDescriptionTypeLengthRequiredOptions
user_keyAPI key for accessstring32Yes
building_idID of building to validateint
Yes

Response

ElementDescription
label_numberLabel number
building_idBuilding ID
weather_station_locationLocation of the weather data used for the calculation
create_label_dateDate the label was created
cooling_presentDoes the building have air conditioning (1=Yes, 0=No)
source_energy_total_baseBase building total source energy use (MBtu)
source_energy_total_packagePackage building total source energy use (MBtu)
source_energy_asset_baseBase building asset (heating, cooling, hot water) source energy use (MBtu)
source_energy_asset_packagePackage building asset (heating, cooling, hot water) source energy use (MBtu)
base_costUtility cost of the base building ($)
package_costUtility cost of the package building ($)
source_eui_baseSource energy use intensity of the base building (kBtu/sqft)
source_eui_packageSource energy use intensity of the package building (kBtu/sqft)
base_scoreScore of the base building (1-10)
package_scoreScore of the package building (1-10)
site_energy_baseTotal site energy use of the base building (MBtu)
site_energy_packageTotal site energy use of the package building (MBtu)
site_eui_baseSite energy use intensity of the base building (kBtu/sqft)
site_eui_packageSite energy use intensity of the package building (kBtu/sqft)
carbon_baseCarbon emissions of the base building (lb CO2)
carbon_packageCarbon emissions of the package building (lb CO2)
utility_electric_baseElectricity use for the base building (kWh)
utility_natural_gas_baseNatural gas use for the base building (therms)
utility_fuel_oil_baseFuel oil use for the base building (gallons)
utility_lpg_baseLPG use for the base building (gallons)
utility_cord_wood_baseCord wood use for the base building (cords)
utility_pellet_wood_basePellet wood use for the base building (pounds)
utility_generated_baseElectricity generated by the base building (kWh)
utility_electric_packageElectricity use for the package building (kWh)
utility_natural_gas_packageNatural gas use for the package building (therms)
utility_fuel_oil_packageFuel oil use for the package building (gallons)
utility_lpg_packageLPG use for the package building (gallons)
utility_cord_wood_packageCord wood use for the package building (cords)
utility_pellet_wood_packagePellet wood use for the package building (pounds)
utility_generated_packageElectricity generated by the package building (kWh)
Notes
  • All of the package elements will be Null if the package building has not been calculated (using the calculate_package_building method):
  • Utility energy elements will be 0 if that fuel was not used in the building


Errors

Error TextMeaning
 API key is not authorized You need to submit a valid API key
 No building found for building_id ##### You need to submit a valid building_id
 Label results not found for building_id #### The building results have not been calculated or committed