Financial Hub · Calculation
Financial Hub household snapshot
Turn a dated, caller-entered profile into the Hub balance sheet, cash flow, DTI, readiness steps, Wealth Weather, Money Moves and a privacy-limited report model. A supplied conventional rate adds the profile affordability estimates.
Visitors can explore a sample snapshot. Saved accounts, loans and properties open within the member’s own Financial Hub.
Example result · report.type: FINANCIAL_HUB 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-profile-snapshot.
Keep the key on your server. A successful call uses 1 calculation credit.
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-profile-snapshot";
const input = {
"asOf": "2026-11-15",
"incomeSources": [
{
"gross_monthly_amount": 5200,
"qualifying_monthly_amount": 5000
}
],
"housing": {
"status": "own_mortgaged",
"has_escrow": true,
"total_monthly_payment": 1200,
"property_tax_monthly": 150,
"hoa_fees": 50,
"second_mortgage_payment": 50,
"current_estimated_value": 210000,
"purchase_price": 200000,
"remaining_balance": 155000
},
"properties": [
{
"is_rented": true,
"monthly_rent": 2000,
"monthly_pi": 1000,
"current_estimated_value": 160000,
"mortgage_balance": 90000
}
],
"debts": [
{
"debt_type": "credit_card",
"current_balance": 2000,
"monthly_payment": 100,
"interest_rate": 19
}
],
"assets": [
{
"type": "savings",
"value": 7000,
"asOf": "2026-11-14"
}
],
"vehicles": [
{
"estimatedValue": 10000,
"loanBalance": 12000
}
],
"businesses": [
{
"estimatedValue": 30000,
"liabilities": 10000
}
],
"accounts": [
{
"account_type": "savings",
"current_balance": 7000,
"legacyMirror": true,
"mirrorAssetIndex": 0
},
{
"account_type": "checking",
"current_balance": 1000
}
],
"creditScore": 700
};
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 -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-profile-snapshot' \
--header "Authorization: Bearer $HT_PRODUCTION_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"asOf": "2026-11-15",
"incomeSources": [
{
"gross_monthly_amount": 5200,
"qualifying_monthly_amount": 5000
}
],
"housing": {
"status": "own_mortgaged",
"has_escrow": true,
"total_monthly_payment": 1200,
"property_tax_monthly": 150,
"hoa_fees": 50,
"second_mortgage_payment": 50,
"current_estimated_value": 210000,
"purchase_price": 200000,
"remaining_balance": 155000
},
"properties": [
{
"is_rented": true,
"monthly_rent": 2000,
"monthly_pi": 1000,
"current_estimated_value": 160000,
"mortgage_balance": 90000
}
],
"debts": [
{
"debt_type": "credit_card",
"current_balance": 2000,
"monthly_payment": 100,
"interest_rate": 19
}
],
"assets": [
{
"type": "savings",
"value": 7000,
"asOf": "2026-11-14"
}
],
"vehicles": [
{
"estimatedValue": 10000,
"loanBalance": 12000
}
],
"businesses": [
{
"estimatedValue": 30000,
"liabilities": 10000
}
],
"accounts": [
{
"account_type": "savings",
"current_balance": 7000,
"legacyMirror": true,
"mirrorAssetIndex": 0
},
{
"account_type": "checking",
"current_balance": 1000
}
],
"creditScore": 700
}
HT_INPUT
) If your request fails
400 INVALID_INPUT-
Read
error.detailswhen present. Node prints each issue. cURL returns the JSON body. Eachpathpoints 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.
401or403- Check that the server has the bearer key for the endpoint’s environment and that the key includes
financial-hub-profile-snapshot. 429- Read the service error code, check your allowance, and wait for the
Retry-Afterinterval when supplied before trying again. - Lost response,
409or503 - 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_IDto 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.
report.type- FINANCIAL_HUB
report.date- 2026-11-15T00:00:00.000Z
report.netWorth- 149000
How to interpret this result
- Uses the generic Hub debt rules, net rental calculation and the November Hub balance sheet. Enter each holding once. A vehicle in both asset lists counts twice as in the app.
- Housing and property balances use the main mortgage balance in the Hub rollup; the separately entered second-lien payment counts in monthly obligations. No automatic addition of a second-lien balance.
- Zero value produces a displayed 0% holding debt ratio, as in the app. Housing missing or income absent suppresses Wealth Weather. No affordability estimate without a caller rate.
- All amounts are caller-entered; results and readiness labels are educational and do not verify a balance, predict credit or grant loan approval.
Full example response (JSON)
{
"status": "available",
"result": {
"report": {
"type": "FINANCIAL_HUB",
"date": "2026-11-15T00:00:00.000Z",
"netWorth": 149000,
"totalAssets": 418000,
"totalLiabilities": 269000,
"monthlyIncome": 5500,
"monthlyObligations": 1400,
"dtiRatio": 25.454545454545453,
"snapshotStatus": "Based on recorded entries; account balances have not been refreshed.",
"balanceSheet": [
{
"id": "property",
"assets": 370000,
"liabilities": 245000
},
{
"id": "assets",
"assets": 7000,
"liabilities": 0
},
{
"id": "debts",
"assets": 0,
"liabilities": 2000
},
{
"id": "accounts",
"assets": 1000,
"liabilities": 0
},
{
"id": "vehicles",
"assets": 10000,
"liabilities": 12000
},
{
"id": "businesses",
"assets": 30000,
"liabilities": 10000
}
],
"staleBalanceCount": 0,
"checkup": {
"snapshot": {
"periodMonth": "2026-11",
"generatedAt": "2026-11-15T00:00:00.000Z",
"score": 90
},
"nextAction": {
"title": "Audit your benefits before open enrollment closes",
"summary": "Open enrollment for next year is happening now. Review health plan, FSA/HSA contributions, and retirement match — small changes here lock in for 12 months.",
"lesson": {
"whyItMatters": "Benefits choices made now lock for a full year, so a small adjustment now compounds for 12 months.",
"formula": "Pretax savings = (FSA/HSA/401k contribution) x marginal tax rate.",
"whatChanged": "You are inside the typical employer open-enrollment window.",
"askNext": "Ask HR about FSA/HSA limits, retirement match thresholds, and high-deductible vs PPO trade-offs for your family.",
"assumptions": "HT Calc is not a regulated financial adviser and is not assuming taxes, lender overlays, credit changes, market moves, or your full household budget unless you enter them."
}
}
},
"isSample": false,
"disclosures": [
"This report is an educational planning snapshot, not financial advice or a guarantee of future results.",
"This focused report intentionally excludes account numbers, routing details, transactions, documents, and bank-connection identifiers.",
"All balances, dates, and freshness classifications were supplied by the caller."
]
},
"shownNetWorth": 149000,
"money": {
"grossIncome": 5200,
"monthlyDebts": 100,
"qualifyingIncome": 5500,
"dti": 25.454545454545453,
"dtiStatus": "Excellent",
"housingRatio": 23.636363636363637,
"debtsOnlyDti": 1.8181818181818181,
"housingMissing": false,
"housing": 1300,
"otherProperties": 1000,
"rentalNetDebt": 0,
"dtiDebts": 1400,
"rentalIncome": 2000,
"cashIn": 7200,
"remaining": 4800
},
"obligations": {
"nonHousingDebts": 100,
"primaryHousing": 1300,
"otherProperties": 1000,
"rentalNetDebt": 0,
"rentalNetIncome": 500,
"total": 1400
},
"readouts": {
"dti": {
"value": 25.454545454545453,
"label": "Excellent",
"rated": true,
"hasIncome": true
},
"reserves": {
"amount": 7000,
"months": 5.384615384615385,
"known": true
},
"readiness": {
"checks": [
{
"key": "dti",
"label": "DTI 43% or less",
"known": true,
"met": true
},
{
"key": "reserves",
"label": "2 months of housing saved",
"known": true,
"met": true
},
{
"key": "credit",
"label": "Credit 620+",
"known": true,
"met": true
}
],
"met": 3,
"known": 3,
"label": "Lender-ready"
}
},
"readiness": {
"steps": [],
"met": 3,
"total": 3,
"progress": 1
},
"liquidAssets": 8000,
"cashObligations": 2400,
"weather": {
"inputs": {
"dtiRatio": 25.454545454545453,
"savingsRate": 74.54545454545455,
"debtTrend": "stable",
"hasEmergencyFund": true,
"equityGrowth": 5
},
"points": {
"dtiPts": 30,
"savingsPts": 25,
"emergencyPts": 20,
"trendPts": 8,
"equityPts": 7,
"total": 90
}
},
"affordability": null,
"vehicles": {
"items": [
{
"value": 10000,
"amountOwed": 12000,
"equity": -2000,
"debtPercent": 120
}
],
"totalValue": 10000,
"totalEquity": -2000
},
"businesses": {
"items": [
{
"value": 30000,
"amountOwed": 10000,
"equity": 20000,
"debtPercent": 33.33333333333333
}
],
"totalValue": 30000,
"totalEquity": 20000
},
"moneyMoves": {
"score": 90,
"staleOrMissingGroups": 0,
"projectedItems": 0,
"freshness": "verified",
"actions": [
{
"type": "open_enrollment_audit",
"goal": "net_worth_stability",
"priority": 85,
"title": "Audit your benefits before open enrollment closes",
"summary": "Open enrollment for next year is happening now. Review health plan, FSA/HSA contributions, and retirement match — small changes here lock in for 12 months.",
"impactLabel": "Open enrollment window",
"lesson": {
"whyItMatters": "Benefits choices made now lock for a full year, so a small adjustment now compounds for 12 months.",
"formula": "Pretax savings = (FSA/HSA/401k contribution) x marginal tax rate.",
"whatChanged": "You are inside the typical employer open-enrollment window.",
"askNext": "Ask HR about FSA/HSA limits, retirement match thresholds, and high-deductible vs PPO trade-offs for your family.",
"assumptions": "HT Calc is not a regulated financial adviser and is not assuming taxes, lender overlays, credit changes, market moves, or your full household budget unless you enter them."
}
},
{
"type": "pay_down_debt",
"goal": "debt_payoff_consistency",
"priority": 70,
"title": "Pay down Debt 1 first",
"summary": "Debt 1 carries the highest listed APR, so extra dollars here usually remove interest fastest.",
"impactLabel": "19.0% APR",
"lesson": {
"whyItMatters": "High-rate revolving debt can erase progress even when minimum payments are made on time.",
"formula": "Interest avoided grows with balance x APR x time outstanding.",
"whatChanged": "$2,000 at 19.0% is the most expensive debt in the snapshot.",
"askNext": "Ask the issuer about hardship APRs, balance-transfer fees, and whether extra payments apply to principal immediately.",
"assumptions": "HT Calc is not a regulated financial adviser and is not assuming taxes, lender overlays, credit changes, market moves, or your full household budget unless you enter them."
}
},
{
"type": "update_rate_alerts",
"goal": "home_loan_optimization",
"priority": 45,
"title": "Update your rate alert thresholds",
"summary": "Set rate alerts around your real loan size so you know when a refi or purchase quote is worth attention.",
"impactLabel": "Rate window watch",
"lesson": {
"whyItMatters": "A rate alert turns market noise into a decision trigger tied to your numbers.",
"formula": "Payment change = loan amount x rate change through the amortization formula.",
"whatChanged": "Your loan data is present, so alerts can be tied to payment impact instead of generic headlines.",
"askNext": "Ask lenders what rate, points, and closing-cost package would make the move worthwhile.",
"assumptions": "HT Calc is not a regulated financial adviser and is not assuming taxes, lender overlays, credit changes, market moves, or your full household budget unless you enter them."
}
},
{
"type": "prepare_lender_docs",
"goal": "home_loan_optimization",
"priority": 40,
"title": "Prepare lender-ready documents",
"summary": "Keep income, asset, mortgage, and insurance docs ready so a good rate window does not expire while you gather paperwork.",
"impactLabel": "Doc readiness",
"lesson": {
"whyItMatters": "Loan opportunities often depend on speed and clean documentation.",
"formula": "Ready package = identity + income + assets + debts + property docs.",
"whatChanged": "Your snapshot has enough loan context to prepare a targeted package.",
"askNext": "Ask each lender which documents they need before quoting a locked payment.",
"assumptions": "HT Calc is not a regulated financial adviser and is not assuming taxes, lender overlays, credit changes, market moves, or your full household budget unless you enter them."
}
}
]
}
},
"formulaVersion": "financial-hub-profile-snapshot-1.0.0",
"units": {
"balances, equity, affordability prices": "USD",
"cash, income, debt payments": "USD/month unless identified as a balance",
"DTI, equityGrowth, savingsRate, debtPercent, APR": "percentage points",
"readouts.reserves.months": "months",
"weather.points, moneyMoves.score": "points",
"readiness.progress": "fraction"
},
"assumptions": [
"Uses the generic Hub debt rules, net rental calculation and the November Hub balance sheet. Enter each holding once. A vehicle in both asset lists counts twice as in the app.",
"Housing and property balances use the main mortgage balance in the Hub rollup; the separately entered second-lien payment counts in monthly obligations. No automatic addition of a second-lien balance.",
"Zero value produces a displayed 0% holding debt ratio, as in the app. Housing missing or income absent suppresses Wealth Weather. No affordability estimate without a caller rate.",
"All amounts are caller-entered; results and readiness labels are educational and do not verify a balance, predict credit or grant loan approval."
],
"warnings": [],
"creditCost": 1
}Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
asOfRequiredReal UTC calendar date, YYYY-MM-DD.
Format: date · Min length 10 · Max length 10incomeSourcesRequiredincomeSources[].gross_monthly_amountRequiredUSD per month.
Min 0 · Max 10000000000 · Step 0.01incomeSources[].qualifying_monthly_amountRequiredUSD per month.
Min 0 · Max 10000000000 · Step 0.01incomeSources[].fromAffordabilitySyncOptionaldebtsRequireddebts[].debt_typeRequireddebts[].current_balanceRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01debts[].monthly_paymentRequiredUSD per month.
Min 0 · Max 10000000000 · Step 0.01debts[].interest_rateOptionalAnnual percentage points, e.g. 6.5.
Min 0 · Max 100 · Step 0.00001debts[].months_remainingOptionaldebts[].is_excluded_from_dtiOptionaldebts[].will_pay_offOptionaldebts[].imputed_payment_amountOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01debts[].fromAffordabilitySyncOptionaldebts[].balance_kindOptionaldebts[].freshnessOptionaldebts[].requires_refreshOptionalassetsRequiredassets[].typeRequiredassets[].valueRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01assets[].asOfOptionalReal UTC calendar date, YYYY-MM-DD.
Format: date · Min length 10 · Max length 10propertiesRequiredproperties[].purchase_priceOptionalUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01properties[].current_estimated_valueRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01properties[].mortgage_balanceRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01properties[].is_rentedOptionalproperties[].monthly_rentOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].qualifying_rental_incomeOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].monthly_piOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].second_mortgage_paymentOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].property_tax_monthlyOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].insurance_monthlyOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01properties[].hoa_feesOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housingOptionalhousing.statusRequiredhousing.has_escrowOptionalhousing.principal_interestOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.second_mortgage_paymentOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.property_tax_monthlyOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.home_insurance_monthlyOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.hoa_feesOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.pmiOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.monthly_rentOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.total_monthly_paymentOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01housing.purchase_priceOptionalUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01housing.current_estimated_valueOptionalUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01housing.remaining_balanceOptionalUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01housing.interest_rateOptionalAnnual percentage points, e.g. 6.5.
Min 0 · Max 100 · Step 0.00001housing.mortgage_balance_kindOptionalhousing.mortgage_balance_freshnessOptionalaccountsOptionalaccounts[].account_typeRequiredaccounts[].current_balanceRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01accounts[].archivedOptionalaccounts[].legacyMirrorOptionalaccounts[].mirrorAssetIndexOptionalZero-based index of the matching asset, if a compatibility shadow.
Min 0 · Max 99accounts[].projectionOptionalaccounts[].projection.valueRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01accounts[].projection.observedRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01accounts[].projection.observationKindRequiredaccounts[].projection.projectedRequiredaccounts[].projection.currentRequiredvehiclesOptionalvehicles[].estimatedValueRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01vehicles[].loanBalanceRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01businessesOptionalbusinesses[].estimatedValueRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01businesses[].liabilitiesRequiredUSD, entered amount.
Min 0 · Max 10000000000 · Step 0.01legacyIncomeOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01legacyDebtOptionalUSD per month.
Min 0 · Max 10000000000 · Step 0.01creditScoreOptionalUser-entered score or selected band estimate; omit if unknown.
Min 300 · Max 850creditIsEstimateOptionalactiveGoalsOptionalconventionalRateOptionalOptional caller-supplied conventional rate (% per year) for the 36% and 43% affordability estimates; no feed is contacted.
Min 0 · Max 100 · Step 0.00001Example request body (JSON)
{
"asOf": "2026-11-15",
"incomeSources": [
{
"gross_monthly_amount": 5200,
"qualifying_monthly_amount": 5000
}
],
"housing": {
"status": "own_mortgaged",
"has_escrow": true,
"total_monthly_payment": 1200,
"property_tax_monthly": 150,
"hoa_fees": 50,
"second_mortgage_payment": 50,
"current_estimated_value": 210000,
"purchase_price": 200000,
"remaining_balance": 155000
},
"properties": [
{
"is_rented": true,
"monthly_rent": 2000,
"monthly_pi": 1000,
"current_estimated_value": 160000,
"mortgage_balance": 90000
}
],
"debts": [
{
"debt_type": "credit_card",
"current_balance": 2000,
"monthly_payment": 100,
"interest_rate": 19
}
],
"assets": [
{
"type": "savings",
"value": 7000,
"asOf": "2026-11-14"
}
],
"vehicles": [
{
"estimatedValue": 10000,
"loanBalance": 12000
}
],
"businesses": [
{
"estimatedValue": 30000,
"liabilities": 10000
}
],
"accounts": [
{
"account_type": "savings",
"current_balance": 7000,
"legacyMirror": true,
"mirrorAssetIndex": 0
},
{
"account_type": "checking",
"current_balance": 1000
}
],
"creditScore": 700
} Full JSON schema
{
"type": "object",
"properties": {
"asOf": {
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10,
"pattern": "^(19|20|21)[0-9]{2}-[0-9]{2}-[0-9]{2}$",
"description": "Real UTC calendar date, YYYY-MM-DD."
},
"incomeSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"gross_monthly_amount": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"qualifying_monthly_amount": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"fromAffordabilitySync": {
"type": "boolean"
}
},
"required": [
"gross_monthly_amount",
"qualifying_monthly_amount"
],
"additionalProperties": false
},
"maxItems": 100
},
"debts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"debt_type": {
"type": "string",
"enum": [
"auto",
"student",
"credit_card",
"personal",
"medical",
"collections",
"mortgage",
"heloc",
"other"
]
},
"current_balance": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"monthly_payment": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"interest_rate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"multipleOf": 0.00001,
"description": "Annual percentage points, e.g. 6.5."
},
"months_remaining": {
"type": "integer",
"minimum": 0,
"maximum": 600
},
"is_excluded_from_dti": {
"type": "boolean"
},
"will_pay_off": {
"type": "boolean"
},
"imputed_payment_amount": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"fromAffordabilitySync": {
"type": "boolean"
},
"balance_kind": {
"type": "string",
"enum": [
"verified",
"projected",
"missing"
]
},
"freshness": {
"type": "string",
"enum": [
"current",
"refresh_recommended",
"incomplete"
]
},
"requires_refresh": {
"type": "boolean"
}
},
"required": [
"debt_type",
"current_balance",
"monthly_payment"
],
"additionalProperties": false
},
"maxItems": 100
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cash",
"savings",
"investment_brokerage",
"investment_retirement",
"crypto",
"vehicle",
"other"
]
},
"value": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"asOf": {
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10,
"pattern": "^(19|20|21)[0-9]{2}-[0-9]{2}-[0-9]{2}$",
"description": "Real UTC calendar date, YYYY-MM-DD."
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
"maxItems": 100
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"purchase_price": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"current_estimated_value": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"mortgage_balance": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"is_rented": {
"type": "boolean"
},
"monthly_rent": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"qualifying_rental_income": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"monthly_pi": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"second_mortgage_payment": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"property_tax_monthly": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"insurance_monthly": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"hoa_fees": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
}
},
"required": [
"current_estimated_value",
"mortgage_balance"
],
"additionalProperties": false
},
"maxItems": 100
},
"housing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"rent",
"live_with_family",
"own_free_clear",
"own_mortgaged"
]
},
"has_escrow": {
"type": "boolean"
},
"principal_interest": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"second_mortgage_payment": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"property_tax_monthly": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"home_insurance_monthly": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"hoa_fees": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"pmi": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"monthly_rent": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"total_monthly_payment": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"purchase_price": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"current_estimated_value": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"remaining_balance": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"interest_rate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"multipleOf": 0.00001,
"description": "Annual percentage points, e.g. 6.5."
},
"mortgage_balance_kind": {
"type": "string",
"enum": [
"verified",
"projected",
"missing"
]
},
"mortgage_balance_freshness": {
"type": "string",
"enum": [
"current",
"refresh_recommended",
"incomplete"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"accounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"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"
]
},
"current_balance": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"archived": {
"type": "boolean"
},
"legacyMirror": {
"type": "boolean"
},
"mirrorAssetIndex": {
"type": "integer",
"minimum": 0,
"maximum": 99,
"description": "Zero-based index of the matching asset, if a compatibility shadow."
},
"projection": {
"type": "object",
"properties": {
"value": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"observed": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"observationKind": {
"type": "string",
"enum": [
"verified",
"estimated"
]
},
"projected": {
"type": "boolean"
},
"current": {
"type": "boolean"
}
},
"required": [
"value",
"observed",
"observationKind",
"projected",
"current"
],
"additionalProperties": false
}
},
"required": [
"account_type",
"current_balance"
],
"additionalProperties": false
},
"maxItems": 100
},
"vehicles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"estimatedValue": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"loanBalance": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
}
},
"required": [
"estimatedValue",
"loanBalance"
],
"additionalProperties": false
},
"maxItems": 100
},
"businesses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"estimatedValue": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
},
"liabilities": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD, entered amount."
}
},
"required": [
"estimatedValue",
"liabilities"
],
"additionalProperties": false
},
"maxItems": 100
},
"legacyIncome": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"legacyDebt": {
"type": "number",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01,
"description": "USD per month."
},
"creditScore": {
"type": "integer",
"minimum": 300,
"maximum": 850,
"description": "User-entered score or selected band estimate; omit if unknown."
},
"creditIsEstimate": {
"type": "boolean"
},
"activeGoals": {
"type": "array",
"items": {
"type": "string",
"enum": [
"home_loan_optimization",
"debt_payoff_consistency",
"net_worth_stability"
]
},
"maxItems": 3,
"uniqueItems": true
},
"conventionalRate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"multipleOf": 0.00001,
"description": "Optional caller-supplied conventional rate (% per year) for the 36% and 43% affordability estimates; no feed is contacted."
}
},
"required": [
"asOf",
"incomeSources",
"debts",
"assets",
"properties"
],
"additionalProperties": false
}Production endpoint: POST https://calc.hasstechapi.com/v2/calc/financial-hub-profile-snapshot
Formula: financial-hub-profile-snapshot-1.0.0