Skip to content

Financial Hub · Calculation

Debt APR and supplied rate comparison

Compare a debt and a caller-supplied comparable APR using the same balance and monthly payment.

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.

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-quoted-rate-comparison.

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-quoted-rate-comparison";
const input = {
  "accounts": [
    {
      "id": "auto",
      "name": "Car",
      "account_type": "auto_loan",
      "current_balance": 1000,
      "apr": 12,
      "monthly_payment": 600
    }
  ],
  "marketRates": {
    "auto": 0,
    "sourceLabel": "Caller example at 0%"
  }
};
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-quoted-rate-comparison' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "accounts": [
    {
      "id": "auto",
      "name": "Car",
      "account_type": "auto_loan",
      "current_balance": 1000,
      "apr": 12,
      "monthly_payment": 600
    }
  ],
  "marketRates": {
    "auto": 0,
    "sourceLabel": "Caller example at 0%"
  }
}
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-quoted-rate-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
  • Caller supplies the benchmark. Fixed monthly payment and no new borrowing. Excludes closing costs. Mortgage gap threshold is 0.75 percentage point; others are 1 point.
{
  "status": "available",
  "result": {
    "comparisons": [
      {
        "id": "auto",
        "quoteType": "auto",
        "balance": 1000,
        "payment": 600,
        "apr": 12,
        "quotedApr": 0,
        "gapPercentagePoints": 12,
        "currentInterest": 14.1,
        "quotedInterest": 0,
        "interestSaved": 14.1,
        "displayedInterestSaved": 14,
        "currentMonths": 2,
        "quotedMonths": 2,
        "estimatedAnnualImpact": 85
      }
    ],
    "skipped": []
  },
  "formulaVersion": "financial-hub-insights-v1",
  "units": {
    "money": "USD",
    "rate": "percent APR",
    "duration": "months",
    "dates": "UTC date"
  },
  "assumptions": [
    "Caller supplies the benchmark. Fixed monthly payment and no new borrowing. Excludes closing costs. Mortgage gap threshold is 0.75 percentage point; others are 1 point."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

accountsRequired
array

Caller-provided balance records. Maximum 8 active amortizable debt accounts per modeled debt request.

Max items 16
accounts[].idRequired
string

Caller reference; use an opaque account or service identifier.

Min length 1 · Max length 80
accounts[].nameOptional
string

Optional generic display label.

Min length 1 · Max length 100
accounts[].account_typeRequired
string

Financial Hub account classification.

Allowed: "checking", "savings", "cash", "credit_card", "mortgage", "auto_loan", "student_loan", "personal_loan", "loan", "investment", "retirement", "heloc", "home_equity_loan", "money_market", "cd", "crypto", "property", "vehicle", "collectible", "business_interest", "other"
accounts[].current_balanceRequired
number

USD balance. Liabilities use positive amounts owed.

Min -10000000000 · Max 10000000000
accounts[].aprOptional
number or null
accounts[].monthly_paymentOptional
number or null
accounts[].minimum_paymentOptional
number or null
accounts[].term_monthsOptional
integer or null
accounts[].is_archivedOptional
boolean

Exclude archived accounts. Defaults to false.

marketRatesRequired
object
marketRates.mortgage30Optional
number or null
marketRates.autoOptional
number or null
marketRates.personalOptional
number or null
marketRates.creditCardOptional
number or null
marketRates.sourceLabelOptional
string

Caller label and date for the supplied benchmark.

Min length 1 · Max length 120
Example request body (JSON)
{
  "accounts": [
    {
      "id": "auto",
      "name": "Car",
      "account_type": "auto_loan",
      "current_balance": 1000,
      "apr": 12,
      "monthly_payment": 600
    }
  ],
  "marketRates": {
    "auto": 0,
    "sourceLabel": "Caller example at 0%"
  }
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Caller reference; use an opaque account or service identifier.",
            "minLength": 1,
            "maxLength": 80
          },
          "name": {
            "type": "string",
            "description": "Optional generic display label.",
            "minLength": 1,
            "maxLength": 100
          },
          "account_type": {
            "type": "string",
            "enum": [
              "checking",
              "savings",
              "cash",
              "credit_card",
              "mortgage",
              "auto_loan",
              "student_loan",
              "personal_loan",
              "loan",
              "investment",
              "retirement",
              "heloc",
              "home_equity_loan",
              "money_market",
              "cd",
              "crypto",
              "property",
              "vehicle",
              "collectible",
              "business_interest",
              "other"
            ],
            "description": "Financial Hub account classification."
          },
          "current_balance": {
            "type": "number",
            "description": "USD balance. Liabilities use positive amounts owed.",
            "minimum": -10000000000,
            "maximum": 10000000000
          },
          "apr": {
            "anyOf": [
              {
                "type": "number",
                "description": "Annual interest rate in percent (6 means 6%).",
                "minimum": 0,
                "maximum": 100
              },
              {
                "type": "null"
              }
            ]
          },
          "monthly_payment": {
            "anyOf": [
              {
                "type": "number",
                "description": "Nonnegative USD amount.",
                "minimum": 0,
                "maximum": 10000000000
              },
              {
                "type": "null"
              }
            ]
          },
          "minimum_payment": {
            "anyOf": [
              {
                "type": "number",
                "description": "Nonnegative USD amount.",
                "minimum": 0,
                "maximum": 10000000000
              },
              {
                "type": "null"
              }
            ]
          },
          "term_months": {
            "anyOf": [
              {
                "type": "integer",
                "description": "Remaining months used only to derive a missing payment.",
                "minimum": 1,
                "maximum": 1200
              },
              {
                "type": "null"
              }
            ]
          },
          "is_archived": {
            "type": "boolean",
            "description": "Exclude archived accounts. Defaults to false."
          }
        },
        "required": [
          "id",
          "account_type",
          "current_balance"
        ],
        "additionalProperties": false
      },
      "maxItems": 16,
      "description": "Caller-provided balance records. Maximum 8 active amortizable debt accounts per modeled debt request."
    },
    "marketRates": {
      "type": "object",
      "properties": {
        "mortgage30": {
          "anyOf": [
            {
              "type": "number",
              "description": "Annual interest rate in percent (6 means 6%).",
              "minimum": 0,
              "maximum": 100
            },
            {
              "type": "null"
            }
          ]
        },
        "auto": {
          "anyOf": [
            {
              "type": "number",
              "description": "Annual interest rate in percent (6 means 6%).",
              "minimum": 0,
              "maximum": 100
            },
            {
              "type": "null"
            }
          ]
        },
        "personal": {
          "anyOf": [
            {
              "type": "number",
              "description": "Annual interest rate in percent (6 means 6%).",
              "minimum": 0,
              "maximum": 100
            },
            {
              "type": "null"
            }
          ]
        },
        "creditCard": {
          "anyOf": [
            {
              "type": "number",
              "description": "Annual interest rate in percent (6 means 6%).",
              "minimum": 0,
              "maximum": 100
            },
            {
              "type": "null"
            }
          ]
        },
        "sourceLabel": {
          "type": "string",
          "description": "Caller label and date for the supplied benchmark.",
          "minLength": 1,
          "maxLength": 120
        }
      },
      "required": [],
      "additionalProperties": false
    }
  },
  "required": [
    "accounts",
    "marketRates"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/financial-hub-quoted-rate-comparison
Formula: financial-hub-insights-v1