Running bulk applications using the HEAT API

Advanced users can now run bulk HEAT assessments via code, using the API (Application Programming Interface) feature.

The API connects your code to the HEAT calculation model. It is useful for repeating an assessment across locations, years or scenarios and collecting the results in one workflow.

Run many assessments using code

  1. Set up one assessment in the HEAT web tool. Choose the modes, pathways, cases and units you need; complete the assessment and export the input RDS file. See How HEAT works.
  2. Prepare your variations. Use a table with one row per run and field names matching the export. The tutorial includes a small example.
  3. Run a small test. Compare the returned results with the web tool before expanding the batch.
  4. Collect and interpret the results. Keep the inputs, model version and assumptions with the results.

Access and preparation

You need experience with R or a similar programming language. Request an API access cookie from heatwalkingcycling@who.int. Supply your own cookie privately; do not share it in scripts, repositories or results.

The exported template determines the assessment structure. Changing location requires country-specific population, mortality, pollution, crash and valuation inputs as well as location IDs. The codebooks explain the fields; the tutorial does not automatically refresh every background input.

Help, codebooks and downloads

Multi-country case studies

See how repeated assessments were used to explore higher activity across the WHO European Region:

Original HEAT API technical instructions and documentation. Consult if this website guidance should not resolve all your questions, or contact us (see below).