Skip to content

Mortgage · Calculation

Monthly homeownership budget

Combine principal and interest with caller-supplied property taxes, homeowners insurance, maintenance and HOA to calculate the recurring ownership budget.

Example result · homePrice: 300000 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 home-ownership-budget.

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/home-ownership-budget";
const input = {
  "monthlyRent": 1500,
  "annualRentIncreaseRate": 2,
  "monthlyRentersInsurance": 20,
  "homePrice": 300000,
  "downPayment": 60000,
  "interestRate": 0,
  "loanTermYears": 20,
  "annualPropertyTax": 3600,
  "annualHomeInsurance": 1200,
  "annualMaintenance": 3600,
  "monthlyHOA": 100,
  "buyingClosingCosts": 6000,
  "annualHomeAppreciationRate": 2,
  "annualInvestmentReturnRate": 3,
  "annualDiscountRate": 4,
  "yearsToAnalyze": 5,
  "sellingCostRate": 5,
  "annualOwnershipCostInflationRate": 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 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/home-ownership-budget' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "monthlyRent": 1500,
  "annualRentIncreaseRate": 2,
  "monthlyRentersInsurance": 20,
  "homePrice": 300000,
  "downPayment": 60000,
  "interestRate": 0,
  "loanTermYears": 20,
  "annualPropertyTax": 3600,
  "annualHomeInsurance": 1200,
  "annualMaintenance": 3600,
  "monthlyHOA": 100,
  "buyingClosingCosts": 6000,
  "annualHomeAppreciationRate": 2,
  "annualInvestmentReturnRate": 3,
  "annualDiscountRate": 4,
  "yearsToAnalyze": 5,
  "sellingCostRate": 5,
  "annualOwnershipCostInflationRate": 2
}
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 home-ownership-budget.
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.

homePrice
300000
downPayment
60000
loanAmount
240000 USD
Full example response (JSON)
{
  "status": "available",
  "result": {
    "homePrice": 300000,
    "downPayment": 60000,
    "loanAmount": 240000,
    "buyingClosingCosts": 6000,
    "monthlyPI": 1000,
    "monthlyPropertyTax": 300,
    "monthlyHomeInsurance": 100,
    "monthlyMaintenance": 300,
    "monthlyHOA": 100,
    "totalMonthlyOwnershipCost": 1800
  },
  "formulaVersion": "home-ownership-budget-htcalc-719df2c0e105",
  "units": {
    "loanAmount": "USD",
    "monthlyPI": "USD/month",
    "monthlyPropertyTax": "USD/month",
    "monthlyHomeInsurance": "USD/month",
    "monthlyMaintenance": "USD/month",
    "monthlyHOA": "USD/month",
    "totalMonthlyOwnershipCost": "USD/month"
  },
  "assumptions": [],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

monthlyRentRequired
number

US dollars per month

Min 0 · Max 100000000
annualRentIncreaseRateRequired
number

Percent; 5 means 5%

Min 0 · Max 100
monthlyRentersInsuranceOptional
number

US dollars per month

Min 0 · Max 100000000
homePriceRequired
number

Positive US dollars

Min 0.01 · Max 1000000000
downPaymentConditional
number

US dollars

Min 0 · Max 1000000000
downPaymentRateConditional
number

Percent; 5 means 5%

Min 0 · Max 100
interestRateRequired
number

Annual note rate in percent; 6 means 6%

Min 0 · Max 50
loanTermYearsRequired
integer

Whole years

Min 1 · Max 50
annualPropertyTaxConditional
number

US dollars per year

Min 0 · Max 1000000000
propertyTaxRateConditional
number

Percent; 5 means 5%

Min 0 · Max 100
annualHomeInsuranceConditional
number

US dollars per year

Min 0 · Max 1000000000
monthlyHomeInsuranceConditional
number

US dollars per month

Min 0 · Max 100000000
annualMaintenanceConditional
number

US dollars per year

Min 0 · Max 1000000000
maintenanceRateConditional
number

Percent; 5 means 5%

Min 0 · Max 100
monthlyHOAOptional
number

US dollars per month

Min 0 · Max 100000000
buyingClosingCostsConditional
number

US dollars

Min 0 · Max 1000000000
buyingClosingCostsRateConditional
number

Percent; 5 means 5%

Min 0 · Max 100
annualHomeAppreciationRateRequired
number

Percent; 5 means 5%

Min 0 · Max 100
annualInvestmentReturnRateRequired
number

Percent; 5 means 5%

Min 0 · Max 100
annualDiscountRateRequired
number

Percent; 5 means 5%

Min 0 · Max 100
yearsToAnalyzeRequired
integer

Modeled years

Min 1 · Max 50
sellingCostRateOptional
number

Percent; 5 means 5%

Min 0 · Max 100
annualOwnershipCostInflationRateOptional
number

Percent; 5 means 5%

Min 0 · Max 100
Example request body (JSON)
{
  "monthlyRent": 1500,
  "annualRentIncreaseRate": 2,
  "monthlyRentersInsurance": 20,
  "homePrice": 300000,
  "downPayment": 60000,
  "interestRate": 0,
  "loanTermYears": 20,
  "annualPropertyTax": 3600,
  "annualHomeInsurance": 1200,
  "annualMaintenance": 3600,
  "monthlyHOA": 100,
  "buyingClosingCosts": 6000,
  "annualHomeAppreciationRate": 2,
  "annualInvestmentReturnRate": 3,
  "annualDiscountRate": 4,
  "yearsToAnalyze": 5,
  "sellingCostRate": 5,
  "annualOwnershipCostInflationRate": 2
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "monthlyRent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000000,
      "description": "US dollars per month"
    },
    "annualRentIncreaseRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "monthlyRentersInsurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000000,
      "description": "US dollars per month"
    },
    "homePrice": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "Positive US dollars"
    },
    "downPayment": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "downPaymentRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "interestRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 50,
      "description": "Annual note rate in percent; 6 means 6%"
    },
    "loanTermYears": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Whole years"
    },
    "annualPropertyTax": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "propertyTaxRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "annualHomeInsurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "monthlyHomeInsurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000000,
      "description": "US dollars per month"
    },
    "annualMaintenance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "maintenanceRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "monthlyHOA": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000000,
      "description": "US dollars per month"
    },
    "buyingClosingCosts": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "buyingClosingCostsRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "annualHomeAppreciationRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "annualInvestmentReturnRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "annualDiscountRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "yearsToAnalyze": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Modeled years"
    },
    "sellingCostRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "annualOwnershipCostInflationRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    }
  },
  "required": [
    "homePrice",
    "interestRate",
    "loanTermYears",
    "monthlyRent",
    "annualRentIncreaseRate",
    "annualHomeAppreciationRate",
    "annualInvestmentReturnRate",
    "annualDiscountRate",
    "yearsToAnalyze"
  ],
  "allOf": [
    {
      "oneOf": [
        {
          "required": [
            "downPayment"
          ]
        },
        {
          "required": [
            "downPaymentRate"
          ]
        }
      ]
    },
    {
      "oneOf": [
        {
          "required": [
            "annualPropertyTax"
          ]
        },
        {
          "required": [
            "propertyTaxRate"
          ]
        }
      ]
    },
    {
      "oneOf": [
        {
          "required": [
            "annualHomeInsurance"
          ]
        },
        {
          "required": [
            "monthlyHomeInsurance"
          ]
        }
      ]
    },
    {
      "oneOf": [
        {
          "required": [
            "annualMaintenance"
          ]
        },
        {
          "required": [
            "maintenanceRate"
          ]
        }
      ]
    },
    {
      "oneOf": [
        {
          "required": [
            "buyingClosingCosts"
          ]
        },
        {
          "required": [
            "buyingClosingCostsRate"
          ]
        }
      ]
    }
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/home-ownership-budget
Formula: home-ownership-budget-htcalc-719df2c0e105

Method and sources

Recurring P&I, property taxes, insurance, maintenance and HOA. Amount/rate alternatives are exclusive; typed budget inputs only.

Reviewed .