Variables

Tax-benefit system variables that can be calculated or used as inputs. Variables are associated with model versions.

List variables

GET/variables

Retrieve all variables. Can filter by model version.

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

GET/variables/:variable_id

Retrieve a specific variable by ID.

variable_idUUID of the variable

https://v2.api.policyengine.org/variables/dd0e8400-e29b-41d4-a716-446655440000

idUUID - Unique identifier

namestring - Variable name (e.g., income_tax)

labelstring - Human-readable label

descriptionstring | null - Detailed description

entitystring - Entity level (person, household, etc.)

value_typestring - Data type (float, int, bool, enum)

unitstring | null - Unit of measurement

income_taxnational_insuranceuniversal_creditchild_benefitcouncil_taxhousehold_net_incomeemployment_incomepension_income

income_taxemployee_payroll_taxsnaptanfssisocial_securityemployment_incomespm_unit_net_income