Skip to content

Mortgage · Calculation

Compare entered Loan Estimates

Compare disclosed APR, cash to close and scheduled outlay for comparable fixed nonballoon offers. For each offer, enter the two disclosed five-year figures to see total paid less principal paid. An incomplete disclosure returns null for that offer.

Open Loan Estimate Analyzer in HT Calc

This HT Calc screen includes a Pro sample for visitors.

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 structured-loan-estimate-comparison.

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/structured-loan-estimate-comparison";
const input = {
  "offers": [
    {
      "loanAmount": 200000,
      "loanTerm": 30,
      "loanPurpose": "purchase",
      "loanType": "conventional",
      "productType": "fixed",
      "balloonPayment": false,
      "monthlyPI": 1200,
      "totalClosingCostsDI": 5000,
      "closingCostsBasis": "gross",
      "lenderCredits": 1000,
      "estimatedCashToClose": 34000,
      "apr": 6.125
    },
    {
      "loanAmount": 200000,
      "loanTerm": 30,
      "loanPurpose": "purchase",
      "loanType": "conventional",
      "productType": "fixed",
      "balloonPayment": false,
      "monthlyPI": 1220,
      "totalClosingCostsDI": 2500,
      "closingCostsBasis": "net",
      "lenderCredits": 800,
      "estimatedCashToClose": 32500,
      "apr": 6.25
    }
  ]
};
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/structured-loan-estimate-comparison' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "offers": [
    {
      "loanAmount": 200000,
      "loanTerm": 30,
      "loanPurpose": "purchase",
      "loanType": "conventional",
      "productType": "fixed",
      "balloonPayment": false,
      "monthlyPI": 1200,
      "totalClosingCostsDI": 5000,
      "closingCostsBasis": "gross",
      "lenderCredits": 1000,
      "estimatedCashToClose": 34000,
      "apr": 6.125
    },
    {
      "loanAmount": 200000,
      "loanTerm": 30,
      "loanPurpose": "purchase",
      "loanType": "conventional",
      "productType": "fixed",
      "balloonPayment": false,
      "monthlyPI": 1220,
      "totalClosingCostsDI": 2500,
      "closingCostsBasis": "net",
      "lenderCredits": 800,
      "estimatedCashToClose": 32500,
      "apr": 6.25
    }
  ]
}
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 structured-loan-estimate-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.

How to interpret this result
  • Offer indices follow request order, starting at zero. All ties are listed.
  • Compare the same purpose, program, term and whole-dollar loan amount. Use offers requiring cash to close (including zero).
  • Outlay includes scheduled principal and interest plus net closing costs; excludes recurring escrow, insurance and resale proceeds.
  • When page 3 figures are supplied, borrowing cost subtracts principal paid from total paid at displayed cents. A missing or conflicting pair yields null. Scheduled-outlay rankings retain their separate basis.
{
  "status": "available",
  "result": {
    "comparable": true,
    "reason": null,
    "rankings": [
      {
        "category": "lowest-5yr",
        "lowestOfferIndices": [
          1
        ],
        "differenceFromRunnerUp": 300,
        "unit": "USD"
      },
      {
        "category": "lowest-life",
        "lowestOfferIndices": [
          0
        ],
        "differenceFromRunnerUp": 5700,
        "unit": "USD"
      },
      {
        "category": "lowest-cash-to-close",
        "lowestOfferIndices": [
          1
        ],
        "differenceFromRunnerUp": 1500,
        "unit": "USD"
      },
      {
        "category": "lowest-apr",
        "lowestOfferIndices": [
          0
        ],
        "differenceFromRunnerUp": 0.125,
        "unit": "percentage points"
      }
    ]
  },
  "formulaVersion": "structured-loan-estimate-comparison-htcalc-719df2c0e105",
  "units": {
    "rankings[].differenceFromRunnerUp": "USD or percentage points, specified by rankings[].unit"
  },
  "assumptions": [
    "Offer indices follow request order, starting at zero. All ties are listed.",
    "Compare the same purpose, program, term and whole-dollar loan amount. Use offers requiring cash to close (including zero).",
    "Outlay includes scheduled principal and interest plus net closing costs; excludes recurring escrow, insurance and resale proceeds.",
    "When page 3 figures are supplied, borrowing cost subtracts principal paid from total paid at displayed cents. A missing or conflicting pair yields null. Scheduled-outlay rankings retain their separate basis."
  ],
  "warnings": [],
  "creditCost": 2
}

Request contract

Accepted inputs

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

FieldType, units and limits

offersRequired
arrayMin items 2 · Max items 5
offers[].loanAmountRequired
numberMin 0.01 · Max 100000000
offers[].loanTermRequired
integerMin 1 · Max 40
offers[].loanPurposeRequired
stringAllowed: "purchase", "refinance"
offers[].loanTypeRequired
stringAllowed: "conventional", "fha", "va", "usda"
offers[].productTypeRequired
stringAllowed: "fixed", "arm", "interest-only", "balloon"
offers[].balloonPaymentRequired
boolean
offers[].monthlyPIRequired
numberMin 0.01 · Max 1000000
offers[].totalClosingCostsDIRequired
number

Total closing costs on the selected gross or net basis.

Min -100000000 · Max 100000000
offers[].closingCostsBasisRequired
stringAllowed: "net", "gross"
offers[].lenderCreditsRequired
number

Enter the positive credit amount. A net total already includes this credit.

Min 0 · Max 100000000
offers[].estimatedCashToCloseRequired
numberMin 0 · Max 100000000
offers[].aprRequired
numberMin 0 · Max 100
offers[].inFiveYearsTotalOptional
number

Manually entered five-year figure from Loan Estimate page 3, in dollars.

Min 0 · Max 1000000000
offers[].inFiveYearsPrincipalOptional
number

Manually entered five-year figure from Loan Estimate page 3, in dollars.

Min 0 · Max 1000000000
Example request body (JSON)
{
  "offers": [
    {
      "loanAmount": 200000,
      "loanTerm": 30,
      "loanPurpose": "purchase",
      "loanType": "conventional",
      "productType": "fixed",
      "balloonPayment": false,
      "monthlyPI": 1200,
      "totalClosingCostsDI": 5000,
      "closingCostsBasis": "gross",
      "lenderCredits": 1000,
      "estimatedCashToClose": 34000,
      "apr": 6.125
    },
    {
      "loanAmount": 200000,
      "loanTerm": 30,
      "loanPurpose": "purchase",
      "loanType": "conventional",
      "productType": "fixed",
      "balloonPayment": false,
      "monthlyPI": 1220,
      "totalClosingCostsDI": 2500,
      "closingCostsBasis": "net",
      "lenderCredits": 800,
      "estimatedCashToClose": 32500,
      "apr": 6.25
    }
  ]
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "offers": {
      "type": "array",
      "minItems": 2,
      "maxItems": 5,
      "items": {
        "type": "object",
        "properties": {
          "loanAmount": {
            "type": "number",
            "minimum": 0.01,
            "maximum": 100000000
          },
          "loanTerm": {
            "type": "integer",
            "minimum": 1,
            "maximum": 40
          },
          "loanPurpose": {
            "type": "string",
            "enum": [
              "purchase",
              "refinance"
            ]
          },
          "loanType": {
            "type": "string",
            "enum": [
              "conventional",
              "fha",
              "va",
              "usda"
            ]
          },
          "productType": {
            "type": "string",
            "enum": [
              "fixed",
              "arm",
              "interest-only",
              "balloon"
            ]
          },
          "balloonPayment": {
            "type": "boolean"
          },
          "monthlyPI": {
            "type": "number",
            "minimum": 0.01,
            "maximum": 1000000
          },
          "totalClosingCostsDI": {
            "type": "number",
            "minimum": -100000000,
            "maximum": 100000000,
            "description": "Total closing costs on the selected gross or net basis."
          },
          "closingCostsBasis": {
            "type": "string",
            "enum": [
              "net",
              "gross"
            ]
          },
          "lenderCredits": {
            "type": "number",
            "minimum": 0,
            "maximum": 100000000,
            "description": "Enter the positive credit amount. A net total already includes this credit."
          },
          "estimatedCashToClose": {
            "type": "number",
            "minimum": 0,
            "maximum": 100000000
          },
          "apr": {
            "type": "number",
            "minimum": 0,
            "maximum": 100
          },
          "inFiveYearsTotal": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "Manually entered five-year figure from Loan Estimate page 3, in dollars."
          },
          "inFiveYearsPrincipal": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "Manually entered five-year figure from Loan Estimate page 3, in dollars."
          }
        },
        "required": [
          "loanAmount",
          "loanTerm",
          "loanPurpose",
          "loanType",
          "productType",
          "balloonPayment",
          "monthlyPI",
          "totalClosingCostsDI",
          "closingCostsBasis",
          "lenderCredits",
          "estimatedCashToClose",
          "apr"
        ],
        "additionalProperties": false,
        "allOf": [
          {
            "if": {
              "properties": {
                "closingCostsBasis": {
                  "const": "gross"
                }
              }
            },
            "then": {
              "properties": {
                "totalClosingCostsDI": {
                  "minimum": 0
                }
              }
            }
          }
        ]
      }
    }
  },
  "required": [
    "offers"
  ],
  "additionalProperties": false
}

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

Related PDF reports