Parameters

Tax-benefit system parameters that can be modified in policy reforms. Each parameter has a name, description, and default values over time.

List parameters

GET/parameters

Retrieve all parameters. Can filter by model version.

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

Get parameter

GET/parameters/:parameter_id

Retrieve a specific parameter by ID.

Path parameters

parameter_idUUID of the parameter

https://v2.api.policyengine.org/parameters/ee0e8400-e29b-41d4-a716-446655440000

List parameter values

GET/parameter-values

Retrieve all parameter values.

https://v2.api.policyengine.org/parameter-values

Parameter object

idUUID - Unique identifier

namestring - Full parameter path

labelstring - Human-readable label

descriptionstring | null - Detailed description

unitstring | null - Unit (currency, percent, etc.)

Example UK parameters

gov.hmrc.income_tax.allowances.personal_allowance.amountgov.hmrc.income_tax.rates.uk.basicgov.dwp.universal_credit.elements.standard_allowance.single_young