HEAT API background-parameter codebook
Use parameter_name to identify a parameter. Definitions, reference values and units are shown below; the CSV also contains conditions, sources and explanatory notes. These are model-reference values, not a country-specific assessment input table.
Download the complete CSV codebook · Original service copy
Snapshot checked 14 November 2026: 169 rows. Values are reproduced as provided, without rounding or automatic updating. Match this reference to the API model and your exported template.
Find a field
Use your browser’s Find command (Ctrl+F or Command+F) to search a field or question. Scroll horizontally for long entries. Some repeated rows represent different modes or assessment cases.
| Parameter | Description | Reference value | Unit |
|---|---|---|---|
| ad_rest_starting_point | Default duration for activity "rest" | 960 | minutes/person*day |
| ad_sleep | Activity duration for sleep | 480 | minutes/person*day |
| background_ratio_bike | Air pollution concentration ratio between background and bike | 2 | ratio |
| background_ratio_bikeshare | Air pollution concentration ratio between background and bikeshare | 2 | ratio |
| background_ratio_bus | Air pollution concentration ratio between background and bus | 1.9 | ratio |
| background_ratio_car | Air pollution concentration ratio between background and car | 2.5 | ratio |
| background_ratio_cardriver | Air pollution concentration ratio between background and cardriver | 2.5 | ratio |
| background_ratio_carpassenger | Air pollution concentration ratio between background and carpassenger | 2.5 | ratio |
| background_ratio_ebike | Air pollution concentration ratio between background and ebike | 2 | ratio |
| background_ratio_ebike25 | Air pollution concentration ratio between background and ebike25 | 2 | ratio |
| background_ratio_ebike45 | Air pollution concentration ratio between background and ebike45 | 2 | ratio |
| background_ratio_lightrail | Air pollution concentration ratio between background and lightrail | 1.9 | ratio |
| background_ratio_motorbike | Air pollution concentration ratio between background and motorbike | 2.5 | ratio |
| background_ratio_pt | Air pollution concentration ratio between background and pt | 1.9 | ratio |
| background_ratio_run | Air pollution concentration ratio between background and run | 1.6 | ratio |
| background_ratio_train | Air pollution concentration ratio between background and train | 1.9 | ratio |
| background_ratio_walk | Air pollution concentration ratio between background and walk | 1.6 | ratio |
| builduptime_crash | Time needed to obtain full health impacts in crash module | 0 | years |
| builduptime_onecase | Time needed to obtain full health impacts in single case assessment | 0 | years |
| builduptime_twocases | Time needed to obtain full health impacts in two cases assessment | 5 | years |
| cap_bike | Maximum benefits cap (mortality risk reduction) from bike | 45 | % |
| cap_bikeshare | Maximum benefits cap (mortality risk reduction) from bikeshare | 45 | % |
| cap_ebike | Maximum benefits cap (mortality risk reduction) from ebike | 45 | % |
| cap_ebike25 | Maximum benefits cap (mortality risk reduction) from ebike25 | 45 | % |
| cap_ebike45 | Maximum benefits cap (mortality risk reduction) from ebike45 | 45 | % |
| cap_max_pm25_conc | Max. concentration (cap) of air pollution (PM2.5) reflected in risk calculation | 100 | ug/m3 |
| cap_run | Maximum benefits cap (mortality risk reduction) from run | 30 | % |
| cap_walk | Maximum benefits cap (mortality risk reduction) from walk | 30 | % |
| carbon_background_data_year | For which year data from carbon_background_data should be used | 2015 | YYYY |
| cold_trip_dist | Daily distance covered with cold start of vehicles (value for {{country}} in {{year}}) | -1 | km/person*day |
| ef_bus_pkm | Carbon emission factor (per vehicle-km) for bus | -1 | gCO2e/vkm |
| ef_car_rw_pkm | Carbon emission factor for car, per passenger-km | -1 | gCO2e/vkm |
| ef_moto_pkm | Carbon emission factor (per vehicle-km) for moto | -1 | gCO2e/vkm |
| ef_vlca_bike | VLCA carbon emmission factor for bike | -1 | gCO2e/vkm |
| ef_vlca_bikeshare | VLCA carbon emmission factor for bikeshare | -1 | gCO2e/vkm |
| ef_vlca_bus | VLCA carbon emmission factor for bus | -1 | gCO2e/vkm |
| ef_vlca_car | VLCA carbon emmission factor for car | -1 | gCO2e/vkm |
| ef_vlca_cardriver | VLCA carbon emmission factor for cardriver | -1 | gCO2e/vkm |
| ef_vlca_carpassenger | VLCA carbon emmission factor for carpassenger | -1 | gCO2e/vkm |
| ef_vlca_ebike | VLCA carbon emmission factor for ebike | -1 | gCO2e/vkm |
| ef_vlca_ebike25 | VLCA carbon emmission factor for ebike25 | -1 | gCO2e/vkm |
| ef_vlca_ebike45 | VLCA carbon emmission factor for ebike45 | -1 | gCO2e/vkm |
| ef_vlca_lightrail | VLCA carbon emmission factor for lightrail | -1 | gCO2e/vkm |
| ef_vlca_moto | VLCA carbon emmission factor for moto | -1 | NA |
| ef_vlca_motorbike | VLCA carbon emmission factor for motorbike | -1 | gCO2e/vkm |
| ef_vlca_pt | VLCA carbon emmission factor for pt | -1 | gCO2e/vkm |
| ef_vlca_rail | VLCA carbon emmission factor for rail | -1 | NA |
| ef_vlca_run | VLCA carbon emmission factor for run | -1 | gCO2e/vkm |
| ef_vlca_train | VLCA carbon emmission factor for train | -1 | gCO2e/vkm |
| ef_vlca_walk | VLCA carbon emmission factor for walk | -1 | gCO2e/vkm |
| ef_wtt_bike | Well-to-tank carbon emission factor for bike | -1 | gCO2e/vkm |
| ef_wtt_bikeshare | Well-to-tank carbon emission factor for bikeshare | -1 | gCO2e/vkm |
| ef_wtt_bus | Well-to-tank carbon emission factor for bus | -1 | gCO2e/vkm |
| ef_wtt_car | Well-to-tank carbon emission factor for car | -1 | gCO2e/vkm |
| ef_wtt_cardriver | Well-to-tank carbon emission factor for cardriver | -1 | gCO2e/vkm |
| ef_wtt_carpassenger | Well-to-tank carbon emission factor for carpassenger | -1 | gCO2e/vkm |
| ef_wtt_ebike | Well-to-tank carbon emission factor for ebike | -1 | gCO2e/vkm |
| ef_wtt_ebike25 | Well-to-tank carbon emission factor for ebike25 | -1 | gCO2e/vkm |
| ef_wtt_ebike45 | Well-to-tank carbon emission factor for ebike45 | -1 | gCO2e/vkm |
| ef_wtt_lightrail | Well-to-tank carbon emission factor for lightrail | -1 | gCO2e/vkm |
| ef_wtt_moto | Well-to-tank carbon emission factor for moto | -1 | NA |
| ef_wtt_motorbike | Well-to-tank carbon emission factor for motorbike | -1 | gCO2e/vkm |
| ef_wtt_pt | Well-to-tank carbon emission factor for pt | -1 | gCO2e/vkm |
| ef_wtt_rail | Well-to-tank carbon emission factor for rail | -1 | NA |
| ef_wtt_run | Well-to-tank carbon emission factor for run | -1 | gCO2e/vkm |
| ef_wtt_train | Well-to-tank carbon emission factor for train | -1 | gCO2e/vkm |
| ef_wtt_walk | Well-to-tank carbon emission factor for walk | -1 | gCO2e/vkm |
| max_hrs_bike | Maximum hours input allowed for bike | 2 | hrs |
| max_hrs_bikeshare | Maximum hours input allowed for bikeshare | 2 | hrs |
| max_hrs_ebike | Maximum hours input allowed for ebike | 2 | hrs |
| max_hrs_ebike25 | Maximum hours input allowed for ebike25 | 2 | hrs |
| max_hrs_ebike45 | Maximum hours input allowed for ebike45 | 2 | hrs |
| max_hrs_run | Maximum hours input allowed for run | 2 | hrs |
| max_hrs_walk | Maximum hours input allowed for walk | 2 | hrs |
| max_km_bike | Maximum km input allowed for bike | 20 | km |
| max_km_bikeshare | Maximum km input allowed for bikeshare | 20 | km |
| max_km_ebike | Maximum km input allowed for ebike | 30 | km |
| max_km_ebike25 | Maximum km input allowed for ebike25 | 30 | km |
| max_km_ebike45 | Maximum km input allowed for ebike45 | 50 | km |
| max_km_run | Maximum km input allowed for run | 20 | km |
| max_km_walk | Maximum km input allowed for walk | 12 | km |
| max_min_bike | Maximum minutes input allowed for bike | 60 | min |
| max_min_bikeshare | Maximum minutes input allowed for bikeshare | 60 | min |
| max_min_ebike | Maximum minutes input allowed for ebike | 120 | min |
| max_min_ebike25 | Maximum minutes input allowed for ebike25 | 120 | |
| max_min_ebike45 | Maximum minutes input allowed for ebike45 | 120 | |
| max_min_run | Maximum minutes input allowed for run | 120 | min |
| max_min_walk | Maximum minutes input allowed for walk | 120 | min |
| mets_bike | Physical intensity (Metabolic Equivalents of Task (METs) of ) bike | 6.8 | kcal/kg*h |
| mets_bikeshare | Physical intensity (Metabolic Equivalents of Task (METs) of ) bikeshare | 6.8 | kcal/kg*h |
| mets_bus | Physical intensity (Metabolic Equivalents of Task (METs) of ) bus | 1.9 | kcal/kg*h |
| mets_car | Physical intensity (Metabolic Equivalents of Task (METs) of ) car | 2.1 | kcal/kg*h |
| mets_cardriver | Physical intensity (Metabolic Equivalents of Task (METs) of ) cardriver | 2.5 | kcal/kg*h |
| mets_carpassenger | Physical intensity (Metabolic Equivalents of Task (METs) of ) carpassenger | 1.3 | kcal/kg*h |
| mets_ebike | Physical intensity (Metabolic Equivalents of Task (METs) of ) ebike | 5.5 | kcal/kg*h |
| mets_ebike25 | Physical intensity (Metabolic Equivalents of Task (METs) of ) ebike25 | 6 | kcal/kg*h |
| mets_ebike45 | Physical intensity (Metabolic Equivalents of Task (METs) of ) ebike45 | 5 | kcal/kg*h |
| mets_lightrail | Physical intensity (Metabolic Equivalents of Task (METs) of ) lightrail | 1.3 | kcal/kg*h |
| mets_motorbike | Physical intensity (Metabolic Equivalents of Task (METs) of ) motorbike | 1.3 | kcal/kg*h |
| mets_pt | Physical intensity (Metabolic Equivalents of Task (METs) of ) pt | 1.3 | kcal/kg*h |
| mets_run | Physical intensity (Metabolic Equivalents of Task (METs) of ) run | 7 | kcal/kg*h |
| mets_train | Physical intensity (Metabolic Equivalents of Task (METs) of ) train | 1.3 | kcal/kg*h |
| mets_walk | Physical intensity (Metabolic Equivalents of Task (METs) of ) walk | 4 | kcal/kg*h |
| mile | Distance conversion from mile to kilometer | 1.61 | mile |
| mvent_bike | Minute ventilation rate (l/min) of bike | 42.5 | l/min |
| mvent_bikeshare | Minute ventilation rate (l/min) of bikeshare | 42.5 | l/min |
| mvent_bus | Minute ventilation rate (l/min) of bus | 10.2 | l/min |
| mvent_car | Minute ventilation rate (l/min) of car | 10.2 | l/min |
| mvent_cardriver | Minute ventilation rate (l/min) of cardriver | 10.2 | l/min |
| mvent_carpassenger | Minute ventilation rate (l/min) of carpassenger | 10.2 | l/min |
| mvent_ebike | Minute ventilation rate (l/min) of ebike | 34.4 | l/min |
| mvent_ebike25 | Minute ventilation rate (l/min) of ebike25 | 37.5 | l/min |
| mvent_ebike45 | Minute ventilation rate (l/min) of ebike45 | 31.3 | l/min |
| mvent_lightrail | Minute ventilation rate (l/min) of lightrail | 10.2 | l/min |
| mvent_motorbike | Minute ventilation rate (l/min) of motorbike | 10.2 | l/min |
| mvent_pt | Minute ventilation rate (l/min) of pt | 10.2 | l/min |
| mvent_rest | Minute ventilation rate (l/min) of rest | 10.2 | l/min |
| mvent_run | Minute ventilation rate (l/min) of run | 43.8 | l/min |
| mvent_sleep | Minute ventilation rate (l/min) of sleep | 4.5 | l/min |
| mvent_train | Minute ventilation rate (l/min) of train | 10.2 | l/min |
| mvent_walk | Minute ventilation rate (l/min) of walk | 22.8 | l/min |
| occupancy_rate_car | Average occupancy rate for cars all purposes | -1 | persons |
| proportion_exposed | Proportion of the exposed population | 0.001 | proportion |
| pt_bus_rail_split | Share of bus trips compared to rail trips | 0.5 | proportion |
| ratiocoldhot | Proportion of cold vs. hot start (value for {{country}} in {{year}}) | -1 | ratio |
| ref_concentration_PM2.5 | Reference concentration (PM2.5) for the RR of air pollution and mortality | 10 | ug/m3 |
| ref_duration_bike | Reference duration for for relative risk for mortality and bike | 100 | minutes/person*week |
| ref_duration_bikeshare | Reference duration for for relative risk for mortality and bikeshare | 100 | minutes/person*week |
| ref_duration_ebike | Reference duration for for relative risk for mortality and ebike | 124 | minutes/person*week |
| ref_duration_ebike25 | Reference duration for for relative risk for mortality and ebike25 | 113 | minutes/person*week |
| ref_duration_ebike45 | Reference duration for for relative risk for mortality and ebike45 | 136 | minutes/person*week |
| ref_duration_run | Reference duration for for relative risk for mortality and run | 100 | minutes/person*week |
| ref_duration_walk | Reference duration for for relative risk for mortality and walk | 168 | minutes/person*week |
| RR_bike | Relative risk for mortality and bike | 0.903 | ratio |
| RR_bike_corrected_ap | Relative risk for mortality and bike (physical activity only, excluding air pollution effect) | 0.899 | ratio |
| RR_bikeshare | Relative risk for mortality and bikeshare | 0.903 | ratio |
| RR_bikeshare_corrected_ap | Relative risk for mortality and bikeshare (physical activity only, excluding air pollution effect) | 0.899 | ratio |
| RR_ebike | Relative risk for mortality and ebike | 0.903 | ratio |
| RR_ebike_corrected_ap | Relative risk for mortality and ebike (physical activity only, excluding air pollution effect) | 0.899 | ratio |
| RR_ebike25 | Relative risk for mortality and ebike25 | 0.903 | ratio |
| RR_ebike25_corrected_ap | Relative risk for mortality and ebike25 (physical activity only, excluding air pollution effect) | 0.899 | ratio |
| RR_ebike45 | Relative risk for mortality and ebike45 | 0.903 | ratio |
| RR_ebike45_corrected_ap | Relative risk for mortality and ebike45 (physical activity only, excluding air pollution effect) | 0.899 | ratio |
| RR_PM2.5 | Relative risk of air pollution (PM2.5) and mortality | 1.08 | ratio |
| RR_run | Relative risk for mortality and run | 0.903 | ratio |
| RR_run_corrected_ap | Relative risk for mortality and run (physical activity only, excluding air pollution effect) | 0.899 | ratio |
| RR_walk | Relative risk for mortality and walk | 0.886 | ratio |
| RR_walk_corrected_ap | Relative risk for mortality and walk (physical activity only, excluding air pollution effect) | 0.883 | ratio |
| speed_bike | Average cycling speed | 14 | km/h |
| speed_bikeshare | Average bikeshare speed | 12.4 | km/h |
| speed_bus | Average bus speed | 15.4 | km/h |
| speed_car | Average car speed | 42 | km/h |
| speed_cardriver | Average speed as car driver | 42 | km/h |
| speed_carpassenger | Average speed as car passenger | 42 | km/h |
| speed_ebike | Average e-bike speed | 17 | km/h |
| speed_ebike25 | Average ebike25 speed (km/h) | 16 | km/h |
| speed_ebike45 | Average ebike45 speed (km/h) | 20 | km/h |
| speed_lightrail | Average light rail speed | 16.1 | km/h |
| speed_motorbike | Average motorbike speed | 29.8 | km/h |
| speed_pt | Average public transport speed | 22.7 | km/h |
| speed_road_0 | Average road traffic speed for global average standards in urban areas for {{mode}} | 32 | km/h |
| speed_road_1 | Average road traffic speed for nearly free flow at all times in urban areas for {{mode}} | 45 | km/h |
| speed_road_2 | Average road traffic speed for minor congestion mainly at peak times in urban areas for {{mode}} | 35 | km/h |
| speed_road_3 | Average road traffic speed for heavy congestion throughout the day in urban areas for {{mode}} | 20 | km/h |
| speed_road_4 | Average road traffic speed for global average standards in rural areas for {{mode}} | 60 | km/h |
| speed_run | Average running speed | 13.3 | km/h |
| speed_train | Average train speed | 37.4 | km/h |
| speed_walk | Average walking speed | 5.3 | km/h |
| steplength | Average length of walking steps | 72 | cm |