Calculate income-based home affordability (deprecated)

View all Realty in US Property & Mortgage Data endpoints →

Legacy GET calculation for an income-based home-purchase budget. Supply annual_income, monthly_debt, debt_to_income_ratio, down_payment, loan_term, interest_rate, tax_rate and homeowner_insurance_rate; hoa_fees and is_pmi_included are optional. The documented ratio and rate examples use decimals, such as 0.43 for a 43% debt-to-income ratio and 0.03119 for a 3.119% interest rate. Preserve the legacy flag with care: its notes associate is_pmi_included with military service and say false sets down_payment to zero, which conflicts with the apparent meaning of its name. That behavior has not been verified. No live response was observed for this deprecated route. The truncated, unverified documentation example contains an affordability object with calculated_price, debt_to_income_ratio, house_expenses_ratio, hoa_fees, monthly_payment, principal_and_interest, monthly_property_taxes, monthly_home_insurance and monthly_mortgage_insurance. It also shows a range object keyed by numeric strings, with nested affordability breakdowns using the same field names. The example represents the output debt-to-income ratio as a percentage-style number even though the input example is fractional. Neither the full range coverage nor a complete response schema is established by that sample. Retain this operation only to document and migrate existing affordability integrations, not for new development. A payment calculator is not automatically an equivalent replacement for an income-based budget estimate. These figures do not establish loan eligibility, underwriting approval or a lender offer.

API Features

Income-and-debt budget assumptions Keep annual income, existing monthly debt and the target debt-to-income ratio explicit when auditing a retired home-affordability workflow.
Housing costs beyond loan principal Record down payment, interest, loan term, taxes, insurance and optional HOA fees rather than reducing the legacy request to principal and interest alone.
Documented affordability components Map the unverified affordability example into estimated purchase price, monthly payment, principal and interest, property taxes and insurance components.
Ratio-range migration reference Account for the sample range object and its repeated budget breakdowns without assuming its numeric keys or coverage are a verified contract.

Live API Demo

GET /api/project/realty-in-us/mortgage-calculate-affordability-deprecated

Request cost is temporarily unavailable. No price is assumed.

View pricing

API Response (JSON)

{}
curl -X GET 'https://api.opendata-api.com/api/project/realty-in-us/mortgage-calculate-affordability-deprecated?key=<API_KEY>&annual_income=<annual_income>&debt_to_income_ratio=<debt_to_income_ratio>&down_payment=<down_payment>&homeowner_insurance_rate=<homeowner_insurance_rate>&interest_rate=<interest_rate>&loan_term=<loan_term>&monthly_debt=<monthly_debt>&tax_rate=<tax_rate>'
📢
Need Help?
If you encounter API issues or need other API requirements, please contact us.
Contact Us

Use Cases

Frequently asked questions

Should a new home-budget tool use this affordability operation?

No. This is a deprecated route retained for legacy migration. No live response was observed for it, and a working replacement must be verified separately.

How are the debt ratio and rate inputs represented?

The documented inputs use decimal fractions: debt_to_income_ratio is 0.43 for 43%, interest_rate is 0.03119 for 3.119%, tax_rate is 0.01 for 1% and homeowner_insurance_rate is 0.012 for 1.2%. The stored response example instead shows debt_to_income_ratio in percentage-style form, so do not assume input and output scaling match.

Does is_pmi_included reliably control private mortgage insurance?

That interpretation is not established. Legacy notes describe military service and state that false sets down_payment to zero, despite the PMI-style parameter name. Preserve existing callers cautiously and verify the behavior before using it for insurance or eligibility decisions.

Which affordability response fields are documented?

The unverified sample shows affordability.calculated_price, monthly_payment, principal_and_interest, monthly_property_taxes, monthly_home_insurance, monthly_mortgage_insurance, hoa_fees, debt_to_income_ratio and house_expenses_ratio. Its range object contains similarly shaped breakdowns. The example is truncated, so it does not prove complete field or range coverage.

Can a mortgage-payment estimate replace this result or approve a borrower?

Not automatically. This request includes income and existing debt to estimate a budget, while a payment estimate answers a different question. Neither a legacy affordability result nor a payment calculation constitutes underwriting approval or a binding loan offer.

Related operations

Guides

View Subscription Plans →