Multifamily API Methods

The table below contains links to the XSD description of the individual MF API methods. 

XSD DocumentationDescriptionSample 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 fuelsubmit
calculate()Takes the user key and building_id and runs the energy calculation on an already created buildingcalculate
retrofit()Takes the arrays of inputs for one or more retrofit building configurations and runs the energy calculationretrofit
retrieve_results()Takes the user key and building_id and returns the calculated energy results for that buildingretrieve_results