Build an amortization schedule
calculate_amortizationPayment-by-payment breakdown of how a loan is repaid, showing the split between principal and interest and the falling balance. Use granularity 'monthly' for the first years in detail, 'yearly' for a whole-term overview. Also reports how much sooner extra principal pays the loan off.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| state | No | Full US state name, for example "Texas". Used to look up the average property tax rate. Either this or propertyTaxRatePercent is required. | |
| loanType | No | Loan programme. Affects mortgage insurance and upfront fees. | conventional |
| homePrice | Yes | Purchase price of the home in US dollars. | |
| monthlyHoa | No | Monthly homeowners association dues in US dollars. | |
| granularity | No | Yearly returns one row per year; monthly returns one row per payment, up to 600 rows. | yearly |
| loanTermYears | No | Loan term in years. Most US mortgages are 15 or 30. | |
| annualInsurance | No | Annual homeowners insurance premium in US dollars. | |
| downPaymentPercent | No | Down payment as a percentage of the purchase price, 0 to 100. Not a dollar amount. | |
| monthlyExtraPrincipal | No | Additional principal paid each month. Shortens the loan rather than lowering the payment. | |
| propertyTaxRatePercent | No | Annual property tax as a percentage of home value. Omit and pass `state` instead to use that state's average. | |
| annualInterestRatePercent | No | Annual nominal interest rate as a percentage, for example 6.5 for 6.5%. |