Skip to content

Mortgage rate scenarios · Calculation

Supplied mortgage rate snapshot

Compare up to 12 dated mortgage quotes and up to 60 caller-supplied observations using the same financed amount. Includes initial ARM payments and any supplied APR.

Related HT Calc tool: Rate Tracker

Rate Tracker shows market observations. This API instead compares the dated quotes and assumptions you supply.

Example result · source: Example lender rate sheet 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 supplied-rate-snapshot.

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/supplied-rate-snapshot";
const input = {
  "source": "Example lender rate sheet",
  "asOf": "2026-11-13",
  "loanAmount": 300000,
  "quotes": [
    {
      "program": "30-year fixed",
      "termYears": 30,
      "noteRatePct": 6.25,
      "quotedAprPct": 6.42,
      "basis": "observed"
    },
    {
      "program": "5/1 adjustable",
      "termYears": 30,
      "noteRatePct": 5.875,
      "basis": "modeled",
      "fixedIntroMonths": 60
    },
    {
      "program": "15-year fixed",
      "termYears": 15,
      "noteRatePct": 5.75,
      "basis": "observed"
    }
  ],
  "focusProgram": "30-year fixed",
  "history": [
    {
      "date": "2026-11-06",
      "noteRatePct": 6.375
    },
    {
      "date": "2026-11-13",
      "noteRatePct": 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/supplied-rate-snapshot' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "source": "Example lender rate sheet",
  "asOf": "2026-11-13",
  "loanAmount": 300000,
  "quotes": [
    {
      "program": "30-year fixed",
      "termYears": 30,
      "noteRatePct": 6.25,
      "quotedAprPct": 6.42,
      "basis": "observed"
    },
    {
      "program": "5/1 adjustable",
      "termYears": 30,
      "noteRatePct": 5.875,
      "basis": "modeled",
      "fixedIntroMonths": 60
    },
    {
      "program": "15-year fixed",
      "termYears": 15,
      "noteRatePct": 5.75,
      "basis": "observed"
    }
  ],
  "focusProgram": "30-year fixed",
  "history": [
    {
      "date": "2026-11-06",
      "noteRatePct": 6.375
    },
    {
      "date": "2026-11-13",
      "noteRatePct": 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 supplied-rate-snapshot.
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.

source
Example lender rate sheet
asOf
2026-11-13
loanAmount
300000 USD
How to interpret this result
  • Rates, APRs, observation dates and source names are supplied by the caller.
  • Each payment amortizes the same principal at the stated note rate over the full term; an ARM payment is the initial payment.
  • Quoted APR is a supplied figure. Payments exclude property tax, insurance, mortgage insurance and fees.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "source": "Example lender rate sheet",
    "asOf": "2026-11-13",
    "loanAmount": 300000,
    "focusProgram": "30-year fixed",
    "quotes": [
      {
        "program": "30-year fixed",
        "termYears": 30,
        "noteRatePct": 6.25,
        "quotedAprPct": 6.42,
        "basis": "observed",
        "monthlyPrincipalAndInterest": 1847.1516012792
      },
      {
        "program": "5/1 adjustable",
        "termYears": 30,
        "noteRatePct": 5.875,
        "basis": "modeled",
        "fixedIntroMonths": 60,
        "quotedAprPct": null,
        "monthlyPrincipalAndInterest": 1774.6132895203
      },
      {
        "program": "15-year fixed",
        "termYears": 15,
        "noteRatePct": 5.75,
        "basis": "observed",
        "quotedAprPct": null,
        "monthlyPrincipalAndInterest": 2491.230261059
      }
    ],
    "history": [
      {
        "date": "2026-11-06",
        "noteRatePct": 6.375,
        "monthlyPrincipalAndInterest": 1871.6096964874
      },
      {
        "date": "2026-11-13",
        "noteRatePct": 6.25,
        "monthlyPrincipalAndInterest": 1847.1516012792
      }
    ],
    "inputDigest": "64b80056847ecc721daf195a8142d2965e174bf22232b169f44ace6ec86b7608"
  },
  "formulaVersion": "htcalc-supplied-rate-snapshot-1.0.0",
  "creditCost": 2,
  "units": {
    "loanAmount": "USD",
    "monthlyPrincipalAndInterest": "USD per month",
    "noteRatePct": "annual percentage points",
    "quotedAprPct": "annual percentage points or null",
    "termYears": "years",
    "fixedIntroMonths": "months",
    "date": "YYYY-MM-DD"
  },
  "assumptions": [
    "Rates, APRs, observation dates and source names are supplied by the caller.",
    "Each payment amortizes the same principal at the stated note rate over the full term; an ARM payment is the initial payment.",
    "Quoted APR is a supplied figure. Payments exclude property tax, insurance, mortgage insurance and fees."
  ],
  "warnings": []
}

Request contract

Accepted inputs

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

FieldType, units and limits

sourceRequired
string

Name of the source whose supplied rates the caller may distribute

Min length 1 · Max length 48
asOfRequired
stringFormat: date
loanAmountRequired
number

US dollars

Max 1000000000 · Greater than 0
quotesRequired
arrayMin items 1 · Max items 12
quotes[].programRequired
stringMin length 1 · Max length 48
quotes[].termYearsRequired
integer

Whole years

Min 1 · Max 50
quotes[].noteRatePctRequired
number

Annual percent, e.g. 6.25

Min 0 · Max 100
quotes[].quotedAprPctOptional
number

Annual percent, e.g. 6.25

Min 0 · Max 100
quotes[].basisRequired
stringAllowed: "observed", "modeled"
quotes[].fixedIntroMonthsOptional
integer

For an adjustable-rate mortgage, months before the rate may reset. Omit for fixed-rate loans.

Max 9007199254740991 · Greater than 0
focusProgramRequired
stringMin length 1 · Max length 48
historyOptional
array

Observed note-rate series for the focus program only; dates ascend and end at the supplied quote

Max items 60
history[].dateRequired
stringFormat: date
history[].noteRatePctRequired
number

Annual percent, e.g. 6.25

Min 0 · Max 100
Example request body (JSON)
{
  "source": "Example lender rate sheet",
  "asOf": "2026-11-13",
  "loanAmount": 300000,
  "quotes": [
    {
      "program": "30-year fixed",
      "termYears": 30,
      "noteRatePct": 6.25,
      "quotedAprPct": 6.42,
      "basis": "observed"
    },
    {
      "program": "5/1 adjustable",
      "termYears": 30,
      "noteRatePct": 5.875,
      "basis": "modeled",
      "fixedIntroMonths": 60
    },
    {
      "program": "15-year fixed",
      "termYears": 15,
      "noteRatePct": 5.75,
      "basis": "observed"
    }
  ],
  "focusProgram": "30-year fixed",
  "history": [
    {
      "date": "2026-11-06",
      "noteRatePct": 6.375
    },
    {
      "date": "2026-11-13",
      "noteRatePct": 6.25
    }
  ]
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "minLength": 1,
      "maxLength": 48,
      "pattern": "^[\\p{L}\\p{N} .,&()'’/-]+$",
      "description": "Name of the source whose supplied rates the caller may distribute"
    },
    "asOf": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
    },
    "loanAmount": {
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "quotes": {
      "minItems": 1,
      "maxItems": 12,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "program": {
            "type": "string",
            "minLength": 1,
            "maxLength": 48,
            "pattern": "^[\\p{L}\\p{N} .,&()'’/-]+$"
          },
          "termYears": {
            "type": "integer",
            "minimum": 1,
            "maximum": 50,
            "description": "Whole years"
          },
          "noteRatePct": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Annual percent, e.g. 6.25"
          },
          "quotedAprPct": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Annual percent, e.g. 6.25"
          },
          "basis": {
            "type": "string",
            "enum": [
              "observed",
              "modeled"
            ]
          },
          "fixedIntroMonths": {
            "description": "For an adjustable-rate mortgage, months before the rate may reset. Omit for fixed-rate loans.",
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "program",
          "termYears",
          "noteRatePct",
          "basis"
        ],
        "additionalProperties": false
      }
    },
    "focusProgram": {
      "type": "string",
      "minLength": 1,
      "maxLength": 48,
      "pattern": "^[\\p{L}\\p{N} .,&()'’/-]+$"
    },
    "history": {
      "description": "Observed note-rate series for the focus program only; dates ascend and end at the supplied quote",
      "maxItems": 60,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "format": "date",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
          },
          "noteRatePct": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Annual percent, e.g. 6.25"
          }
        },
        "required": [
          "date",
          "noteRatePct"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "source",
    "asOf",
    "loanAmount",
    "quotes",
    "focusProgram"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/supplied-rate-snapshot
Formula: htcalc-supplied-rate-snapshot-1.0.0