Skip to content

Financial Hub · Calculation

Loan benchmark at origination

Compares a mortgage note rate or an opening HELOC benchmark against dated observations provided by the caller.

Open Financial Hub in HT Calc

Visitors can explore a sample snapshot. Saved accounts, loans and properties open within the member’s own Financial Hub.

Example result · comparison.kind: mortgage See output

Cost per success
1 calculation credit
Production plans
Standard, Business, Scale, Enterprise
Plan allowances
Free sandbox
Not available

Integration example

Make a request

Use a production key scoped to financial-hub-loan-market-at-start.

Keep the key on your server. A successful call uses 1 calculation credit.

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/financial-hub-loan-market-at-start";
const input = {
  "kind": "mortgage",
  "termMonths": 180,
  "rate": 6,
  "startDate": "2026-03-09",
  "asOfDate": "2026-04-01",
  "then": {
    "date": "2026-03-06",
    "value": 5
  },
  "latest": {
    "observationDate": "2026-03-31",
    "value": 7,
    "stale": false
  }
};
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/financial-hub-loan-market-at-start' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "kind": "mortgage",
  "termMonths": 180,
  "rate": 6,
  "startDate": "2026-03-09",
  "asOfDate": "2026-04-01",
  "then": {
    "date": "2026-03-06",
    "value": 5
  },
  "latest": {
    "observationDate": "2026-03-31",
    "value": 7,
    "stale": false
  }
}
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 financial-hub-loan-market-at-start.
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.

comparison.kind
mortgage
comparison.termLabel
15-year
comparison.startMonth
Mar 2026
How to interpret this result
  • Mortgage benchmark is 15-year for an entered term up to 180 months, otherwise 30-year. A starting observation must be on or within seven days before origination. The latest observation is omitted when marked stale.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "comparison": {
      "kind": "mortgage",
      "termLabel": "15-year",
      "startMonth": "Mar 2026",
      "startDate": "2026-03-09",
      "thenDate": "2026-03-06",
      "then": 5,
      "mine": 6,
      "gapThen": 1,
      "today": 7,
      "todayDate": "2026-03-31",
      "gapToday": 1
    }
  },
  "formulaVersion": "financial-hub-loan-market-at-start-1.0.0",
  "units": {
    "then": "percent",
    "today": "percent",
    "gapThen": "percentage points",
    "gapToday": "percentage points",
    "move": "percentage points"
  },
  "assumptions": [
    "Mortgage benchmark is 15-year for an entered term up to 180 months, otherwise 30-year. A starting observation must be on or within seven days before origination. The latest observation is omitted when marked stale."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

kindRequired
string

Benchmark comparison mode.

Allowed: "mortgage", "heloc"
termMonthsOptional
integer

Original mortgage term (whole months).

Min 1 · Max 1200
rateOptional
number

Mortgage note rate (percentage points, up to six decimals).

Min 0 · Max 100 · Step 0.000001
startDateRequired
string

Loan origination date

Format: date · Min length 10 · Max length 10
asOfDateRequired
string

Comparison date

Format: date · Min length 10 · Max length 10
thenRequired
object
then.dateRequired
string

Observation date of caller-supplied starting benchmark.

Format: date · Min length 10 · Max length 10
then.valueRequired
number

Starting benchmark rate (percentage points, up to six decimals).

Min 0 · Max 100 · Step 0.000001
latestOptional
object
latest.observationDateRequired
string

Date of caller-supplied later benchmark.

Format: date · Min length 10 · Max length 10
latest.valueRequired
number

Later benchmark rate (percentage points, up to six decimals).

Min 0 · Max 100 · Step 0.000001
latest.staleRequired
boolean

Whether this later observation is stale as of asOfDate under the caller’s source freshness test.

Example request body (JSON)
{
  "kind": "mortgage",
  "termMonths": 180,
  "rate": 6,
  "startDate": "2026-03-09",
  "asOfDate": "2026-04-01",
  "then": {
    "date": "2026-03-06",
    "value": 5
  },
  "latest": {
    "observationDate": "2026-03-31",
    "value": 7,
    "stale": false
  }
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "description": "Benchmark comparison mode.",
      "enum": [
        "mortgage",
        "heloc"
      ]
    },
    "termMonths": {
      "type": "integer",
      "description": "Original mortgage term (whole months).",
      "minimum": 1,
      "maximum": 1200
    },
    "rate": {
      "type": "number",
      "description": "Mortgage note rate (percentage points, up to six decimals).",
      "minimum": 0,
      "maximum": 100,
      "multipleOf": 0.000001
    },
    "startDate": {
      "type": "string",
      "description": "Loan origination date",
      "format": "date",
      "minLength": 10,
      "maxLength": 10,
      "pattern": "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$"
    },
    "asOfDate": {
      "type": "string",
      "description": "Comparison date",
      "format": "date",
      "minLength": 10,
      "maxLength": 10,
      "pattern": "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$"
    },
    "then": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Observation date of caller-supplied starting benchmark.",
          "format": "date",
          "minLength": 10,
          "maxLength": 10,
          "pattern": "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$"
        },
        "value": {
          "type": "number",
          "description": "Starting benchmark rate (percentage points, up to six decimals).",
          "minimum": 0,
          "maximum": 100,
          "multipleOf": 0.000001
        }
      },
      "required": [
        "date",
        "value"
      ],
      "additionalProperties": false
    },
    "latest": {
      "type": "object",
      "properties": {
        "observationDate": {
          "type": "string",
          "description": "Date of caller-supplied later benchmark.",
          "format": "date",
          "minLength": 10,
          "maxLength": 10,
          "pattern": "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$"
        },
        "value": {
          "type": "number",
          "description": "Later benchmark rate (percentage points, up to six decimals).",
          "minimum": 0,
          "maximum": 100,
          "multipleOf": 0.000001
        },
        "stale": {
          "type": "boolean",
          "description": "Whether this later observation is stale as of asOfDate under the caller’s source freshness test."
        }
      },
      "required": [
        "observationDate",
        "value",
        "stale"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "kind",
    "startDate",
    "asOfDate",
    "then"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/financial-hub-loan-market-at-start
Formula: financial-hub-loan-market-at-start-1.0.0