Skip to content

Mortgage · Calculation

Income required at target DTI

Solve for gross income under the supplied payment, taxes, insurance, mortgage-insurance rate, monthly debts and target DTI.

Example result · requiredMonthlyIncome: 5000 USD/month See output

Cost per success
1 calculation credit
Production plans
Standard, Business, Scale, Enterprise
Plan allowances
Free sandbox
Not available

Integration example

Make a request

Use a production key scoped to mortgage-income-required.

Keep the key on your server. A successful call uses 1 calculation credit.

Production request

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/mortgage-income-required";
const input = {
  "homePrice": 300000,
  "downPaymentPercent": 20,
  "interestRate": 0,
  "loanTermYears": 20,
  "annualPropertyTaxRate": 1.2,
  "annualInsurance": 1200,
  "monthlyHOA": 100,
  "monthlyDebts": 500,
  "targetDTI": 0.4,
  "annualPmiRatePercent": 0.5
};
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 HT_PRODUCTION_KEY on your server. Run in a POSIX shell with cURL 7.76+ and Python 3.7+ to create a request ID.

(
  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/mortgage-income-required' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "homePrice": 300000,
  "downPaymentPercent": 20,
  "interestRate": 0,
  "loanTermYears": 20,
  "annualPropertyTaxRate": 1.2,
  "annualInsurance": 1200,
  "monthlyHOA": 100,
  "monthlyDebts": 500,
  "targetDTI": 0.4,
  "annualPmiRatePercent": 0.5
}
HT_INPUT
)
If your request fails
400 INVALID_INPUT

Read error.details when present. Node prints each issue. cURL returns the JSON body. Each path points 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.

401 or 403
Check that the server has the bearer key for the endpoint’s environment and that the key includes mortgage-income-required.
429
Read the service error code, check your allowance, and wait for the Retry-After interval when supplied before trying again.
Lost response, 409 or 503
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_ID to 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.

requiredMonthlyIncome
5000 USD/month
requiredAnnualIncome
60000 USD/year
maxMonthlyHousingPayment
1500
How to interpret this result
  • Caller supplies the target DTI and PMI assumptions. The optional program-table mode is outside this contract.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "requiredMonthlyIncome": 5000,
    "requiredAnnualIncome": 60000,
    "maxMonthlyHousingPayment": 1500,
    "monthlyPIPayment": 1000,
    "monthlyTaxes": 300,
    "monthlyInsurance": 100,
    "monthlyHOA": 100,
    "monthlyMortgageInsurance": 0,
    "financedUpfrontFee": 0,
    "loanAmount": 240000,
    "totalMonthlyHousing": 1500,
    "frontEndDTI": 0.3,
    "backEndDTI": 0.4
  },
  "formulaVersion": "mortgage-income-required-htcalc-719df2c0e105",
  "units": {
    "requiredMonthlyIncome": "USD/month",
    "requiredAnnualIncome": "USD/year",
    "monthlyPIPayment": "USD/month",
    "totalMonthlyHousing": "USD/month",
    "backEndDTI": "ratio"
  },
  "assumptions": [
    "Caller supplies the target DTI and PMI assumptions. The optional program-table mode is outside this contract."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

Fields for this example. Expand the schema for all supported combinations and limits.

FieldType, units and limits

homePriceRequired
number

US dollars

Min 0.01 · Max 1000000000
downPaymentPercentRequired
number

Percentage points (5 means 5%)

Min 0 · Max 100
interestRateRequired
number

Annual interest in percent (5 means 5%)

Min 0 · Max 50
loanTermYearsRequired
integer

Whole years

Min 1 · Max 50
annualPropertyTaxRateRequired
number

Percentage points (5 means 5%)

Min 0 · Max 100
annualInsuranceRequired
number

US dollars per year

Min 0 · Max 1000000000
monthlyHOARequired
number

US dollars per month

Min 0 · Max 1000000000
monthlyDebtsRequired
number

US dollars per month

Min 0 · Max 1000000000
targetDTIRequired
number

Target debt-to-income fraction (0.4 means 40%)

Min 0.01 · Max 1
annualPmiRatePercentOptional
number

Percentage points (5 means 5%)

Min 0 · Max 100
Example request body (JSON)
{
  "homePrice": 300000,
  "downPaymentPercent": 20,
  "interestRate": 0,
  "loanTermYears": 20,
  "annualPropertyTaxRate": 1.2,
  "annualInsurance": 1200,
  "monthlyHOA": 100,
  "monthlyDebts": 500,
  "targetDTI": 0.4,
  "annualPmiRatePercent": 0.5
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "homePrice": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "downPaymentPercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (5 means 5%)"
    },
    "interestRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 50,
      "description": "Annual interest in percent (5 means 5%)"
    },
    "loanTermYears": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Whole years"
    },
    "annualPropertyTaxRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (5 means 5%)"
    },
    "annualInsurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "monthlyHOA": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "monthlyDebts": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "targetDTI": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1,
      "description": "Target debt-to-income fraction (0.4 means 40%)"
    },
    "annualPmiRatePercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (5 means 5%)"
    }
  },
  "required": [
    "homePrice",
    "downPaymentPercent",
    "interestRate",
    "loanTermYears",
    "annualPropertyTaxRate",
    "annualInsurance",
    "monthlyHOA",
    "monthlyDebts",
    "targetDTI"
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/mortgage-income-required
Formula: mortgage-income-required-htcalc-719df2c0e105