Multi-Family‎ > ‎Multi Family API‎ > ‎

4. Retrieve Method

retrieve_results()


Returns the results for a Multifamily API session

 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