Skip to content

Real estate investing · Calculation

Debt service coverage ratio

Compare annual net operating income with annual debt service.

Related HT Calc tool: DSCR Calculator

The API divides annual net operating income by annual debt service. The related DSCR loan calculator models a property and its financing.

Example result · ratio: 1 ratio 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 dscr.

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/dscr";
const input = {
  "annualNoi": 100,
  "annualDebtService": 100
};
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/dscr' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "annualNoi": 100,
  "annualDebtService": 100
}
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 dscr.
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.

ratio
1 ratio
How to interpret this result
  • Annual NOI / annual debt service; arithmetic only, never lender qualification.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "ratio": 1
  },
  "formulaVersion": "dscr-metric-1.0.0",
  "units": {
    "ratio": "ratio"
  },
  "assumptions": [
    "Annual NOI / annual debt service; arithmetic only, never lender qualification."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

annualNoiRequired
number · USD/year

Annual net operating income. A loss may be negative.

Min -1000000000 · Max 1000000000 · Step 0.01
annualDebtServiceRequired
number · USD/year

Total debt payments for one year.

Min 0 · Max 1000000000 · Step 0.01
Example request body (JSON)
{
  "annualNoi": 100,
  "annualDebtService": 100
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "annualNoi": {
      "type": "number",
      "description": "Annual net operating income. A loss may be negative.",
      "x-unit": "USD/year",
      "minimum": -1000000000,
      "maximum": 1000000000,
      "multipleOf": 0.01,
      "x-core-refinement": true
    },
    "annualDebtService": {
      "type": "number",
      "description": "Total debt payments for one year.",
      "x-unit": "USD/year",
      "minimum": 0,
      "maximum": 1000000000,
      "multipleOf": 0.01,
      "x-core-refinement": true
    }
  },
  "required": [
    "annualNoi",
    "annualDebtService"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/dscr
Formula: dscr-metric-1.0.0

Related PDF reports