Skip to content

Mortgage · Calculation

HELOC draw and repayment

Model a fully drawn line through the interest-only period and amortized repayment, including stress rates, extra payments and fees.

Open HELOC Calculator in HT Calc

This HT Calc screen includes a Plus sample for visitors.

Example result · maxCreditLine: 132500 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 heloc-draw-and-repayment.

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/heloc-draw-and-repayment";
const input = {
  "homeValue": 450000,
  "mortgageBalance": 250000,
  "ltv": 85,
  "drawAmount": 50000,
  "interestRate": 9,
  "drawPeriod": 10,
  "repaymentPeriod": 20,
  "extraPayment": 0,
  "indexRate": 5.5,
  "rateMargin": 3.5,
  "rateCap": 18,
  "annualFee": 75,
  "closingCosts": 500
};
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/heloc-draw-and-repayment' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "homeValue": 450000,
  "mortgageBalance": 250000,
  "ltv": 85,
  "drawAmount": 50000,
  "interestRate": 9,
  "drawPeriod": 10,
  "repaymentPeriod": 20,
  "extraPayment": 0,
  "indexRate": 5.5,
  "rateMargin": 3.5,
  "rateCap": 18,
  "annualFee": 75,
  "closingCosts": 500
}
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 heloc-draw-and-repayment.
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.

maxCreditLine
132500
interestOnlyPayment
375 USD/month
pAndIPayment
449.8629779251 USD/month
How to interpret this result
  • The entire draw remains outstanding throughout the draw period. The caller supplies the index and rate assumptions.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "maxCreditLine": 132500,
    "requestedDrawWithinLine": true,
    "interestOnlyPayment": 375,
    "pAndIPayment": 449.8629779251,
    "totalDrawInterest": 45000,
    "repaymentInterest": 57968.18,
    "totalInterest": 102968.18,
    "repaymentMonths": 240,
    "endingBalance": 0,
    "repaymentStatus": "paid-off",
    "extraResults": null,
    "indexedRate": 9,
    "modeledRate": 9,
    "stressInterestOnlyPayment": 375,
    "stressPAndIPayment": 449.8629779251,
    "totalFees": 2750,
    "totalCostWithFees": 105718.18,
    "drawBalanceAssumption": "full-draw-outstanding"
  },
  "formulaVersion": "heloc-draw-and-repayment-htcalc-719df2c0e105",
  "units": {
    "amounts": "USD",
    "interestOnlyPayment": "USD/month",
    "pAndIPayment": "USD/month",
    "repaymentMonths": "months",
    "indexedRate": "annual percent",
    "modeledRate": "annual percent"
  },
  "assumptions": [
    "The entire draw remains outstanding throughout the draw period. The caller supplies the index and rate 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

homeValueRequired
number

US dollars

Min 0.01 · Max 1000000000
mortgageBalanceRequired
number

US dollars

Min 0 · Max 1000000000
ltvRequired
number

Percent

Min 0.01 · Max 100
drawAmountRequired
number

US dollars

Min 0 · Max 1000000000
interestRateRequired
number

Annual rate in percent

Min 0 · Max 100
drawPeriodRequired
number

Years, rounded to the nearest month

Min 0 · Max 50
repaymentPeriodRequired
number

Years, rounded to the nearest month

Min 0.08333333333333333 · Max 50
extraPaymentRequired
number

US dollars per month

Min 0 · Max 1000000000
indexRateRequired
number

Annual rate in percent

Min 0 · Max 100
rateMarginRequired
number

Percent, e.g. 5 means 5%

Min 0 · Max 100
rateCapRequired
number

Annual rate in percent

Min 0 · Max 100
annualFeeRequired
number

US dollars per year

Min 0 · Max 1000000000
closingCostsRequired
number

US dollars

Min 0 · Max 1000000000
Example request body (JSON)
{
  "homeValue": 450000,
  "mortgageBalance": 250000,
  "ltv": 85,
  "drawAmount": 50000,
  "interestRate": 9,
  "drawPeriod": 10,
  "repaymentPeriod": 20,
  "extraPayment": 0,
  "indexRate": 5.5,
  "rateMargin": 3.5,
  "rateCap": 18,
  "annualFee": 75,
  "closingCosts": 500
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "homeValue": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "mortgageBalance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "ltv": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 100,
      "description": "Percent"
    },
    "drawAmount": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "interestRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual rate in percent"
    },
    "drawPeriod": {
      "type": "number",
      "minimum": 0,
      "maximum": 50,
      "description": "Years, rounded to the nearest month"
    },
    "repaymentPeriod": {
      "type": "number",
      "minimum": 0.08333333333333333,
      "maximum": 50,
      "description": "Years, rounded to the nearest month"
    },
    "extraPayment": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "indexRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual rate in percent"
    },
    "rateMargin": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent, e.g. 5 means 5%"
    },
    "rateCap": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual rate in percent"
    },
    "annualFee": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "closingCosts": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    }
  },
  "required": [
    "homeValue",
    "mortgageBalance",
    "ltv",
    "drawAmount",
    "interestRate",
    "drawPeriod",
    "repaymentPeriod",
    "extraPayment",
    "indexRate",
    "rateMargin",
    "rateCap",
    "annualFee",
    "closingCosts"
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/heloc-draw-and-repayment
Formula: heloc-draw-and-repayment-htcalc-719df2c0e105

Related PDF reports