Dynamics

Define behavioural response models that modify simulation parameters based on policy changes.

List dynamics

GET/dynamics

Retrieve all defined dynamic models.

https://v2.api.policyengine.org/dynamics

Get dynamic

GET/dynamics/:dynamic_id

Retrieve a specific dynamic model by ID.

Path parameters

dynamic_idUUID of the dynamic model

https://v2.api.policyengine.org/dynamics/aa0e8400-e29b-41d4-a716-446655440000

Create dynamic

POST/dynamics

Create a new behavioural response model.

Request body

{
  "name": "Labour supply elasticity",
  "description": "Models labour supply response to tax changes",
  "parameter_values": [
    {
      "parameter_id": "fae4ceb3-1ec2-4e05-baa7-00ecc9060592",
      "value_json": {
        "value": 0.2
      },
      "start_date": "2026-01-01",
      "end_date": "2026-12-31"
    }
  ]
}

https://v2.api.policyengine.org/dynamics

Request parameters

namestring - Model name

descriptionstring | null - Optional description

parameter_valuesarray - Behavioural parameter modifications (see below)

Parameter value object

parameter_idUUID - Reference to parameter

value_jsonobject - New parameter value

start_datedate - When change takes effect

end_datedate - When change ends

Dynamic object

idUUID - Unique identifier

namestring - Model name

descriptionstring | null - Optional description

parameter_valuesarray - Behavioural parameter modifications