Skip to content

Investment · Calculation

Property operating stress test

Returns base and stressed cash flow, DSCR, reserves, break-even vacancy and the fixed-seed correlated 750-sample distribution from the app. Shocked vacancy is an additive percentage-point change.

Open Rental Stress Test Calculator in HT Calc

This HT Calc screen includes a Pro sample for visitors.

Example result · state: available See output

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

Integration example

Make a request

Use a production key scoped to investor-operating-stress.

Keep the key on your server. A successful call uses 20 calculation credits.

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/investor-operating-stress";
const input = {
  "monthlyRent": 2500,
  "operatingExpenses": 450,
  "insurance": 100,
  "hoa": 50,
  "maintenanceReserve": 100,
  "debtService": 1000,
  "vacancyPct": 5,
  "vacancyShockPct": 5,
  "expenseIncreasePct": 10,
  "rentDropPct": 10,
  "reserveMonths": 6,
  "minimumDscr": 1.25
};
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/investor-operating-stress' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "monthlyRent": 2500,
  "operatingExpenses": 450,
  "insurance": 100,
  "hoa": 50,
  "maintenanceReserve": 100,
  "debtService": 1000,
  "vacancyPct": 5,
  "vacancyShockPct": 5,
  "expenseIncreasePct": 10,
  "rentDropPct": 10,
  "reserveMonths": 6,
  "minimumDscr": 1.25
}
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 investor-operating-stress.
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.

state
available
formulaVersion
stress-correlated-simulation-1.1.0
value.base.name
Base
How to interpret this result
  • Returns base and stressed cash flow, DSCR, reserves, break-even vacancy and the fixed-seed correlated 750-sample distribution from the app. Shocked vacancy is an additive percentage-point change.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "state": "available",
    "fieldErrors": {},
    "warnings": [],
    "assumptions": [
      {
        "key": "minimumDscr",
        "value": "1.25",
        "source": "user"
      },
      {
        "key": "simulationSeed",
        "value": "20260813",
        "source": "default"
      },
      {
        "key": "annualPropertyTax",
        "value": "0",
        "unit": "USD",
        "source": "default"
      }
    ],
    "provenance": [],
    "formulaVersion": "stress-correlated-simulation-1.1.0",
    "ruleVersions": [],
    "auditTrail": [
      "Correlation matrix passed symmetry, bounds, diagonal, and Cholesky positive-semidefinite checks.",
      "750 adverse-only correlated samples generated from seed 20260813.",
      "Compatibility adapter: legacy stress inputs feed a deterministic disclosed scenario and correlated 750-sample distribution."
    ],
    "value": {
      "base": {
        "name": "Base",
        "effectiveRevenue": "28500",
        "operatingExpenses": "8400",
        "noi": "20100",
        "dscr": "1.675",
        "endingReserves": "14100",
        "covenantBreaches": []
      },
      "scenarios": [
        {
          "name": "User stress case",
          "effectiveRevenue": "24300",
          "operatingExpenses": "9240",
          "noi": "15060",
          "dscr": "1.255",
          "endingReserves": "9060",
          "covenantBreaches": []
        }
      ],
      "simulation": {
        "p10": "1200.74",
        "p50": "4333.31",
        "p90": "6435.42",
        "seed": 20260813,
        "samples": 750
      },
      "tornado": [
        {
          "factor": "rent",
          "cashFlowImpact": "-2850"
        },
        {
          "factor": "vacancy",
          "cashFlowImpact": "-1500"
        },
        {
          "factor": "capex",
          "cashFlowImpact": "-660"
        },
        {
          "factor": "insurance",
          "cashFlowImpact": "-120"
        },
        {
          "factor": "hoa",
          "cashFlowImpact": "-60"
        },
        {
          "factor": "tax",
          "cashFlowImpact": "0"
        }
      ],
      "correlationValidated": true
    },
    "monthly": {
      "baseNoi": 1675,
      "baseCashFlow": 675,
      "stressedVacancyPct": 10,
      "stressedRent": 2250,
      "stressedExpenses": 770.0000000000001,
      "stressedNoi": 1255,
      "stressedCashFlow": 255,
      "breakEvenVacancyPct": 31.999999999999996,
      "reserveNeeded": 0,
      "survivesStress": true
    },
    "shown": {
      "collected": 2025,
      "costs": 770.0000000000001,
      "debtService": 1000,
      "stressedCashFlow": 255
    }
  },
  "formulaVersion": "stress-correlated-simulation-1.1.0",
  "units": {
    "monthlyRentAndCosts": "USD per month",
    "vacancyShockPct": "percentage points",
    "rentDropPct": "percent of rent",
    "expenseIncreasePct": "percent of cost",
    "reserveMonths": "months of debt service",
    "minimumDscr": "ratio",
    "monthly": "USD per month except percent and reserveNeeded (USD)",
    "simulation": "USD annual cash-flow percentiles",
    "endingReserves": "USD"
  },
  "assumptions": [
    "Returns base and stressed cash flow, DSCR, reserves, break-even vacancy and the fixed-seed correlated 750-sample distribution from the app. Shocked vacancy is an additive percentage-point change."
  ],
  "warnings": [],
  "creditCost": 20
}

Request contract

Accepted inputs

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

FieldType, units and limits

monthlyRentRequired
number

Scheduled gross rent, in USD per month before vacancy.

Min 0 · Max 1000000000
operatingExpensesRequired
number

Other operating costs excluding separately entered insurance, HOA and maintenance reserve, in USD per month.

Min 0 · Max 1000000000
insuranceRequired
number

Property insurance, in USD per month.

Min 0 · Max 1000000000
hoaRequired
number

Homeowners association fees, in USD per month.

Min 0 · Max 1000000000
maintenanceReserveRequired
number

Maintenance allowance charged as a property expense, in USD per month.

Min 0 · Max 1000000000
debtServiceRequired
number

Debt payment, in USD per month.

Min 0 · Max 1000000000
vacancyPctRequired
number

Uncollected share of scheduled rent, in percent (5 means 5%).

Min 0 · Max 100
vacancyShockPctRequired
number

Additional vacancy in percentage points, added to base vacancy (5 turns 10% into 15%).

Min 0 · Max 100
expenseIncreasePctRequired
number

Relative increase across operating expenses, in percent.

Min 0 · Max 100
rentDropPctRequired
number

Relative decrease in scheduled rental income, in percent.

Min 0 · Max 95
reserveMonthsRequired
number

Number of monthly debt payments used to size the starting reserve. Also sets the number of monthly shortfalls shown by the screen.

Min 0 · Max 120
minimumDscrOptional
number

Minimum ratio of annual net operating income to annual debt service (1.25 means 1.25×).

Min 0 · Max 100
Example request body (JSON)
{
  "monthlyRent": 2500,
  "operatingExpenses": 450,
  "insurance": 100,
  "hoa": 50,
  "maintenanceReserve": 100,
  "debtService": 1000,
  "vacancyPct": 5,
  "vacancyShockPct": 5,
  "expenseIncreasePct": 10,
  "rentDropPct": 10,
  "reserveMonths": 6,
  "minimumDscr": 1.25
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "monthlyRent": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "Scheduled gross rent, in USD per month before vacancy."
    },
    "operatingExpenses": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "Other operating costs excluding separately entered insurance, HOA and maintenance reserve, in USD per month."
    },
    "insurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "Property insurance, in USD per month."
    },
    "hoa": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "Homeowners association fees, in USD per month."
    },
    "maintenanceReserve": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "Maintenance allowance charged as a property expense, in USD per month."
    },
    "debtService": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "Debt payment, in USD per month."
    },
    "vacancyPct": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Uncollected share of scheduled rent, in percent (5 means 5%)."
    },
    "vacancyShockPct": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Additional vacancy in percentage points, added to base vacancy (5 turns 10% into 15%)."
    },
    "expenseIncreasePct": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Relative increase across operating expenses, in percent."
    },
    "rentDropPct": {
      "type": "number",
      "minimum": 0,
      "maximum": 95,
      "description": "Relative decrease in scheduled rental income, in percent."
    },
    "reserveMonths": {
      "type": "number",
      "minimum": 0,
      "maximum": 120,
      "description": "Number of monthly debt payments used to size the starting reserve. Also sets the number of monthly shortfalls shown by the screen."
    },
    "minimumDscr": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Minimum ratio of annual net operating income to annual debt service (1.25 means 1.25×)."
    }
  },
  "required": [
    "monthlyRent",
    "operatingExpenses",
    "insurance",
    "hoa",
    "maintenanceReserve",
    "debtService",
    "vacancyPct",
    "vacancyShockPct",
    "expenseIncreasePct",
    "rentDropPct",
    "reserveMonths"
  ],
  "additionalProperties": false,
  "description": "Returns base and stressed cash flow, DSCR, reserves, break-even vacancy and the fixed-seed correlated 750-sample distribution from the app. Shocked vacancy is an additive percentage-point change."
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/investor-operating-stress
Formula: stress-correlated-simulation-1.1.0

Related PDF reports