Base URL:

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/impact

Calculate 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_us
peopleArray of person objects (age, employment_income, etc.)
householdHousehold-level variables (region, etc.)
yearinteger | null - Simulation year
policy_idUUID | null - Reform policy to compare against baseline
dynamic_idUUID | null - Optional behavioural response model

Example 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 law
reformFull household calculation with policy applied
impactComputed differences (baseline, reform, change) for numeric variables