Mortgage · Calculation
Purchase power with existing rentals
Model rental profits and losses, debt, target DTI and the remaining payment capacity for a new purchase.
Example result · qualifyingRentalIncome: 500 USD/month See output
- Cost per success
- 2 calculation credits
- Production plans
- Standard, Business, Scale, Enterprise
Plan allowances - Free sandbox
- Not available
Integration example
Make a request
Use a production key scoped to rental-income-purchase-power.
Keep the key on your server. A successful call uses 2 calculation credits.
Set HT_PRODUCTION_KEY on your server. Save as example.mjs and run node example.mjs with Node.js 18 or later.
import { randomUUID } from "node:crypto";
const key = process.env.HT_PRODUCTION_KEY;
if (!key) throw new Error("Set HT_PRODUCTION_KEY on your server.");
const endpoint = "https://calc.hasstechapi.com/v2/calc/rental-income-purchase-power";
const input = {
"monthlyW2Income": 7000,
"otherIncome": 500,
"existingMonthlyDebt": 600,
"rentalProperties": [
{
"monthlyRent": 2000,
"monthlyMortgagePITI": 1000
},
{
"monthlyRent": 1000,
"monthlyMortgagePITI": 900
}
],
"targetDTI": 0.4,
"interestRate": 0.06,
"loanTermYears": 30,
"propertyTaxRate": 0.01,
"insuranceAnnual": 1200,
"downPaymentPercent": 0.2
};
const requestId = process.env.HT_REQUEST_ID || Date.now() + "." + randomUUID();
// Keep this ID to look up usage if the connection is interrupted.
console.error("Usage lookup ID:", requestId);
const response = await fetch(endpoint, {
method: "POST",
redirect: "error",
headers: {
"Authorization": "Bearer " + key,
"Content-Type": "application/json",
"Idempotency-Key": requestId
},
body: JSON.stringify(input)
});
if (!response.ok) {
const problem = await response.json().catch(() => null);
const code = problem?.error?.code || response.statusText;
const delay = response.headers.get("retry-after");
if (delay) console.error("Retry-After (seconds):", delay);
console.error("HTTP " + response.status + " " + code + ". Usage lookup ID: " + requestId);
if (Array.isArray(problem?.error?.details)) {
for (const issue of problem.error.details) console.error("Input issue:", JSON.stringify(issue));
}
process.exitCode = 1;
} else {
console.log(JSON.stringify(await response.json(), null, 2));
} cURL (shell)
(
set -eu
: "${HT_PRODUCTION_KEY:?Set HT_PRODUCTION_KEY on your server}"
request_id="${HT_REQUEST_ID:-}"
if [ -z "$request_id" ]; then
request_id=$(python3 -c 'import time, uuid; print(str(time.time_ns() // 1000000) + "." + str(uuid.uuid4()))')
fi
printf 'Usage lookup ID: %s\n' "$request_id" >&2
# On INVALID_INPUT, read error.details in the JSON response body.
curl --disable --silent --show-error --fail-with-body --include \
--request POST 'https://calc.hasstechapi.com/v2/calc/rental-income-purchase-power' \
--header "Authorization: Bearer $HT_PRODUCTION_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"monthlyW2Income": 7000,
"otherIncome": 500,
"existingMonthlyDebt": 600,
"rentalProperties": [
{
"monthlyRent": 2000,
"monthlyMortgagePITI": 1000
},
{
"monthlyRent": 1000,
"monthlyMortgagePITI": 900
}
],
"targetDTI": 0.4,
"interestRate": 0.06,
"loanTermYears": 30,
"propertyTaxRate": 0.01,
"insuranceAnnual": 1200,
"downPaymentPercent": 0.2
}
HT_INPUT
) If your request fails
400 INVALID_INPUT-
Read
error.detailswhen present. Node prints each issue. cURL returns the JSON body. Eachpathpoints into your request. An empty path refers to the whole body.Check the accepted inputs for required fields, units and ranges. Send the corrected JSON as a new request.
401or403- Check that the server has the bearer key for the endpoint’s environment and that the key includes
rental-income-purchase-power. 429- Read the service error code, check your allowance, and wait for the
Retry-Afterinterval when supplied before trying again. - Lost response,
409or503 - Open Request lookup, select the same environment and enter the printed usage lookup ID. A settled ID has already consumed credits. To retry the same calculation, set
HT_REQUEST_IDto the original ID and reuse the same inputs. A settled request does not return its result again. Unset the variable for a new request, which can consume credits.
The usage lookup ID is the Idempotency-Key your server sends. The response’s x-request-id identifies the HTTP exchange for support.
Output
Example result
These values come from running this operation on the example inputs.
qualifyingRentalIncome- 500 USD/month
rentalLossAddedToDebt- 150 USD/month
totalMonthlyIncome- 8000 USD/month
How to interpret this result
- Model credits 75% of gross rental income, then subtracts the entered PITI.
Full example response (JSON)
{
"status": "available",
"result": {
"qualifyingRentalIncome": 500,
"rentalLossAddedToDebt": 150,
"totalMonthlyIncome": 8000,
"remainingDTICapacity": 2450,
"maxNewMonthlyPITI": 2450,
"maxNewLoanAmount": 333940.9683874249,
"maxNewPurchasePrice": 417426.21048428107
},
"formulaVersion": "rental-income-purchase-power-htcalc-719df2c0e105",
"units": {
"qualifyingRentalIncome": "USD/month",
"rentalLossAddedToDebt": "USD/month",
"totalMonthlyIncome": "USD/month",
"maxNewMonthlyPITI": "USD/month",
"maxNewLoanAmount": "USD",
"maxNewPurchasePrice": "USD"
},
"assumptions": [
"Model credits 75% of gross rental income, then subtracts the entered PITI."
],
"warnings": [],
"creditCost": 2
}Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
monthlyW2IncomeRequiredUS dollars per month
Min 0 · Max 1000000000otherIncomeRequiredUS dollars per month
Min 0 · Max 1000000000existingMonthlyDebtRequiredUS dollars per month
Min 0 · Max 1000000000rentalPropertiesRequiredrentalProperties[].monthlyRentRequiredUS dollars per month
Min 0 · Max 1000000000rentalProperties[].monthlyMortgagePITIRequiredUS dollars per month
Min 0 · Max 1000000000targetDTIRequiredFraction (0.05 means 5%)
Min 0 · Max 1interestRateRequiredAnnual rate as a fraction (0.05 means 5%)
Min 0 · Max 0.5loanTermYearsRequiredWhole years
Min 1 · Max 50propertyTaxRateRequiredFraction (0.05 means 5%)
Min 0 · Max 1insuranceAnnualRequiredUS dollars per year
Min 0 · Max 1000000000downPaymentPercentRequiredDown payment as a fraction
Min 0 · Max 0.99Example request body (JSON)
{
"monthlyW2Income": 7000,
"otherIncome": 500,
"existingMonthlyDebt": 600,
"rentalProperties": [
{
"monthlyRent": 2000,
"monthlyMortgagePITI": 1000
},
{
"monthlyRent": 1000,
"monthlyMortgagePITI": 900
}
],
"targetDTI": 0.4,
"interestRate": 0.06,
"loanTermYears": 30,
"propertyTaxRate": 0.01,
"insuranceAnnual": 1200,
"downPaymentPercent": 0.2
} Full JSON schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"monthlyW2Income": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars per month"
},
"otherIncome": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars per month"
},
"existingMonthlyDebt": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars per month"
},
"rentalProperties": {
"type": "array",
"maxItems": 40,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"monthlyRent": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars per month"
},
"monthlyMortgagePITI": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars per month"
}
},
"required": [
"monthlyRent",
"monthlyMortgagePITI"
]
}
},
"targetDTI": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Fraction (0.05 means 5%)"
},
"interestRate": {
"type": "number",
"minimum": 0,
"maximum": 0.5,
"description": "Annual rate as a fraction (0.05 means 5%)"
},
"loanTermYears": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"description": "Whole years"
},
"propertyTaxRate": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Fraction (0.05 means 5%)"
},
"insuranceAnnual": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars per year"
},
"downPaymentPercent": {
"type": "number",
"minimum": 0,
"maximum": 0.99,
"description": "Down payment as a fraction"
}
},
"required": [
"monthlyW2Income",
"otherIncome",
"existingMonthlyDebt",
"rentalProperties",
"targetDTI",
"interestRate",
"loanTermYears",
"propertyTaxRate",
"insuranceAnnual",
"downPaymentPercent"
]
}Production endpoint: POST https://calc.hasstechapi.com/v2/calc/rental-income-purchase-power
Formula: rental-income-purchase-power-htcalc-719df2c0e105