Skip to content

Financial Hub · Calculation

Home payoff and projected equity

Compares principal and interest with an extra monthly payment and projects annual equity using the entered appreciation rate.

Open Financial Hub in HT Calc

Visitors can explore a sample snapshot. Saved accounts, loans and properties open within the member’s own Financial Hub.

Example result · basis: ready 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 financial-hub-home-payoff.

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/financial-hub-home-payoff";
const input = {
  "value": 2000,
  "balance": 1000,
  "rate": 12,
  "principalInterest": 510,
  "secondBalance": 100,
  "extra": 500,
  "appreciationPct": 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/financial-hub-home-payoff' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "value": 2000,
  "balance": 1000,
  "rate": 12,
  "principalInterest": 510,
  "secondBalance": 100,
  "extra": 500,
  "appreciationPct": 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 financial-hub-home-payoff.
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.

basis
ready
payment
510
paymentSource
on_file
How to interpret this result
  • Other liens remain constant. The Hub requires a positive rate. A walk still unpaid at the 1,200-month safety cap has no payoff date or lifetime interest.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "basis": "ready",
    "payment": 510,
    "paymentSource": "on_file",
    "base": {
      "paysOff": true,
      "months": 2,
      "interest": 15
    },
    "accelerated": {
      "paysOff": true,
      "months": 1,
      "interest": 10
    },
    "monthsSaved": 1,
    "interestSaved": 5,
    "printedInterestSaved": 5,
    "equityByYear": [
      {
        "year": 0,
        "value": 2000,
        "balance": 1000,
        "owed": 1100,
        "equity": 900,
        "printed": {
          "value": 2000,
          "owed": 1100,
          "equity": 900
        }
      },
      {
        "year": 1,
        "value": 2100,
        "balance": 0,
        "owed": 100,
        "equity": 2000,
        "printed": {
          "value": 2100,
          "owed": 100,
          "equity": 2000
        }
      }
    ]
  },
  "formulaVersion": "financial-hub-home-payoff-1.0.0",
  "units": {
    "money": "USD",
    "monthsSaved": "months",
    "appreciationPct": "percent per year"
  },
  "assumptions": [
    "Other liens remain constant. The Hub requires a positive rate. A walk still unpaid at the 1,200-month safety cap has no payoff date or lifetime interest."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

valueOptional
number

Current home value (USD, to the cent).

Min 0.01 · Max 10000000000 · Step 0.01
balanceRequired
number

Current first mortgage balance (USD, to the cent).

Min 0 · Max 10000000000 · Step 0.01
secondBalanceOptional
number

Combined other liens (USD, to the cent).

Min 0 · Max 10000000000 · Step 0.01
rateOptional
number

Annual note rate (percentage points, up to six decimals).

Min 0 · Max 100 · Step 0.000001
principalInterestOptional
number

First mortgage principal and interest per month (USD, to the cent).

Min 0 · Max 10000000000 · Step 0.01
yearsLeftOptional
number

Years remaining if monthly principal and interest is unknown.

Min 0.08333333333333333 · Max 100
extraOptional
number

Extra principal per month (USD, to the cent).

Min 0 · Max 10000000000 · Step 0.01
appreciationPctOptional
number

Annual compounded change in home value (percent).

Min -100 · Max 100
Example request body (JSON)
{
  "value": 2000,
  "balance": 1000,
  "rate": 12,
  "principalInterest": 510,
  "secondBalance": 100,
  "extra": 500,
  "appreciationPct": 5
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number",
      "description": "Current home value (USD, to the cent).",
      "minimum": 0.01,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "balance": {
      "type": "number",
      "description": "Current first mortgage balance (USD, to the cent).",
      "minimum": 0,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "secondBalance": {
      "type": "number",
      "description": "Combined other liens (USD, to the cent).",
      "minimum": 0,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "rate": {
      "type": "number",
      "description": "Annual note rate (percentage points, up to six decimals).",
      "minimum": 0,
      "maximum": 100,
      "multipleOf": 0.000001
    },
    "principalInterest": {
      "type": "number",
      "description": "First mortgage principal and interest per month (USD, to the cent).",
      "minimum": 0,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "yearsLeft": {
      "type": "number",
      "description": "Years remaining if monthly principal and interest is unknown.",
      "minimum": 0.08333333333333333,
      "maximum": 100
    },
    "extra": {
      "type": "number",
      "description": "Extra principal per month (USD, to the cent).",
      "minimum": 0,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "appreciationPct": {
      "type": "number",
      "description": "Annual compounded change in home value (percent).",
      "minimum": -100,
      "maximum": 100
    }
  },
  "required": [
    "balance"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/financial-hub-home-payoff
Formula: financial-hub-home-payoff-1.0.0