Skip to content

Financial Hub · Calculation

Ranked Financial Hub insights

Combine deterministic account, supplied-rate, subscription and cash-flow signals with supporting figures and sort by severity and annual impact.

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 · generatedFrom.accounts: 3 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-ranked-insights.

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-ranked-insights";
const input = {
  "asOf": "2026-04-01",
  "transactions": [
    {
      "posted_at": "2026-03-28",
      "amount": 1000
    },
    {
      "posted_at": "2026-04-01",
      "amount": -250
    },
    {
      "posted_at": "2026-04-01",
      "amount": -100,
      "pending": true
    }
  ],
  "accounts": [
    {
      "id": "a",
      "account_type": "savings",
      "current_balance": 2000
    },
    {
      "id": "b",
      "account_type": "investment",
      "current_balance": 5000
    },
    {
      "id": "auto",
      "name": "Car",
      "account_type": "auto_loan",
      "current_balance": 1000,
      "apr": 12,
      "monthly_payment": 600
    }
  ],
  "recurring": [],
  "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-ranked-insights' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "asOf": "2026-04-01",
  "transactions": [
    {
      "posted_at": "2026-03-28",
      "amount": 1000
    },
    {
      "posted_at": "2026-04-01",
      "amount": -250
    },
    {
      "posted_at": "2026-04-01",
      "amount": -100,
      "pending": true
    }
  ],
  "accounts": [
    {
      "id": "a",
      "account_type": "savings",
      "current_balance": 2000
    },
    {
      "id": "b",
      "account_type": "investment",
      "current_balance": 5000
    },
    {
      "id": "auto",
      "name": "Car",
      "account_type": "auto_loan",
      "current_balance": 1000,
      "apr": 12,
      "monthly_payment": 600
    }
  ],
  "recurring": [],
  "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-ranked-insights.
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.

generatedFrom.accounts
3
generatedFrom.transactions
3
generatedFrom.recurring
0
How to interpret this result
  • Only caller-provided data and rate assumptions are used. Ranking prioritizes warnings, opportunities and information in that order.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "insights": [
      {
        "id": "cashflow-runway",
        "category": "cashflow",
        "severity": "warning",
        "title": "Your emergency runway is thin",
        "summary": "Your liquid savings of $2,000 would cover about 2.0 months of spending at $1,000/mo. Most guidance suggests keeping 3–6 months as a cushion.",
        "basis": {
          "sourceCount": 1,
          "dataPoints": [
            {
              "label": "Liquid savings",
              "value": "$2,000"
            },
            {
              "label": "Avg monthly spending",
              "value": "$1,000"
            },
            {
              "label": "Runway",
              "value": "2.0 months"
            }
          ]
        }
      },
      {
        "id": "rate-compare-auto",
        "category": "rate",
        "severity": "opportunity",
        "title": "Your Car rate is 12.00% above supplied benchmark",
        "summary": "You're paying 12.00% while the supplied auto loan benchmark is about 0.00%. At the same payment, refinancing to this benchmark could save roughly $14 in interest over the life of the loan. Closing costs and eligibility apply — model it before acting.",
        "basis": {
          "sourceCount": 1,
          "dataPoints": [
            {
              "label": "Your APR",
              "value": "12.00%"
            },
            {
              "label": "Supplied benchmark",
              "value": "0.00%"
            },
            {
              "label": "Balance",
              "value": "$1,000"
            },
            {
              "label": "Interest at your rate",
              "value": "$14"
            },
            {
              "label": "Interest at market rate",
              "value": "$0"
            },
            {
              "label": "Rate source",
              "value": "Caller example at 0%"
            }
          ]
        },
        "estimatedAnnualImpact": 85,
        "actionLabel": "Compare in the Loan calculator",
        "actionHref": "/calculator/loan"
      },
      {
        "id": "debt-avalanche-auto",
        "category": "debt",
        "severity": "opportunity",
        "title": "Attack your 12.00% debt first",
        "summary": "Car carries your highest rate at 12.00%. Paying an extra $60/mo toward it would save about $0 in interest and clear it 0 mo sooner.",
        "basis": {
          "sourceCount": 1,
          "dataPoints": [
            {
              "label": "Balance",
              "value": "$1,000"
            },
            {
              "label": "APR",
              "value": "12.00%"
            },
            {
              "label": "Current payment",
              "value": "$600/mo"
            },
            {
              "label": "Extra payment modeled",
              "value": "$60/mo"
            },
            {
              "label": "Interest saved",
              "value": "$0"
            },
            {
              "label": "Time saved",
              "value": "0 mo"
            }
          ]
        },
        "actionLabel": "Model this in the Extra Payment calculator",
        "actionHref": "/calculator/mortgage"
      },
      {
        "id": "debt-total-interest",
        "category": "debt",
        "severity": "info",
        "title": "Interest you still owe",
        "summary": "Across 1 loan totaling $1,000, you're on track to pay about $14 in interest over their remaining life at your current payments.",
        "basis": {
          "sourceCount": 1,
          "dataPoints": [
            {
              "label": "Car",
              "value": "$1,000 @ 12.00% → $14 interest, 2 mo left"
            }
          ]
        }
      },
      {
        "id": "cashflow-net",
        "category": "cashflow",
        "severity": "info",
        "title": "Your cash flow is positive",
        "summary": "Over the last 0 mo of activity you've averaged $3,000/mo left over after spending.",
        "basis": {
          "sourceCount": 2,
          "dataPoints": [
            {
              "label": "Avg monthly income",
              "value": "$4,000"
            },
            {
              "label": "Avg monthly spending",
              "value": "$1,000"
            },
            {
              "label": "Observed window",
              "value": "0 mo"
            }
          ]
        }
      }
    ],
    "hasEnoughData": true,
    "generatedFrom": {
      "accounts": 3,
      "transactions": 3,
      "recurring": 0,
      "hasMarketRates": true
    },
    "disclaimer": "These insights are generated automatically from the financial data you saved and are for educational and informational purposes only. HT Calc is not a licensed financial, tax, legal, or investment advisor. Figures are estimates — verify with your lender or a qualified professional before making decisions."
  },
  "formulaVersion": "financial-hub-insights-v1",
  "units": {
    "money": "USD",
    "rate": "percent APR",
    "duration": "months",
    "dates": "UTC date"
  },
  "assumptions": [
    "Only caller-provided data and rate assumptions are used. Ranking prioritizes warnings, opportunities and information in that order."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

asOfRequired
string

UTC calendar date (YYYY-MM-DD).

Format: date · Min length 1 · Max length 10
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.

transactionsRequired
array

Caller transactions in USD. Include historical rows required for this calculation.

Max items 512
transactions[].posted_atRequired
string

UTC calendar date (YYYY-MM-DD).

Format: date · Min length 1 · Max length 10
transactions[].amountRequired
number

Signed USD value. Inflows positive, outflows negative.

Min -10000000000 · Max 10000000000
transactions[].pendingOptional
boolean

Pending transaction, defaults to false.

transactions[].descriptionOptional
string

Optional synthetic or redacted transaction label.

Min length 1 · Max length 160
transactions[].merchant_nameOptional
string

Optional merchant label for matching.

Min length 1 · Max length 100
recurringRequired
array

Caller-classified recurring payments.

Max items 64
recurring[].idRequired
string

Caller reference; use an opaque account or service identifier.

Min length 1 · Max length 80
recurring[].nameRequired
string

Recurring service label.

Min length 1 · Max length 100
recurring[].merchant_nameOptional
string

Optional merchant alias.

Min length 1 · Max length 100
recurring[].categoryOptional
string

Caller classification used to group overlaps.

Min length 1 · Max length 100
recurring[].amountRequired
number

Nonnegative USD amount.

Min 0 · Max 10000000000
recurring[].cadenceRequired
string

Payment frequency.

Allowed: "weekly", "biweekly", "semi_monthly", "monthly", "quarterly", "semiannual", "annual"
recurring[].is_subscriptionRequired
boolean

Caller classification. Only active subscriptions contribute.

recurring[].statusRequired
string

Caller subscription status.

Allowed: "active", "paused", "canceled"
continuousHistoryFromOptional
string

Optional start of continuous caller-supplied transaction coverage through asOf. Enables 90-day unmatched-charge candidates with spend evidence.

Format: date · Min length 1 · Max length 10
marketRatesOptional
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)
{
  "asOf": "2026-04-01",
  "transactions": [
    {
      "posted_at": "2026-03-28",
      "amount": 1000
    },
    {
      "posted_at": "2026-04-01",
      "amount": -250
    },
    {
      "posted_at": "2026-04-01",
      "amount": -100,
      "pending": true
    }
  ],
  "accounts": [
    {
      "id": "a",
      "account_type": "savings",
      "current_balance": 2000
    },
    {
      "id": "b",
      "account_type": "investment",
      "current_balance": 5000
    },
    {
      "id": "auto",
      "name": "Car",
      "account_type": "auto_loan",
      "current_balance": 1000,
      "apr": 12,
      "monthly_payment": 600
    }
  ],
  "recurring": [],
  "marketRates": {
    "auto": 0,
    "sourceLabel": "Caller example at 0%"
  }
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "asOf": {
      "type": "string",
      "description": "UTC calendar date (YYYY-MM-DD).",
      "minLength": 1,
      "maxLength": 10,
      "format": "date"
    },
    "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."
    },
    "transactions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "posted_at": {
            "type": "string",
            "description": "UTC calendar date (YYYY-MM-DD).",
            "minLength": 1,
            "maxLength": 10,
            "format": "date"
          },
          "amount": {
            "type": "number",
            "description": "Signed USD value. Inflows positive, outflows negative.",
            "minimum": -10000000000,
            "maximum": 10000000000
          },
          "pending": {
            "type": "boolean",
            "description": "Pending transaction, defaults to false."
          },
          "description": {
            "type": "string",
            "description": "Optional synthetic or redacted transaction label.",
            "minLength": 1,
            "maxLength": 160
          },
          "merchant_name": {
            "type": "string",
            "description": "Optional merchant label for matching.",
            "minLength": 1,
            "maxLength": 100
          }
        },
        "required": [
          "posted_at",
          "amount"
        ],
        "additionalProperties": false
      },
      "maxItems": 512,
      "description": "Caller transactions in USD. Include historical rows required for this calculation."
    },
    "recurring": {
      "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": "Recurring service label.",
            "minLength": 1,
            "maxLength": 100
          },
          "merchant_name": {
            "type": "string",
            "description": "Optional merchant alias.",
            "minLength": 1,
            "maxLength": 100
          },
          "category": {
            "type": "string",
            "description": "Caller classification used to group overlaps.",
            "minLength": 1,
            "maxLength": 100
          },
          "amount": {
            "type": "number",
            "description": "Nonnegative USD amount.",
            "minimum": 0,
            "maximum": 10000000000
          },
          "cadence": {
            "type": "string",
            "enum": [
              "weekly",
              "biweekly",
              "semi_monthly",
              "monthly",
              "quarterly",
              "semiannual",
              "annual"
            ],
            "description": "Payment frequency."
          },
          "is_subscription": {
            "type": "boolean",
            "description": "Caller classification. Only active subscriptions contribute."
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "paused",
              "canceled"
            ],
            "description": "Caller subscription status."
          }
        },
        "required": [
          "id",
          "name",
          "amount",
          "cadence",
          "is_subscription",
          "status"
        ],
        "additionalProperties": false
      },
      "maxItems": 64,
      "description": "Caller-classified recurring payments."
    },
    "continuousHistoryFrom": {
      "type": "string",
      "description": "Optional start of continuous caller-supplied transaction coverage through asOf. Enables 90-day unmatched-charge candidates with spend evidence.",
      "minLength": 1,
      "maxLength": 10,
      "format": "date"
    },
    "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": [
    "asOf",
    "accounts",
    "transactions",
    "recurring"
  ],
  "additionalProperties": false
}

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