Skip to content

Loans · Calculation

Refinance comparison

Compare payment changes, closing costs and break-even time.

Example result · current.totalInterest: 0 See output

Cost per success
2 calculation credits
Production plans
Standard, Business, Scale, Enterprise
Plan allowances
Free sandbox
Available · see example

Integration example

Make a request

Use a free sandbox key scoped to refinance-comparison. New developer? Create a workspace and register an application to issue your key.

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

Free sandbox request

Set HT_SANDBOX_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_SANDBOX_KEY;
if (!key) throw new Error("Set HT_SANDBOX_KEY on your server.");
const endpoint = "https://sandbox.hasstechapi.com/v2/calc/refinance-comparison";
const input = {
  "currentBalance": 100,
  "currentRate": 0,
  "remainingMonths": 12,
  "newRate": 0,
  "newMonths": 12,
  "closingCosts": 100
};
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_SANDBOX_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_SANDBOX_KEY:?Set HT_SANDBOX_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://sandbox.hasstechapi.com/v2/calc/refinance-comparison' \
    --header "Authorization: Bearer $HT_SANDBOX_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "currentBalance": 100,
  "currentRate": 0,
  "remainingMonths": 12,
  "newRate": 0,
  "newMonths": 12,
  "closingCosts": 100
}
HT_INPUT
)
Production request

Run in production

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/refinance-comparison";
const input = {
  "currentBalance": 100,
  "currentRate": 0,
  "remainingMonths": 12,
  "newRate": 0,
  "newMonths": 12,
  "closingCosts": 100
};
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/refinance-comparison' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "currentBalance": 100,
  "currentRate": 0,
  "remainingMonths": 12,
  "newRate": 0,
  "newMonths": 12,
  "closingCosts": 100
}
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 refinance-comparison.
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.

current.totalInterest
0
current.totalPrincipal
100
current.monthsToPayoff
12

Result warnings

  • No payment-savings break-even: monthly savings are not positive.
How to interpret this result
  • Monthly nominal annual rate / 12; no taxes or fees.
  • Canonical Decimal 20 significant digits, half-even, cent-reseed schedule; adjusted final payment at stated term.
  • Totals retain canonical aggregate rounding; sum of individually rounded interest rows can differ by cents.
  • Closing costs paid upfront, not financed; simple payment-savings break-even ignores time value and term mismatch.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "current": {
      "schedule": [
        {
          "month": 1,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 91.67
        },
        {
          "month": 2,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 83.34
        },
        {
          "month": 3,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 75.01
        },
        {
          "month": 4,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 66.68
        },
        {
          "month": 5,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 58.35
        },
        {
          "month": 6,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 50.02
        },
        {
          "month": 7,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 41.69
        },
        {
          "month": 8,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 33.36
        },
        {
          "month": 9,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 25.03
        },
        {
          "month": 10,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 16.7
        },
        {
          "month": 11,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 8.37
        },
        {
          "month": 12,
          "interest": 0,
          "principal": 8.37,
          "remainingBalance": 0
        }
      ],
      "totalInterest": 0,
      "totalPrincipal": 100,
      "monthsToPayoff": 12,
      "remainingBalance": 0,
      "payable": true,
      "monthlyPayment": 8.3333333333,
      "finalPayment": 8.37,
      "totalPayments": 100
    },
    "refinanced": {
      "schedule": [
        {
          "month": 1,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 91.67
        },
        {
          "month": 2,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 83.34
        },
        {
          "month": 3,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 75.01
        },
        {
          "month": 4,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 66.68
        },
        {
          "month": 5,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 58.35
        },
        {
          "month": 6,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 50.02
        },
        {
          "month": 7,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 41.69
        },
        {
          "month": 8,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 33.36
        },
        {
          "month": 9,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 25.03
        },
        {
          "month": 10,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 16.7
        },
        {
          "month": 11,
          "interest": 0,
          "principal": 8.33,
          "remainingBalance": 8.37
        },
        {
          "month": 12,
          "interest": 0,
          "principal": 8.37,
          "remainingBalance": 0
        }
      ],
      "totalInterest": 0,
      "totalPrincipal": 100,
      "monthsToPayoff": 12,
      "remainingBalance": 0,
      "payable": true,
      "monthlyPayment": 8.3333333333,
      "finalPayment": 8.37,
      "totalPayments": 100
    },
    "monthlySavings": 0,
    "breakEvenMonths": null,
    "lifetimeSavings": -100
  },
  "formulaVersion": "refinance-comparison-1.0.0",
  "units": {
    "current/refinanced": "loan schedule (USD, months)",
    "monthlySavings": "USD/month",
    "breakEvenMonths": "months",
    "lifetimeSavings": "USD"
  },
  "assumptions": [
    "Monthly nominal annual rate / 12; no taxes or fees.",
    "Canonical Decimal 20 significant digits, half-even, cent-reseed schedule; adjusted final payment at stated term.",
    "Totals retain canonical aggregate rounding; sum of individually rounded interest rows can differ by cents.",
    "Closing costs paid upfront, not financed; simple payment-savings break-even ignores time value and term mismatch."
  ],
  "warnings": [
    "No payment-savings break-even: monthly savings are not positive."
  ],
  "creditCost": 2
}

Request contract

Accepted inputs

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

FieldType, units and limits

currentBalanceRequired
number · USD

Outstanding principal on the current loan.

Min 0 · Max 1000000000 · Step 0.01
currentRateRequired
number · percentage-points

Annual interest rate on the current loan. Enter 6.5 for 6.5%.

Min 0 · Max 100 · Step 1e-9
remainingMonthsRequired
integer · months

Whole months remaining on the current loan.

Min 1 · Max 600
newRateRequired
number · percentage-points

Annual interest rate on the replacement loan. Enter 6.5 for 6.5%.

Min 0 · Max 100 · Step 1e-9
newMonthsRequired
integer · months

Term of the replacement loan in whole months.

Min 1 · Max 600
closingCostsRequired
number · USD

One-time refinance closing costs.

Min 0 · Max 1000000000 · Step 0.01
Example request body (JSON)
{
  "currentBalance": 100,
  "currentRate": 0,
  "remainingMonths": 12,
  "newRate": 0,
  "newMonths": 12,
  "closingCosts": 100
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "currentBalance": {
      "type": "number",
      "description": "Outstanding principal on the current loan.",
      "x-unit": "USD",
      "minimum": 0,
      "maximum": 1000000000,
      "multipleOf": 0.01,
      "x-core-refinement": true
    },
    "currentRate": {
      "type": "number",
      "description": "Annual interest rate on the current loan. Enter 6.5 for 6.5%.",
      "x-unit": "percentage-points",
      "minimum": 0,
      "maximum": 100,
      "multipleOf": 1e-9,
      "x-core-refinement": true
    },
    "remainingMonths": {
      "type": "integer",
      "description": "Whole months remaining on the current loan.",
      "x-unit": "months",
      "minimum": 1,
      "maximum": 600
    },
    "newRate": {
      "type": "number",
      "description": "Annual interest rate on the replacement loan. Enter 6.5 for 6.5%.",
      "x-unit": "percentage-points",
      "minimum": 0,
      "maximum": 100,
      "multipleOf": 1e-9,
      "x-core-refinement": true
    },
    "newMonths": {
      "type": "integer",
      "description": "Term of the replacement loan in whole months.",
      "x-unit": "months",
      "minimum": 1,
      "maximum": 600
    },
    "closingCosts": {
      "type": "number",
      "description": "One-time refinance closing costs.",
      "x-unit": "USD",
      "minimum": 0,
      "maximum": 1000000000,
      "multipleOf": 0.01,
      "x-core-refinement": true
    }
  },
  "required": [
    "currentBalance",
    "currentRate",
    "remainingMonths",
    "newRate",
    "newMonths",
    "closingCosts"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/refinance-comparison
Formula: refinance-comparison-1.0.0

Related PDF reports