Skip to content

Mortgage · Calculation

APR from entered loan-estimate figures

Reconcile an entered fixed-rate disclosure against principal, payments, terms, prepaid finance charges and a separately supplied mortgage-insurance schedule.

Open Loan Estimate Analyzer in HT Calc

This HT Calc screen includes a Pro sample for visitors.

Example result · computedApr: 6.500030054036293 percent 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 loan-estimate-apr-check.

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/loan-estimate-apr-check";
const input = {
  "loanAmount": 200000,
  "monthlyPI": 1264.14,
  "loanTerm": 30,
  "interestRate": 6.5,
  "productType": "Fixed Rate",
  "balloonPayment": false,
  "monthlyMortgageInsurance": 0,
  "totalOriginationCharges": 0,
  "upfrontMIP": 0,
  "prepaidInterest": 0,
  "projectedPayments": [
    {
      "period": "Years 1–30",
      "mortgageInsurance": 0
    }
  ],
  "apr": 6.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/loan-estimate-apr-check' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "loanAmount": 200000,
  "monthlyPI": 1264.14,
  "loanTerm": 30,
  "interestRate": 6.5,
  "productType": "Fixed Rate",
  "balloonPayment": false,
  "monthlyMortgageInsurance": 0,
  "totalOriginationCharges": 0,
  "upfrontMIP": 0,
  "prepaidInterest": 0,
  "projectedPayments": [
    {
      "period": "Years 1–30",
      "mortgageInsurance": 0
    }
  ],
  "apr": 6.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 loan-estimate-apr-check.
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.

computedApr
6.500030054036293 percent
disclosedApr
6.5 percent
divergence
0.0000300540362934143 percentage-points
How to interpret this result
  • Estimate for regular fixed-rate installment loans with monthly payments. This contract requires entered disclosure figures and does not certify disclosure compliance.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "computedApr": 6.500030054036293,
    "disclosedApr": 6.5,
    "divergence": 0.0000300540362934143,
    "withinTolerance": true
  },
  "formulaVersion": "loan-estimate-apr-check-htcalc-719df2c0e105",
  "units": {
    "computedApr": "percent",
    "disclosedApr": "percent",
    "divergence": "percentage-points"
  },
  "assumptions": [
    "Estimate for regular fixed-rate installment loans with monthly payments. This contract requires entered disclosure figures and does not certify disclosure compliance."
  ],
  "warnings": [],
  "creditCost": 2
}

Request contract

Accepted inputs

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

FieldType, units and limits

loanAmountRequired
number

US dollars

Min 0.01 · Max 1000000000
monthlyPIRequired
number

US dollars per month

Min 0.01 · Max 100000000
loanTermRequired
integer

Whole years

Min 1 · Max 50
interestRateRequired
number

Annual note rate in percent

Min 0.001 · Max 50
productTypeRequired
stringMust equal "Fixed Rate"
balloonPaymentRequired
booleanMust equal false
monthlyMortgageInsuranceRequired
number

US dollars per month

Min 0 · Max 100000000
mortgageInsuranceMonthsOptional
integer

Whole months

Min 1 · Max 600
totalOriginationChargesRequired
number

US dollars

Min 0 · Max 1000000000
upfrontMIPRequired
number

US dollars

Min 0 · Max 1000000000
prepaidInterestRequired
number

US dollars

Min 0 · Max 1000000000
projectedPaymentsRequired
arrayMin items 0 · Max items 50
projectedPayments[].periodRequired
stringMax length 20
projectedPayments[].mortgageInsuranceRequired
number

US dollars per month

Min 0 · Max 100000000
aprOptional
number

Percent; 6.5 means 6.5%

Min 0 · Max 100
Example request body (JSON)
{
  "loanAmount": 200000,
  "monthlyPI": 1264.14,
  "loanTerm": 30,
  "interestRate": 6.5,
  "productType": "Fixed Rate",
  "balloonPayment": false,
  "monthlyMortgageInsurance": 0,
  "totalOriginationCharges": 0,
  "upfrontMIP": 0,
  "prepaidInterest": 0,
  "projectedPayments": [
    {
      "period": "Years 1–30",
      "mortgageInsurance": 0
    }
  ],
  "apr": 6.5
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "loanAmount": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "monthlyPI": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 100000000,
      "description": "US dollars per month"
    },
    "loanTerm": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Whole years"
    },
    "interestRate": {
      "type": "number",
      "minimum": 0.001,
      "maximum": 50,
      "description": "Annual note rate in percent"
    },
    "productType": {
      "type": "string",
      "const": "Fixed Rate"
    },
    "balloonPayment": {
      "type": "boolean",
      "const": false
    },
    "monthlyMortgageInsurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000000,
      "description": "US dollars per month"
    },
    "mortgageInsuranceMonths": {
      "type": "integer",
      "minimum": 1,
      "maximum": 600,
      "description": "Whole months"
    },
    "totalOriginationCharges": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "upfrontMIP": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "prepaidInterest": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "projectedPayments": {
      "type": "array",
      "minItems": 0,
      "maxItems": 50,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "period": {
            "type": "string",
            "maxLength": 20,
            "pattern": "^Years?\\s+[1-9]\\d?(?:\\s*[-–]\\s*[1-9]\\d?)?$"
          },
          "mortgageInsurance": {
            "type": "number",
            "minimum": 0,
            "maximum": 100000000,
            "description": "US dollars per month"
          }
        },
        "required": [
          "period",
          "mortgageInsurance"
        ]
      }
    },
    "apr": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 6.5 means 6.5%"
    }
  },
  "required": [
    "loanAmount",
    "monthlyPI",
    "loanTerm",
    "interestRate",
    "productType",
    "balloonPayment",
    "monthlyMortgageInsurance",
    "totalOriginationCharges",
    "upfrontMIP",
    "prepaidInterest",
    "projectedPayments"
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/loan-estimate-apr-check
Formula: loan-estimate-apr-check-htcalc-719df2c0e105

Related PDF reports