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
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
Multifamily
API
Methods
The table below contains links to the XSD description of the individual MF API methods.
XSD Documentation
Description
Sample Code
submit()
Takes an array of inputs, creates a new building, runs the energy calculation and returns an array of results by time period, end use and fuel
submit
calculate()
Takes the user key and building_id and runs the energy calculation on an already created building
calculate
retrofit()
Takes the arrays of inputs for one or more retrofit building configurations and runs the energy calculation
retrofit
retrieve_results()
Takes the user key and building_id and returns the calculated energy results for that building
retrieve_results