Search this site
Home
HOME ENERGY SAVER
SCORING TOOL
MULTIFAMILY
PROJECT GALLERY
Technical Notes
Navigation
HOME ENERGY SAVER
Our Service
API Documentation
SCORING TOOL
ENERGYIQ
API Documentation
API Known Issues
MULTIFAMILY
API Documentation
MF API Definitions
MF API Methods
EIQ FAQs
EIQ Infrastructure
EIQ Licensing
EIQ Security
EIQ Service
EIQ Support
EIQ Technical Notes
Sample Client Code
Licensing
Technical Notes
API Signup
Support
Support
Support
Home Energy Saver - Professional Tool
Weatherization Assistant MulTEA - ORNL
Allstate Goodhome
Cool California
iViro for iPhone
My Home EQ
My Florida Home Energy
Microsoft Hohm
Home Energy Saver - API Clients
Scoring Tool - API Clients
EnergySavvy
Energy Soft - Energy Pro
CakeSystems
Optimiser LLC
miScore Mobile App
EnergyIQ
Mobile EnergyIQ App
CBES - Commercial Building Energy Saver
Our Infrastructure
Support
Security
FAQs
Home Energy Scoring Tool
EnergyIQ - no longer operational
Sitemap
Home
>
MULTIFAMILY
>
API Documentation
>
MF API Methods
>
4. Retrieve Method
Multifamily
API Documentation
MF API Definitions
MF API Methods
1. Submit Method
API Object Model - Multifamily
Building
Building Configuration
Domestic Hot Water
DHW Water Heater
DHW Distribution
DHW Pipe
DHW Property
Space
Appliance
Appliance Unit
Appliance Property
Lighting
Lighting Fixture
Space Occupancy
Water Fixture
Zone
HVAC
HVAC Control
HVAC Distribution
HVAC Equipment
HVAC Property
Zone Floor
Zone Roof
Zone Wall
Zone Door
Zone Window
Zone Attached Shade
Glazing Construction
Opaque Construction
Opaque Construction Layer
Pump
Schedule
Schedule Week
Schedule Day
Schedule Value
2. Calculate Method
3. Retrofit Method
4. Retrieve Method
5. Nearest Weather Method
Licensing
Sign Up
Multifamily API (engineering site)
Support
4. Retrieve Method
retrieve_results()
Returns the results for a Multifamily API session
XSD:
http://hesapi.lbl.gov/mf_api/xsd/retrieve_results
XSD documentation:
http://documentation.hescloud.net/api/mf/xsd/hes-mf_xsd-retrieve_results_prd.htm
Parameters:
Name
Description
Type
Possible Values
building_id
ID number for the Building session to be retrieved
string
upgrade_category
which building_config to get results for
string
base, package, upgrade
period_type
Time period for desired results (optional, leave out for all period types)
string
year, month, day, or week
period_number
1 for year, otherwise the number of the week, day, or month to retrieve (optional, leave out for all periods)
int
resource_type
resource to report results on (optional, leave out for all resource types)
string
electric, natural_gas, fuel_oil, lpg, hot_water
end_use
End use to report results for (optional, leave out for all end uses)
string
total, heating, cooling, large appliance, small_appliance, lighting, hot_water, circulation