Base URL:

Policies

Define policy reforms by modifying tax-benefit system parameters.

List policies

GET/policies

Retrieve all defined policies.

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

Get policy

GET/policies/:policy_id

Retrieve a specific policy by ID.

Path parameters

https://v2.api.policyengine.org/policies/660e8400-e29b-41d4-a716-446655440000

Create policy

POST/policies

Create a new policy reform with parameter value changes.

Request body

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

Request parameters

namestring - Policy name
descriptionstring | null - Optional description
parameter_valuesarray - Parameter modifications (see below)

Delete policy

DELETE/policies/:policy_id

Delete a policy by ID.

Path parameters

https://v2.api.policyengine.org/policies/660e8400-e29b-41d4-a716-446655440000

Policy object

idUUID - Unique identifier
namestring - Policy name
descriptionstring | null - Optional description
parameter_valuesarray - Parameter modifications
created_atdatetime - Creation timestamp

Parameter value object

parameter_idUUID - Reference to parameter
value_jsonobject - New parameter value
start_datedate - When change takes effect
end_datedate - When change ends