Realtor Affordability Calculator API - Income, Funds and Debt

Provide annualIncome and availableFunds as the documented string inputs; monthlyDebt is an optional number and isPmiIncluded is an optional boolean. The source description for isPmiIncluded is inconsistent with its name, so its meaning and effect must be confirmed rather than described as a verified military or insurance benefit. This route was not live-tested and no affordability fields, ratios or assumptions were observed. Use synthetic scenario inputs, minimize retention of personal finances, and treat any available output as a budgeting estimate rather than mortgage preapproval.

API Features

Income-and-funds starting point annualIncome and availableFunds are the required string-valued inputs for this documented affordability request.

Optional monthly-debt scenario monthlyDebt can vary a submitted budget scenario after accepted units and calculation behavior are validated.

Ambiguous PMI flag disclosure isPmiIncluded is retained as a boolean, but its inconsistent source description prevents a verified semantic promise.

Financial-input privacy boundary Use synthetic examples and avoid unnecessary retention of a person's income, funds and debts.

Live API Demo

GET /api/project/realtor/tools-affordability-calculator

API Response (JSON)

{}

curl -X GET 'https://api.opendata-api.com/api/project/realtor/tools-affordability-calculator?key=<API_KEY>&annualIncome=100000&availableFunds=240000&isPmiIncluded=true'

curl -X GET 'https://api.opendata-api.com/api/project/realtor/tools-affordability-calculator?key=<API_KEY>&annualIncome=100000&availableFunds=240000&isPmiIncluded=true'

📢

Need Help?

If you encounter API issues or need other API requirements, please contact us.

Use Cases

Prototype an affordability worksheet with synthetic financial scenarios and visible assumptions.
Evaluate debt-versus-savings budgeting trade-offs after confirming actual output fields.
Investigate the isPmiIncluded flag in controlled acceptance tests before exposing it to end users.
Design a financial-input flow that avoids storing personal income and debt just to obtain an estimate.

Frequently asked questions

Why are annualIncome and availableFunds string inputs?

Those are the documented types for this operation. Preserve the contract instead of importing another operation types or units merely because the values resemble money amounts.

Does isPmiIncluded definitely include private mortgage insurance?

The name suggests that interpretation, but the description is inconsistent and actual semantics were not verified. Validate its effect rather than advertising confirmed insurance or military-benefit behavior.

Does an affordability estimate mean a lender will approve the loan?

No. This operation was not live-tested, and any available result is budgeting context, not preapproval, eligibility or personalized financial advice.

Related operations

Guides

View Subscription Plans →

Evaluate Home Affordability from Income and Funds