Skip to content

Mortgage · Calculation

APR at an earlier payoff

Compute the effective annualized borrowing rate when an entered loan is paid off after a specified number of scheduled payments.

Example result · value: 0.00877452232143696 annual-decimal 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 mortgage-apr-at-payoff.

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/mortgage-apr-at-payoff";
const input = {
  "input": {
    "loanAmount": 120000,
    "annualRatePct": 0,
    "termMonths": 120,
    "monthlyPayment": 1000,
    "fees": 1000
  },
  "months": 12
};
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/mortgage-apr-at-payoff' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "input": {
    "loanAmount": 120000,
    "annualRatePct": 0,
    "termMonths": 120,
    "monthlyPayment": 1000,
    "fees": 1000
  },
  "months": 12
}
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 mortgage-apr-at-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.

value
0.00877452232143696 annual-decimal
How to interpret this result
  • The balance is paid at the selected horizon. Result is an annual rate expressed as a fraction.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "value": 0.00877452232143696
  },
  "formulaVersion": "mortgage-apr-at-payoff-htcalc-719df2c0e105",
  "units": {
    "value": "annual-decimal"
  },
  "assumptions": [
    "The balance is paid at the selected horizon. Result is an annual rate expressed as a fraction."
  ],
  "warnings": [],
  "creditCost": 2
}

Request contract

Accepted inputs

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

FieldType, units and limits

inputRequired
object
input.loanAmountRequired
number

US dollars

Min 0.01 · Max 1000000000
input.annualRatePctRequired
number

Annual interest in percent (5 means 5%)

Min 0 · Max 50
input.termMonthsRequired
integer

Whole months

Min 1 · Max 600
input.monthlyPaymentRequired
number

Monthly principal and interest in USD

Min 0.01 · Max 1000000000
input.feesRequired
number

US dollars

Min 0 · Max 1000000000
monthsRequired
integer

Whole months

Min 1 · Max 600
Example request body (JSON)
{
  "input": {
    "loanAmount": 120000,
    "annualRatePct": 0,
    "termMonths": 120,
    "monthlyPayment": 1000,
    "fees": 1000
  },
  "months": 12
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "input": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "loanAmount": {
          "type": "number",
          "minimum": 0.01,
          "maximum": 1000000000,
          "description": "US dollars"
        },
        "annualRatePct": {
          "type": "number",
          "minimum": 0,
          "maximum": 50,
          "description": "Annual interest in percent (5 means 5%)"
        },
        "termMonths": {
          "type": "integer",
          "minimum": 1,
          "maximum": 600,
          "description": "Whole months"
        },
        "monthlyPayment": {
          "type": "number",
          "minimum": 0.01,
          "maximum": 1000000000,
          "description": "Monthly principal and interest in USD"
        },
        "fees": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "US dollars"
        }
      },
      "required": [
        "loanAmount",
        "annualRatePct",
        "termMonths",
        "monthlyPayment",
        "fees"
      ]
    },
    "months": {
      "type": "integer",
      "minimum": 1,
      "maximum": 600,
      "description": "Whole months"
    }
  },
  "required": [
    "input",
    "months"
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/mortgage-apr-at-payoff
Formula: mortgage-apr-at-payoff-htcalc-719df2c0e105