Household impact comparison
Compare a household under baseline (current law) vs a policy reform. Returns both calculations plus computed differences.
Calculate household impact
POST
/household/impactCalculate the difference between baseline and reform for a household.
Request body
https://v2.api.policyengine.org/household/impact
Request parameters
tax_benefit_model_namepolicyengine_uk or policyengine_uspeopleArray of person objects (age, employment_income, etc.)householdHousehold-level variables (region, etc.)yearinteger | null - Simulation yearpolicy_idUUID | null - Reform policy to compare against baselinedynamic_idUUID | null - Optional behavioural response modelExample response
{
"baseline": {
"person": [
{
"income_tax": 7486,
"net_income": 42514
}
],
"household": {
"household_net_income": 42514
}
},
"reform": {
"person": [
{
"income_tax": 6486,
"net_income": 43514
}
],
"household": {
"household_net_income": 43514
}
},
"impact": {
"household": {
"household_net_income": {
"baseline": 42514,
"reform": 43514,
"change": 1000
}
},
"person": [
{
"income_tax": {
"baseline": 7486,
"reform": 6486,
"change": -1000
},
"net_income": {
"baseline": 42514,
"reform": 43514,
"change": 1000
}
}
]
}
}Response structure
baselineFull household calculation under current lawreformFull household calculation with policy appliedimpactComputed differences (baseline, reform, change) for numeric variables