Run a rent vs buy scenario
rentbuy_run_scenarioRuns one 30-year rent-vs-buy comparison with the rentbuy.org model and returns the winner, the net worth of both households at year 30, the break-even year, totals, year-1 monthly cash and the fully resolved inputs. Give only the inputs you want to change; everything else uses the site defaults. Set detail to "yearly" to also get the 30 year-by-year rows. Use rentbuy_compare_scenarios or rentbuy_sweep instead of calling this repeatedly.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| detail | No | "summary" (default) or "yearly" for the 30 annual rows. | |
| inputs | No | Any subset of the inputs; missing fields use the rentbuy.org defaults. Money in USD, rates in percent points. | |
| oneTimeCosts | No | Up to 20 one-time costs. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| meta | Yes | ||
| year1 | Yes | Monthly cash in year 1; ownership includes mortgage, property tax, insurance, maintenance and HOA. | |
| totals | Yes | ||
| winner | Yes | Which household has more net worth after 30 years, after selling costs on the buy side. | |
| yearly | No | Present when detail is "yearly". Net worth figures here are before selling costs. | |
| advantage | Yes | Absolute net worth gap between the two households at year 30, USD. | |
| difference | Yes | Signed gap: buyNetWorthAfterSale minus rentNetWorth, USD. | |
| oneTimeCosts | Yes | ||
| rentNetWorth | Yes | Renter portfolio at year 30. | |
| breakEvenYear | Yes | First year in which the buyer is ahead before selling costs, or null if never within 30 years. | |
| resolvedInputs | Yes | The full input set the calculation used, after defaults and tax pre-fill, in the same units as the request. | |
| buyNetWorthAfterSale | Yes | Buyer net worth at year 30 after selling costs (home equity plus buyer investments minus selling costs). |