HEAT guidance / HEAT API

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.

ParameterDescriptionReference valueUnit
ad_rest_starting_pointDefault duration for activity "rest"960minutes/person*day
ad_sleepActivity duration for sleep480minutes/person*day
background_ratio_bikeAir pollution concentration ratio between background and bike2ratio
background_ratio_bikeshareAir pollution concentration ratio between background and bikeshare2ratio
background_ratio_busAir pollution concentration ratio between background and bus1.9ratio
background_ratio_carAir pollution concentration ratio between background and car2.5ratio
background_ratio_cardriverAir pollution concentration ratio between background and cardriver2.5ratio
background_ratio_carpassengerAir pollution concentration ratio between background and carpassenger2.5ratio
background_ratio_ebikeAir pollution concentration ratio between background and ebike2ratio
background_ratio_ebike25Air pollution concentration ratio between background and ebike252ratio
background_ratio_ebike45Air pollution concentration ratio between background and ebike452ratio
background_ratio_lightrailAir pollution concentration ratio between background and lightrail1.9ratio
background_ratio_motorbikeAir pollution concentration ratio between background and motorbike2.5ratio
background_ratio_ptAir pollution concentration ratio between background and pt1.9ratio
background_ratio_runAir pollution concentration ratio between background and run1.6ratio
background_ratio_trainAir pollution concentration ratio between background and train1.9ratio
background_ratio_walkAir pollution concentration ratio between background and walk1.6ratio
builduptime_crashTime needed to obtain full health impacts in crash module0years
builduptime_onecaseTime needed to obtain full health impacts in single case assessment0years
builduptime_twocasesTime needed to obtain full health impacts in two cases assessment5years
cap_bikeMaximum benefits cap (mortality risk reduction) from bike45%
cap_bikeshareMaximum benefits cap (mortality risk reduction) from bikeshare45%
cap_ebikeMaximum benefits cap (mortality risk reduction) from ebike45%
cap_ebike25Maximum benefits cap (mortality risk reduction) from ebike2545%
cap_ebike45Maximum benefits cap (mortality risk reduction) from ebike4545%
cap_max_pm25_concMax. concentration (cap) of air pollution (PM2.5) reflected in risk calculation100ug/m3
cap_runMaximum benefits cap (mortality risk reduction) from run30%
cap_walkMaximum benefits cap (mortality risk reduction) from walk30%
carbon_background_data_yearFor which year data from carbon_background_data should be used2015YYYY
cold_trip_distDaily distance covered with cold start of vehicles (value for {{country}} in {{year}})-1km/person*day
ef_bus_pkmCarbon emission factor (per vehicle-km) for bus-1gCO2e/vkm
ef_car_rw_pkmCarbon emission factor for car, per passenger-km-1gCO2e/vkm
ef_moto_pkmCarbon emission factor (per vehicle-km) for moto-1gCO2e/vkm
ef_vlca_bikeVLCA carbon emmission factor for bike-1gCO2e/vkm
ef_vlca_bikeshareVLCA carbon emmission factor for bikeshare-1gCO2e/vkm
ef_vlca_busVLCA carbon emmission factor for bus-1gCO2e/vkm
ef_vlca_carVLCA carbon emmission factor for car-1gCO2e/vkm
ef_vlca_cardriverVLCA carbon emmission factor for cardriver-1gCO2e/vkm
ef_vlca_carpassengerVLCA carbon emmission factor for carpassenger-1gCO2e/vkm
ef_vlca_ebikeVLCA carbon emmission factor for ebike-1gCO2e/vkm
ef_vlca_ebike25VLCA carbon emmission factor for ebike25-1gCO2e/vkm
ef_vlca_ebike45VLCA carbon emmission factor for ebike45-1gCO2e/vkm
ef_vlca_lightrailVLCA carbon emmission factor for lightrail-1gCO2e/vkm
ef_vlca_motoVLCA carbon emmission factor for moto-1NA
ef_vlca_motorbikeVLCA carbon emmission factor for motorbike-1gCO2e/vkm
ef_vlca_ptVLCA carbon emmission factor for pt-1gCO2e/vkm
ef_vlca_railVLCA carbon emmission factor for rail-1NA
ef_vlca_runVLCA carbon emmission factor for run-1gCO2e/vkm
ef_vlca_trainVLCA carbon emmission factor for train-1gCO2e/vkm
ef_vlca_walkVLCA carbon emmission factor for walk-1gCO2e/vkm
ef_wtt_bikeWell-to-tank carbon emission factor for bike-1gCO2e/vkm
ef_wtt_bikeshareWell-to-tank carbon emission factor for bikeshare-1gCO2e/vkm
ef_wtt_busWell-to-tank carbon emission factor for bus-1gCO2e/vkm
ef_wtt_carWell-to-tank carbon emission factor for car-1gCO2e/vkm
ef_wtt_cardriverWell-to-tank carbon emission factor for cardriver-1gCO2e/vkm
ef_wtt_carpassengerWell-to-tank carbon emission factor for carpassenger-1gCO2e/vkm
ef_wtt_ebikeWell-to-tank carbon emission factor for ebike-1gCO2e/vkm
ef_wtt_ebike25Well-to-tank carbon emission factor for ebike25-1gCO2e/vkm
ef_wtt_ebike45Well-to-tank carbon emission factor for ebike45-1gCO2e/vkm
ef_wtt_lightrailWell-to-tank carbon emission factor for lightrail-1gCO2e/vkm
ef_wtt_motoWell-to-tank carbon emission factor for moto-1NA
ef_wtt_motorbikeWell-to-tank carbon emission factor for motorbike-1gCO2e/vkm
ef_wtt_ptWell-to-tank carbon emission factor for pt-1gCO2e/vkm
ef_wtt_railWell-to-tank carbon emission factor for rail-1NA
ef_wtt_runWell-to-tank carbon emission factor for run-1gCO2e/vkm
ef_wtt_trainWell-to-tank carbon emission factor for train-1gCO2e/vkm
ef_wtt_walkWell-to-tank carbon emission factor for walk-1gCO2e/vkm
max_hrs_bikeMaximum hours input allowed for bike2hrs
max_hrs_bikeshareMaximum hours input allowed for bikeshare2hrs
max_hrs_ebikeMaximum hours input allowed for ebike2hrs
max_hrs_ebike25Maximum hours input allowed for ebike252hrs
max_hrs_ebike45Maximum hours input allowed for ebike452hrs
max_hrs_runMaximum hours input allowed for run2hrs
max_hrs_walkMaximum hours input allowed for walk2hrs
max_km_bikeMaximum km input allowed for bike20km
max_km_bikeshareMaximum km input allowed for bikeshare20km
max_km_ebikeMaximum km input allowed for ebike30km
max_km_ebike25Maximum km input allowed for ebike2530km
max_km_ebike45Maximum km input allowed for ebike4550km
max_km_runMaximum km input allowed for run20km
max_km_walkMaximum km input allowed for walk12km
max_min_bikeMaximum minutes input allowed for bike60min
max_min_bikeshareMaximum minutes input allowed for bikeshare60min
max_min_ebikeMaximum minutes input allowed for ebike120min
max_min_ebike25Maximum minutes input allowed for ebike25120
max_min_ebike45Maximum minutes input allowed for ebike45120
max_min_runMaximum minutes input allowed for run120min
max_min_walkMaximum minutes input allowed for walk120min
mets_bikePhysical intensity (Metabolic Equivalents of Task (METs) of ) bike6.8kcal/kg*h
mets_bikesharePhysical intensity (Metabolic Equivalents of Task (METs) of ) bikeshare6.8kcal/kg*h
mets_busPhysical intensity (Metabolic Equivalents of Task (METs) of ) bus1.9kcal/kg*h
mets_carPhysical intensity (Metabolic Equivalents of Task (METs) of ) car2.1kcal/kg*h
mets_cardriverPhysical intensity (Metabolic Equivalents of Task (METs) of ) cardriver2.5kcal/kg*h
mets_carpassengerPhysical intensity (Metabolic Equivalents of Task (METs) of ) carpassenger1.3kcal/kg*h
mets_ebikePhysical intensity (Metabolic Equivalents of Task (METs) of ) ebike5.5kcal/kg*h
mets_ebike25Physical intensity (Metabolic Equivalents of Task (METs) of ) ebike256kcal/kg*h
mets_ebike45Physical intensity (Metabolic Equivalents of Task (METs) of ) ebike455kcal/kg*h
mets_lightrailPhysical intensity (Metabolic Equivalents of Task (METs) of ) lightrail1.3kcal/kg*h
mets_motorbikePhysical intensity (Metabolic Equivalents of Task (METs) of ) motorbike1.3kcal/kg*h
mets_ptPhysical intensity (Metabolic Equivalents of Task (METs) of ) pt1.3kcal/kg*h
mets_runPhysical intensity (Metabolic Equivalents of Task (METs) of ) run7kcal/kg*h
mets_trainPhysical intensity (Metabolic Equivalents of Task (METs) of ) train1.3kcal/kg*h
mets_walkPhysical intensity (Metabolic Equivalents of Task (METs) of ) walk4kcal/kg*h
mileDistance conversion from mile to kilometer1.61mile
mvent_bikeMinute ventilation rate (l/min) of bike42.5l/min
mvent_bikeshareMinute ventilation rate (l/min) of bikeshare42.5l/min
mvent_busMinute ventilation rate (l/min) of bus10.2l/min
mvent_carMinute ventilation rate (l/min) of car10.2l/min
mvent_cardriverMinute ventilation rate (l/min) of cardriver10.2l/min
mvent_carpassengerMinute ventilation rate (l/min) of carpassenger10.2l/min
mvent_ebikeMinute ventilation rate (l/min) of ebike34.4l/min
mvent_ebike25Minute ventilation rate (l/min) of ebike2537.5l/min
mvent_ebike45Minute ventilation rate (l/min) of ebike4531.3l/min
mvent_lightrailMinute ventilation rate (l/min) of lightrail10.2l/min
mvent_motorbikeMinute ventilation rate (l/min) of motorbike10.2l/min
mvent_ptMinute ventilation rate (l/min) of pt10.2l/min
mvent_restMinute ventilation rate (l/min) of rest10.2l/min
mvent_runMinute ventilation rate (l/min) of run43.8l/min
mvent_sleepMinute ventilation rate (l/min) of sleep4.5l/min
mvent_trainMinute ventilation rate (l/min) of train10.2l/min
mvent_walkMinute ventilation rate (l/min) of walk22.8l/min
occupancy_rate_carAverage occupancy rate for cars all purposes-1persons
proportion_exposedProportion of the exposed population0.001proportion
pt_bus_rail_splitShare of bus trips compared to rail trips0.5proportion
ratiocoldhotProportion of cold vs. hot start (value for {{country}} in {{year}})-1ratio
ref_concentration_PM2.5Reference concentration (PM2.5) for the RR of air pollution and mortality10ug/m3
ref_duration_bikeReference duration for for relative risk for mortality and bike100minutes/person*week
ref_duration_bikeshareReference duration for for relative risk for mortality and bikeshare100minutes/person*week
ref_duration_ebikeReference duration for for relative risk for mortality and ebike124minutes/person*week
ref_duration_ebike25Reference duration for for relative risk for mortality and ebike25113minutes/person*week
ref_duration_ebike45Reference duration for for relative risk for mortality and ebike45136minutes/person*week
ref_duration_runReference duration for for relative risk for mortality and run100minutes/person*week
ref_duration_walkReference duration for for relative risk for mortality and walk168minutes/person*week
RR_bikeRelative risk for mortality and bike0.903ratio
RR_bike_corrected_apRelative risk for mortality and bike (physical activity only, excluding air pollution effect)0.899ratio
RR_bikeshareRelative risk for mortality and bikeshare0.903ratio
RR_bikeshare_corrected_apRelative risk for mortality and bikeshare (physical activity only, excluding air pollution effect)0.899ratio
RR_ebikeRelative risk for mortality and ebike0.903ratio
RR_ebike_corrected_apRelative risk for mortality and ebike (physical activity only, excluding air pollution effect)0.899ratio
RR_ebike25Relative risk for mortality and ebike250.903ratio
RR_ebike25_corrected_apRelative risk for mortality and ebike25 (physical activity only, excluding air pollution effect)0.899ratio
RR_ebike45Relative risk for mortality and ebike450.903ratio
RR_ebike45_corrected_apRelative risk for mortality and ebike45 (physical activity only, excluding air pollution effect)0.899ratio
RR_PM2.5Relative risk of air pollution (PM2.5) and mortality1.08ratio
RR_runRelative risk for mortality and run0.903ratio
RR_run_corrected_apRelative risk for mortality and run (physical activity only, excluding air pollution effect)0.899ratio
RR_walkRelative risk for mortality and walk0.886ratio
RR_walk_corrected_apRelative risk for mortality and walk (physical activity only, excluding air pollution effect)0.883ratio
speed_bikeAverage cycling speed14km/h
speed_bikeshareAverage bikeshare speed12.4km/h
speed_busAverage bus speed15.4km/h
speed_carAverage car speed42km/h
speed_cardriverAverage speed as car driver42km/h
speed_carpassengerAverage speed as car passenger42km/h
speed_ebikeAverage e-bike speed17km/h
speed_ebike25Average ebike25 speed (km/h)16km/h
speed_ebike45Average ebike45 speed (km/h)20km/h
speed_lightrailAverage light rail speed16.1km/h
speed_motorbikeAverage motorbike speed29.8km/h
speed_ptAverage public transport speed22.7km/h
speed_road_0Average road traffic speed for global average standards in urban areas for {{mode}}32km/h
speed_road_1Average road traffic speed for nearly free flow at all times in urban areas for {{mode}}45km/h
speed_road_2Average road traffic speed for minor congestion mainly at peak times in urban areas for {{mode}}35km/h
speed_road_3Average road traffic speed for heavy congestion throughout the day in urban areas for {{mode}}20km/h
speed_road_4Average road traffic speed for global average standards in rural areas for {{mode}}60km/h
speed_runAverage running speed13.3km/h
speed_trainAverage train speed37.4km/h
speed_walkAverage walking speed5.3km/h
steplengthAverage length of walking steps72cm