Skip to content

Mortgage · Calculation

Home price from a housing budget

Solve for price and loan size using caller-entered mortgage terms, DTI target, down payment and recurring housing costs.

Example result · affordableLoanAmount: 480000 USD 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 mortgage-affordable-price.

Keep the key on your server. A successful call uses 2 calculation credits.

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-affordable-price";
const input = {
  "monthlyIncome": 8000,
  "monthlyDebts": 800,
  "interestRate": 0,
  "loanTerm": 20,
  "downPaymentPercent": 20,
  "propertyTaxRate": 0,
  "insuranceRate": 0,
  "pmiRate": 0.5,
  "targetDti": 35
};
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-affordable-price' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "monthlyIncome": 8000,
  "monthlyDebts": 800,
  "interestRate": 0,
  "loanTerm": 20,
  "downPaymentPercent": 20,
  "propertyTaxRate": 0,
  "insuranceRate": 0,
  "pmiRate": 0.5,
  "targetDti": 35
}
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-affordable-price.
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.

affordableLoanAmount
480000 USD
affordableHomePrice
600000 USD
estimatedMonthlyPayment
2000 USD/month
Full example response (JSON)
{
  "status": "available",
  "result": {
    "affordableLoanAmount": 480000,
    "affordableHomePrice": 600000,
    "estimatedMonthlyPayment": 2000,
    "monthlyPMI": 0,
    "ltvPercent": 80
  },
  "formulaVersion": "mortgage-affordable-price-htcalc-719df2c0e105",
  "units": {
    "affordableLoanAmount": "USD",
    "affordableHomePrice": "USD",
    "estimatedMonthlyPayment": "USD/month",
    "monthlyPMI": "USD/month",
    "ltvPercent": "percent"
  },
  "assumptions": [],
  "warnings": [],
  "creditCost": 2
}

Request contract

Accepted inputs

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

FieldType, units and limits

monthlyIncomeRequired
number

US dollars per month

Min 0 · Max 1000000000
monthlyDebtsRequired
number

US dollars per month

Min 0 · Max 1000000000
interestRateRequired
number

Annual interest in percent (5 means 5%)

Min 0 · Max 50
loanTermRequired
integer

Whole years

Min 1 · Max 50
downPaymentOptional
number

US dollars

Min 0 · Max 1000000000
downPaymentPercentOptional
number

Percentage points (5 means 5%)

Min 0 · Max 100
propertyTaxRateOptional
number

Percentage points (5 means 5%)

Min 0 · Max 100
insuranceRateOptional
number

Percentage points (5 means 5%)

Min 0 · Max 100
pmiRateOptional
number

Percentage points (5 means 5%)

Min 0 · Max 100
targetDtiRequired
number

DTI percent (40 means 40%)

Min 0.01 · Max 100
Example request body (JSON)
{
  "monthlyIncome": 8000,
  "monthlyDebts": 800,
  "interestRate": 0,
  "loanTerm": 20,
  "downPaymentPercent": 20,
  "propertyTaxRate": 0,
  "insuranceRate": 0,
  "pmiRate": 0.5,
  "targetDti": 35
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "monthlyIncome": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "monthlyDebts": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "interestRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 50,
      "description": "Annual interest in percent (5 means 5%)"
    },
    "loanTerm": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Whole years"
    },
    "downPayment": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "downPaymentPercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (5 means 5%)"
    },
    "propertyTaxRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (5 means 5%)"
    },
    "insuranceRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (5 means 5%)"
    },
    "pmiRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (5 means 5%)"
    },
    "targetDti": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 100,
      "description": "DTI percent (40 means 40%)"
    }
  },
  "required": [
    "monthlyIncome",
    "monthlyDebts",
    "interestRate",
    "loanTerm",
    "targetDti"
  ]
}

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