API reference/Real Estate/Home Affordability

Home Affordability

Maximum home price for an income using 28/36 debt-to-income rules, taxes and insurance, at today’s mortgage rate.

GET/api/v1/real-estate/affordability

Data source

Query parameters

ParameterDescriptionTry value
annualIncome
number required
Gross annual income
monthlyDebts
number
Other monthly debt payments
downPayment
number
Cash for the down payment
years
number
Term in years (default 30)
ratePct
number
Interest rate % (default latest PMMS)
propertyTaxPct
number
Property tax % of value per year (default 1.1)
insurancePct
number
Insurance % of value per year (default 0.35)
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.