try_household_projection
Run the deterministic multi-year household projection on a document you pass in — income, RMDs, Roth conversions, federal and covered-state tax, expenses, amortization, the tax-grossed-up deficit draw, and net worth per year — optionally with a seeded Monte Carlo. NOTHING IS STORED: no household is created, no id issued, no record kept. Takes any key, a free sandbox key included (worthune.com/sandbox). The response carries every simplification that fired in projection.assumptionsApplied and an evidence record whose hash reproduces on an identical document, so you can show your work. Use list_example_households for a starting shape. For a household that persists — with an id, bulk import, webhooks and drift detection — see create_household.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| policy | No | ||
| api_key | No | Worthune API key (wk_…); a free sandbox key works | |
| horizon | Yes | ||
| household | Yes | A household document: { schemaVersion, filingStatus, state?, members[], accounts[], liabilities[], incomes[], expenses[] }. It has no name field and no account numbers by design. Any expense `label` is stripped before anything is computed. | |
| monteCarlo | No | Simulations are clamped to 500 on this surface, and the clamp is reported back. | |
| assumptions | Yes | Required here: this surface has no org profile to fall back on. |