Asset Data
The asset data resource returns a list of reporting years and the corresponding annual data associated with that asset.
URL
Base URL
https://api.scalerglobal.com/v1/portfolios/{porfolio_id}/assets/{asset_id}/data
Pagination
Enabled. For more information, see pagination.
Query Parameters
| Parameter | Description |
|---|---|
| type | Choose which set of fields should be included. Please find the different types below. Defaults to raw if not provided. |
| years | The reporting years for which data should be returned. Provide a single year (e.g. years=2021) or the first and last year (e.g. years=2021-2024) of the range to be returned. Defaults to the current year if not provided. |
Types
| Type | Description |
|---|---|
| raw | All data, excluding calculated values (default). |
| compact | Commonly used variables like calculations relating to energy consumption, GHG emissions, water consumption and CRREM stranding year. |
| general | Additional asset details, more granular consumption details relating to floor area type, like-for-like calculations and data quality scoring. |
| extended | All data and calculated values. |
Example Request
https://api.scalerglobal.com/v1/portfolios/12345/assets/6789/data?type=raw&years=2020-2022&page=1&per_page=10
Response
{
"success": true,
"message": "Success",
"data": {
"data": [
{
"id": 6789,
"reporting_year": 2020,
"gross_floor_area_sqm": 23454,
"gross_asset_value_mln": 12.34,
...
},
{
"id": 6789,
"reporting_year": 2021,
"gross_floor_area_sqm": 23454,
"gross_asset_value_mln": 12.53,
...
},
{
"id": 6789,
"reporting_year": 2022,
"gross_floor_area_sqm": 23950,
"gross_asset_value_mln": 12.92,
...
},
...
],
"current_page": 1,
"from": 1,
"last_page": 2,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://api.scalerglobal.com/v1/portfolios/12345/assets/6789/data?page=1&per_page=10",
"label": "1",
"active": true
},
{
"url": "https://api.scalerglobal.com/v1/portfolios/12345/assets/6789/data?page=2&per_page=10",
"label": "2",
"active": false
},
{
"url": "https://api.scalerglobal.com/v1/portfolios/12345/assets/6789/data?page=2&per_page=10",
"label": "Next »",
"active": false
}
],
"path": "https://api.scalerglobal.com/v1/portfolios/12345/assets/6789/data",
"per_page": 1,
"to": 10,
"total": 20
}
}Data Fields
The following fields are returned for each reporting year.
Note:
The non-raw types (compact, general, extended) return output data.
For output data to be available, the corresponding asset must have a 100% Scaler data completion.
The asset should not have any open errors or missing data warnings.
In such cases, only the raw type will return data.
Choose the type of the data fields you want returned:
| Field | Type |
|---|---|
| id | integer |
| asset_id | integer |
| reporting_year | integer |
| gross_floor_area_sqm | float |
| gross_asset_value_mln | float |
| average_vacancy_rate_perc | float |
| status | integer |
| gresb_asset_score | float |
| gresb_energy_score | float |
| gresb_emissions_score | float |
| gresb_water_score | float |
| gresb_waste_score | float |
| gresb_building_certifications_score | float |
| gresb_tenant_engagement_score | float |
| gresb_risk_assessments_score | float |
| energy_intensity_kwhsqm | float |
| energy_consumption_kwh | float |
| energy_fuels_consumption_kwh | float |
| energy_dhc_consumption_kwh | float |
| energy_electricity_consumption_kwh | float |
| energy_data_coverage_perc | float |
| energy_consumption_lfl_change_perc | float |
| energy_off_site_renewable_electricity_consumption_kwh | float |
| energy_on_site_renewable_electricity_consumption_kwh | float |
| energy_fuels_data_coverage_perc | float |
| energy_dhc_data_coverage_perc | float |
| energy_electricity_data_coverage_perc | float |
| energy_electricity_whole_building_and_ss_data_coverage_perc | float |
| energy_dhc_whole_building_and_ss_data_coverage_perc | float |
| energy_fuels_whole_building_and_ss_data_coverage_perc | float |
| energy_electricity_tenant_space_data_coverage_perc | float |
| energy_dhc_tenant_space_data_coverage_perc | float |
| energy_fuels_tenant_space_data_coverage_perc | float |
| energy_electricity_common_area_data_coverage_perc | float |
| energy_dhc_common_area_data_coverage_perc | float |
| energy_fuels_common_area_data_coverage_perc | float |
| energy_ghg_intensity_kgco2esqm | float |
| energy_ghg_lfl_change_perc | float |
| energy_ghg_offset_kgco2e | float |
| water_intensity_m3sqm | float |
| water_consumption_m3 | float |
| water_data_coverage_perc | float |
| water_consumption_lfl_change_perc | float |
| water_reclaimed_intensity_m3sqm | float |
| waste_intensity_tonnessqm | float |
| waste_consumption_tonnes | float |
| waste_data_coverage_perc | float |
| waste_diverted_consumption_tonnes | float |
| breeam_new_construction_score | float |
| breeam_in_use_score | float |
| energy_label_eu_epc_score | float |
| breeam_new_construction_covered_area_sqm | float |
| breeam_in_use_covered_area_sqm | float |
| energy_label_eu_epc_covered_area_sqm | float |
| green_lease_bool | boolean |
| tenant_satisfaction_survey_bool | boolean |
| building_asset_communication_bool | boolean |
| feedback_sessions_with_individual_tenants_bool | boolean |
| provide_tenants_with_feedback_bool | boolean |
| social_media_platform_bool | boolean |
| tenant_engagement_meetings_bool | boolean |
| tenant_esg_guide_bool | boolean |
| tenant_esg_training_bool | boolean |
| tenant_events_focused_on_increasing_esg_awareness_bool | boolean |
| tenant_engagement_program_other_bool | boolean |
| fit_out_and_refurbishment_assistance_bool | boolean |
| tenant_fit_out_guides_bool | boolean |
| minimum_fit_out_standards_are_prescribed_bool | boolean |
| procurement_assistance_for_tenants_bool | boolean |
| fit_out_and_refurbishment_program_other_bool | boolean |
| biodiversity_and_habitat_bool | boolean |
| building_safety_and_materials_bool | boolean |
| climate_change_adaptation_bool | boolean |
| contaminated_land_bool | boolean |
| energy_efficiency_bool | boolean |
| energy_supply_bool | boolean |
| flooding_bool | boolean |
| ghg_emissions_bool | boolean |
| health_and_well_being_bool | boolean |
| indoor_environmental_quality_bool | boolean |
| natural_hazards_bool | boolean |
| regulatory_bool | boolean |
| resilience_bool | boolean |
| socio_economic_bool | boolean |
| transportation_bool | boolean |
| waste_management_risk_bool | boolean |
| water_efficiency_bool | boolean |
| water_supply_bool | boolean |
| risk_assessments_other_bool | boolean |
| technical_energy_assessment_bool | boolean |
| technical_water_assessment_bool | boolean |
| technical_waste_assessment_bool | boolean |
| automatic_energy_meter_readings_bool | boolean |
| automation_system_upgrades_replacements_bool | boolean |
| management_systems_upgrades_replacements_bool | boolean |
| installation_of_high_efficiency_equipment_and_appliances_bool | boolean |
| installation_of_on_site_renewable_energy_bool | boolean |
| occupier_engagement_informational_technologies_bool | boolean |
| smart_grid_smart_building_technologies_bool | boolean |
| systems_commissioning_or_retro_commissioning_bool | boolean |
| wall_roof_insulation_bool | boolean |
| window_replacements_bool | boolean |
| automatic_water_meter_readings_bool | boolean |
| cooling_tower_bool | boolean |
| drip_smart_irrigation_bool | boolean |
| drought_tolerant_native_landscaping_bool | boolean |
| high_efficiency_dry_fixtures_bool | boolean |
| leak_detection_system_bool | boolean |
| metering_of_water_subsystems_bool | boolean |
| on_site_waste_water_treatment_bool | boolean |
| reuse_of_storm_water_and_or_grey_water_bool | boolean |
| composting_landscape_and_or_food_waste_bool | boolean |
| ongoing_waste_performance_monitoring_bool | boolean |
| recycling_bool | boolean |
| waste_management_bool | boolean |
| waste_stream_audit_bool | boolean |
| roadmap_net_zero_score | float |
| scaler_asset_score | float |
| scaler_energy_score | float |
| scaler_emissions_score | float |
| scaler_water_score | float |
| scaler_waste_score | float |
| scaler_building_certifications_score | float |
| scaler_tenant_engagement_score | float |
| scaler_risk_assessments_score | float |
| stranded_1_5_degrees_energy_year | integer |
| stranded_2_degrees_energy_year | integer |
| stranded_1_5_degrees_carbon_year | integer |
| stranded_2_degrees_carbon_year | integer |
| net_zero_1_5_degrees_energy_score | float |
| net_zero_1_5_degrees_carbon_score | float |
| net_zero_2_degrees_energy_score | float |
| net_zero_2_degrees_carbon_score | float |
| green_lease_active_bool | boolean |
| dhc_bool | boolean |
| gross_floor_area_common_areas_sqm | float |
| gross_floor_area_tenant_areas_sqm | float |
| waste_intensity_kgsqm | float |
| energy_active_area_sqm | float |
| energy_electricity_active_area_sqm | float |
| energy_fuels_active_area_sqm | float |
| energy_dhc_active_area_sqm | float |
| water_active_area_sqm | float |
| waste_active_area_sqm | float |
| default_unit_system | string |
| design_or_construction_bool | boolean |
| energy_rating_bool | boolean |
| operational_bool | boolean |
| energy_data_quality_score | float |
| water_data_quality_score | float |
| waste_data_quality_score | float |
| energy_ghg_intensity_location_based_kgco2esqm | float |
| energy_scope_1_ghg_location_based_kgco2e | float |
| energy_scope_2_ghg_location_based_kgco2e | float |
| energy_scope_3_ghg_location_based_kgco2e | float |
| energy_ghg_location_based_lfl_change_perc | float |
| energy_ghg_location_based_offset_kgco2e | float |
| energy_ghg_intensity_market_based_kgco2esqm | float |
| energy_scope_1_ghg_market_based_kgco2e | float |
| energy_scope_2_ghg_market_based_kgco2e | float |
| energy_scope_3_ghg_market_based_kgco2e | float |
| energy_ghg_market_based_lfl_change_perc | float |
| energy_ghg_market_based_offset_kgco2e | float |
| energy_dhc_potential_active_area_sqm | float |
| energy_electricity_potential_active_area_sqm | float |
| energy_fuels_potential_active_area_sqm | float |
| energy_potential_active_area_sqm | float |
| waste_potential_active_area_sqm | float |
| water_potential_active_area_sqm | float |
| energy_fuels_common_area_active_area_sqm | float |
| energy_dhc_common_area_active_area_sqm | float |
| energy_electricity_common_area_active_area_sqm | float |
| energy_ng_tenant_space_tenant_controlled_active_area_sqm | float |
| energy_dhc_tenant_space_tenant_controlled_active_area_sqm | float |
| energy_elec_tenant_space_tenant_controlled_active_area_sqm | float |
| energy_fuels_whole_building_active_area_sqm | float |
| energy_dhc_whole_building_active_area_sqm | float |
| energy_electricity_whole_building_active_area_sqm | float |
| energy_fuels_common_area_potential_active_area_sqm | float |
| energy_dhc_common_area_potential_active_area_sqm | float |
| energy_electricity_common_area_potential_active_area_sqm | float |
| energy_ng_tenant_space_tenant_controlled_pot_act_area_sqm | float |
| energy_dhc_tenant_space_tenant_controlled_pot_act_area_sqm | float |
| energy_elec_tenant_space_tenant_controlled_pot_act_area_sqm | float |
| energy_fuels_whole_building_potential_active_area_sqm | float |
| energy_dhc_whole_building_potential_active_area_sqm | float |
| energy_electricity_whole_building_potential_active_area_sqm | float |
| waste_recycling_consumption_tonnes | float |
| waste_reuse_consumption_tonnes | float |
| waste_incineration_consumption_tonnes | float |
| waste_landfill_consumption_tonnes | float |
| waste_waste_to_energy_consumption_tonnes | float |
| waste_other_consumption_tonnes | float |
| energy_electricity_ghg_intensity_location_based_kgco2esqm | float |
| energy_dhc_ghg_intensity_location_based_kgco2esqm | float |
| energy_fuels_ghg_intensity_location_based_kgco2esqm | float |
| energy_fuels_tenant_space_potential_active_area_sqm | float |
| energy_dhc_tenant_space_potential_active_area_sqm | float |
| energy_electricity_tenant_space_potential_active_area_sqm | float |
| energy_fuels_whole_building_and_ss_pot_act_area_sqm | float |
| energy_dhc_whole_building_and_ss_potential_active_area_sqm | float |
| energy_electricity_whole_building_and_ss_pot_act_area_sqm | float |
| dgbc_net_zero_1_5_degrees_energy_score | float |
| dgbc_net_zero_1_5_degrees_carbon_score | float |
| energy_data_coverage_time_perc | float |
| water_data_coverage_time_perc | float |
| waste_data_coverage_time_perc | float |
| energy_data_coverage_area_perc | float |
| water_data_coverage_area_perc | float |
| waste_data_coverage_area_perc | float |
| eu_tax_score_substantial_contribution_ccm | float |
| eu_tax_score_substantial_contribution_cca | float |
| eu_tax_score_dnsh_cca | float |
| eu_tax_score_dnsh_ccm | float |
| eu_tax_score_min_safeguards | float |
| eu_tax_score_ccm | float |
| eu_tax_score_cca | float |
| eu_tax_score_total_aligned | float |
| owned_for_entire_interval_period_bool | boolean |
| energy_ghg_kgco2e | float |
| water_potable_consumption_m3 | float |
| water_reclaimed_consumption_m3 | float |
| energy_co2_intensity_location_based_kgco2sqm | float |
| energy_electricity_co2_intensity_location_based_kgco2sqm | float |
| energy_dhc_co2_intensity_location_based_kgco2sqm | float |
| energy_fuels_co2_intensity_location_based_kgco2sqm | float |
| energy_dhc_ghg_location_based_kgco2e | float |
| energy_electricity_ghg_location_based_kgco2e | float |
| energy_fuels_ghg_location_based_kgco2e | float |
| f_gas_ghg_location_based_kgco2e | float |
| energy_fgas_scope_1_ghg_location_based_kgco2e | float |
| energy_fuels_scope_1_ghg_location_based_kgco2e | float |
| energy_dhc_scope_2_ghg_location_based_kgco2e | float |
| energy_electricity_scope_2_ghg_location_based_kgco2e | float |
| energy_dhc_scope_3_ghg_location_based_kgco2e | float |
| energy_electricity_scope_3_ghg_location_based_kgco2e | float |
| energy_fgas_scope_3_ghg_location_based_kgco2e | float |
| energy_fuels_scope_3_ghg_location_based_kgco2e | float |
| stranded_1_5_degrees_ghg_year | integer |
| energy_scaler_active_area_sqm | float |
| energy_scaler_intensity_kwhsqm | float |
| energy_scaler_ghg_intensity_location_based_kgco2esqm | float |
| energy_electricity_sca_ghg_int_loc_bas_kgco2esqm | float |
| energy_dhc_scaler_ghg_intensity_location_based_kgco2esqm | float |
| energy_fuels_scaler_ghg_intensity_location_based_kgco2esqm | float |
| energy_scaler_co2_intensity_location_based_kgco2sqm | float |
| energy_electricity_sca_co2_int_loc_bas_kgco2sqm | float |
| energy_dhc_scaler_co2_intensity_location_based_kgco2sqm | float |
| energy_fuels_scaler_co2_intensity_location_based_kgco2sqm | float |
| energy_gresb_active_area_sqm | float |
| energy_gresb_intensity_kwhsqm | float |
| energy_gresb_ghg_intensity_location_based_kgco2esqm | float |
| energy_electricity_gre_ghg_int_loc_bas_kgco2esqm | float |
| energy_dhc_gresb_ghg_intensity_location_based_kgco2esqm | float |
| energy_fuels_gresb_ghg_intensity_location_based_kgco2esqm | float |
| energy_gresb_co2_intensity_location_based_kgco2sqm | float |
| energy_electricity_gresb_co2_intensity_location_based_kgco2sqm | float |
| energy_dhc_gresb_co2_intensity_location_based_kgco2sqm | float |
| energy_fuels_gresb_co2_intensity_location_based_kgco2sqm | float |
| energy_fuels_consumption_lfl_change_perc | float |
| energy_dhc_consumption_lfl_change_perc | float |
| energy_electricity_consumption_lfl_change_perc | float |
| energy_co2_kgco2 | float |
| hdd_norm_energy_intensity_kwhsqm | float |
| vr_norm_energy_intensity_kwhsqm | float |
| da_norm_energy_intensity_kwhsqm | float |
| vrda_norm_energy_intensity_kwhsqm | float |
| hdd_norm_energy_consumption_kwh | float |
| vr_norm_energy_consumption_kwh | float |
| da_norm_energy_consumption_kwh | float |
| vrda_norm_energy_consumption_kwh | float |
| hdd_norm_energy_dhc_consumption_kwh | float |
| vr_norm_energy_dhc_consumption_kwh | float |
| da_norm_energy_dhc_consumption_kwh | float |
| vrda_norm_energy_dhc_consumption_kwh | float |
| hdd_norm_energy_electricity_consumption_kwh | float |
| energy_dhc_ghg_market_based_kgco2e | float |
| energy_electricity_ghg_market_based_kgco2e | float |
| energy_fuels_ghg_market_based_kgco2e | float |
| energy_fuels_scope_1_ghg_market_based_kgco2e | float |
| energy_fuels_scope_3_ghg_market_based_kgco2e | float |
| energy_fgas_scope_1_ghg_market_based_kgco2e | float |
| energy_fgas_scope_3_ghg_market_based_kgco2e | float |
| energy_dhc_scope_2_ghg_market_based_kgco2e | float |
| energy_dhc_scope_3_ghg_market_based_kgco2e | float |
| energy_electricity_scope_2_ghg_market_based_kgco2e | float |
| energy_electricity_scope_3_ghg_market_based_kgco2e | float |
| energy_co2_intensity_market_based_kgco2sqm | float |
| asset_manager | string |