Financial Hub · Calculation
Rental cash flow and returns
Calculates monthly operating income and cash flow, annual capitalization and cash-on-cash rates, and debt service coverage.
Visitors can explore a sample snapshot. Saved accounts, loans and properties open within the member’s own Financial Hub.
Example result · vacancy: 100 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-rental-metrics.
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-rental-metrics";
const input = {
"rent": 2000,
"vacancyPct": 5,
"maintenancePct": 10,
"insurance": 60,
"tax": 200,
"hoa": 40,
"principalInterest": 700,
"secondPayment": 100,
"value": 300000,
"cashInvested": 60000
};
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-rental-metrics' \
--header "Authorization: Bearer $HT_PRODUCTION_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"rent": 2000,
"vacancyPct": 5,
"maintenancePct": 10,
"insurance": 60,
"tax": 200,
"hoa": 40,
"principalInterest": 700,
"secondPayment": 100,
"value": 300000,
"cashInvested": 60000
}
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-rental-metrics. 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.
vacancy- 100
maintenance- 200
operatingCosts- 600
How to interpret this result
- Missing expenses are zero. Missing or zero ratio denominators return null.
Full example response (JSON)
{
"status": "available",
"result": {
"vacancy": 100,
"maintenance": 200,
"operatingCosts": 600,
"noiMonthly": 1400,
"debtMonthly": 800,
"cashFlowMonthly": 600,
"capRate": 5.6000000000000005,
"dscr": 1.75,
"cashOnCash": 12,
"printedCashFlow": 600
},
"formulaVersion": "financial-hub-rental-metrics-1.0.0",
"units": {
"money": "USD/month",
"capRate": "percent per year",
"dscr": "ratio",
"cashOnCash": "percent per year"
},
"assumptions": [
"Missing expenses are zero. Missing or zero ratio denominators return null."
],
"warnings": [],
"creditCost": 1
}Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
rentRequiredGross rent per month (USD, to the cent).
Min 0 · Max 10000000000 · Step 0.01principalInterestOptionalPrincipal and interest per month (USD, to the cent).
Min 0 · Max 10000000000 · Step 0.01taxOptionalProperty tax per month (USD, to the cent).
Min 0 · Max 10000000000 · Step 0.01insuranceOptionalHome insurance per month (USD, to the cent).
Min 0 · Max 10000000000 · Step 0.01hoaOptionalHOA dues per month (USD, to the cent).
Min 0 · Max 10000000000 · Step 0.01secondPaymentOptionalSecond loan payment per month (USD, to the cent).
Min 0 · Max 10000000000 · Step 0.01vacancyPctOptionalVacancy share of gross rent (percentage points, up to six decimals).
Min 0 · Max 100 · Step 0.000001maintenancePctOptionalMaintenance share of gross rent (percentage points, up to six decimals).
Min 0 · Max 100 · Step 0.000001valueOptionalCurrent property value (USD, to the cent).
Min 0 · Max 10000000000 · Step 0.01cashInvestedOptionalCash invested (USD, to the cent).
Min 0 · Max 10000000000 · Step 0.01Example request body (JSON)
{
"rent": 2000,
"vacancyPct": 5,
"maintenancePct": 10,
"insurance": 60,
"tax": 200,
"hoa": 40,
"principalInterest": 700,
"secondPayment": 100,
"value": 300000,
"cashInvested": 60000
} Full JSON schema
{
"type": "object",
"properties": {
"rent": {
"type": "number",
"description": "Gross rent per month (USD, to the cent).",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01
},
"principalInterest": {
"type": "number",
"description": "Principal and interest per month (USD, to the cent).",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01
},
"tax": {
"type": "number",
"description": "Property tax per month (USD, to the cent).",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01
},
"insurance": {
"type": "number",
"description": "Home insurance per month (USD, to the cent).",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01
},
"hoa": {
"type": "number",
"description": "HOA dues per month (USD, to the cent).",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01
},
"secondPayment": {
"type": "number",
"description": "Second loan payment per month (USD, to the cent).",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01
},
"vacancyPct": {
"type": "number",
"description": "Vacancy share of gross rent (percentage points, up to six decimals).",
"minimum": 0,
"maximum": 100,
"multipleOf": 0.000001
},
"maintenancePct": {
"type": "number",
"description": "Maintenance share of gross rent (percentage points, up to six decimals).",
"minimum": 0,
"maximum": 100,
"multipleOf": 0.000001
},
"value": {
"type": "number",
"description": "Current property value (USD, to the cent).",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01
},
"cashInvested": {
"type": "number",
"description": "Cash invested (USD, to the cent).",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01
}
},
"required": [
"rent"
],
"additionalProperties": false
}Production endpoint: POST https://calc.hasstechapi.com/v2/calc/financial-hub-rental-metrics
Formula: financial-hub-rental-metrics-1.0.0