API reference/Real Estate/Mortgage Calculator

Mortgage Calculator

Monthly payment, total interest and yearly amortization, priced at today’s average US mortgage rate unless you give one.

GET/api/v1/real-estate/mortgage-calculator

Data source

Query parameters

ParameterDescriptionTry value
price
number required
Home price
downPaymentPct
number
Down payment % (default 20)
downPayment
number
Down payment amount (overrides %)
years
number
Term in years (default 30)
ratePct
number
Interest rate % (default latest PMMS)
extraMonthly
number
Extra principal per month
apikey
string required
Your API key. Can also be sent as the X-API-Key header.demo key used here

Response envelope

Success: { data, meta: { sources, fetchedAt, cached } }. Errors: { error: { code, message } } with HTTP 400, 401, 404, 502, 503 or 504.