Skip to content

Mortgage · Calculation

Pay like a lower rate

Solve for extra monthly principal that brings interest paid down to that of a target-rate loan.

Example result · status: ok 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 target-rate-paydown.

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/target-rate-paydown";
const input = {
  "loanBalance": 300000,
  "currentRate": 7,
  "targetRate": 5.5,
  "currentMonthlyPI": 1995.9074855375
};
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/target-rate-paydown' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "loanBalance": 300000,
  "currentRate": 7,
  "targetRate": 5.5,
  "currentMonthlyPI": 1995.9074855375
}
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 target-rate-paydown.
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.

status
ok
requiredMonthlyExtra
172.89 USD/month
requiredBiWeeklyExtra
79.8 USD/two weeks
How to interpret this result
  • Requires current monthly principal and interest or a remaining term. Solver uses the app’s one-dollar interest tolerance.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "status": "ok",
    "requiredMonthlyExtra": 172.89,
    "requiredBiWeeklyExtra": 79.8,
    "currentMonthlyPI": 1995.91,
    "targetMonthlyPI": 1703.37,
    "remainingTermMonths": 360,
    "baselineTotalInterest": 418526.69,
    "targetTotalInterest": 313212.12,
    "acceleratedTotalInterest": 313212.93,
    "interestSaved": 105313.77,
    "baselinePayoffMonths": 360,
    "acceleratedPayoffMonths": 283,
    "monthsSaved": 77,
    "cashFlow": {
      "monthlyTax": 0,
      "monthlyInsurance": 0,
      "monthlyMortgageInsurance": 0,
      "monthlyHoa": 0,
      "currentMonthlyTotal": 1995.91,
      "acceleratedMonthlyTotal": 2168.8,
      "firstYearEscrowTotal": 0,
      "projectedEscrowAtPayoff": 0,
      "pmiDropMonth": null
    },
    "taxAdjusted": {
      "enabled": false,
      "estimatedInterestDeductionDelta": 0,
      "estimatedAfterTaxInterestSaved": 105313.76854281093,
      "warning": ""
    },
    "warnings": []
  },
  "formulaVersion": "target-rate-paydown-htcalc-719df2c0e105",
  "units": {
    "amounts": "USD",
    "requiredMonthlyExtra": "USD/month",
    "requiredBiWeeklyExtra": "USD/two weeks",
    "monthsSaved": "months"
  },
  "assumptions": [
    "Requires current monthly principal and interest or a remaining term. Solver uses the app’s one-dollar interest tolerance."
  ],
  "warnings": [],
  "creditCost": 2
}

Request contract

Accepted inputs

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

FieldType, units and limits

loanBalanceRequired
number

US dollars

Min 0.01 · Max 1000000000
currentRateRequired
number

Annual rate in percent

Min 0 · Max 100
targetRateRequired
number

Annual rate in percent

Min 0 · Max 100
currentMonthlyPIConditional
number

US dollars per month

Min 0.01 · Max 1000000000
remainingTermMonthsConditional
integer

Whole months

Min 1 · Max 600
annualPropertyTaxOptional
number

US dollars per year

Min 0 · Max 1000000000
annualHomeInsuranceOptional
number

US dollars per year

Min 0 · Max 1000000000
monthlyMortgageInsuranceOptional
number

US dollars per month

Min 0 · Max 1000000000
monthlyHoaOptional
number

US dollars per month

Min 0 · Max 1000000000
annualEscrowGrowthRateOptional
number

Annual percentage change

Min -50 · Max 100
homeValueOptional
number

US dollars

Min 0.01 · Max 1000000000
annualHomeAppreciationRateOptional
number

Annual percentage change

Min -50 · Max 100
pmiDropLtvPercentOptional
number

Percent

Min 0.01 · Max 100
extraStartMonthOptional
integer

Whole months

Min 1 · Max 600
annualExtraPaymentOptional
number

US dollars per year

Min 0 · Max 1000000000
oneTimePrincipalPaymentOptional
number

US dollars

Min 0 · Max 1000000000
includeTaxAdjustedViewOptional
boolean
marginalTaxRateOptional
number

Percent, e.g. 5 means 5%

Min 0 · Max 100
itemizesDeductionsOptional
boolean
principalOnlyConfirmedOptional
boolean
hasPrepaymentPenaltyOptional
boolean
Example request body (JSON)
{
  "loanBalance": 300000,
  "currentRate": 7,
  "targetRate": 5.5,
  "currentMonthlyPI": 1995.9074855375
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "loanBalance": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "currentRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual rate in percent"
    },
    "targetRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual rate in percent"
    },
    "currentMonthlyPI": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "remainingTermMonths": {
      "type": "integer",
      "minimum": 1,
      "maximum": 600,
      "description": "Whole months"
    },
    "annualPropertyTax": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "annualHomeInsurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "monthlyMortgageInsurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "monthlyHoa": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "annualEscrowGrowthRate": {
      "type": "number",
      "minimum": -50,
      "maximum": 100,
      "description": "Annual percentage change"
    },
    "homeValue": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "annualHomeAppreciationRate": {
      "type": "number",
      "minimum": -50,
      "maximum": 100,
      "description": "Annual percentage change"
    },
    "pmiDropLtvPercent": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 100,
      "description": "Percent"
    },
    "extraStartMonth": {
      "type": "integer",
      "minimum": 1,
      "maximum": 600,
      "description": "Whole months"
    },
    "annualExtraPayment": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "oneTimePrincipalPayment": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "includeTaxAdjustedView": {
      "type": "boolean"
    },
    "marginalTaxRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent, e.g. 5 means 5%"
    },
    "itemizesDeductions": {
      "type": "boolean"
    },
    "principalOnlyConfirmed": {
      "type": "boolean"
    },
    "hasPrepaymentPenalty": {
      "type": "boolean"
    }
  },
  "required": [
    "loanBalance",
    "currentRate",
    "targetRate"
  ],
  "anyOf": [
    {
      "required": [
        "currentMonthlyPI"
      ]
    },
    {
      "required": [
        "remainingTermMonths"
      ]
    }
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/target-rate-paydown
Formula: target-rate-paydown-htcalc-719df2c0e105

Related PDF reports