Skip to main content

Working with Populations

This guide shows how to browse available populations and use their data in simulations.

List all populations​

curl https://epyscenario-api.isi.it/api/v1/populations

Population names use underscores for spaces (United_States, United_Kingdom, South_Korea).

Inspect a population​

curl https://epyscenario-api.isi.it/api/v1/populations/United_States

Returns age group sizes and demographic breakdown.

Get contact matrices​

curl https://epyscenario-api.isi.it/api/v1/populations/United_States/contacts

Returns age-structured contact matrices for home, work, school, and other settings.

Use a population in a simulation​

curl -X POST https://epyscenario-api.isi.it/api/v1/simulations \
-H "Content-Type: application/json" \
-d '{
  "model": {"preset": "SIR", "parameters": {"transmission_rate": 0.3, "recovery_rate": 0.1}},
  "population": {"name": "Italy"},
  "simulation": {"start_date": "2024-01-01", "end_date": "2024-06-01", "Nsim": 50}
}'
info

Population data comes from epydemix. See the epydemix documentation for the full list of available countries.