Skip to content

Mortgage · Calculation

Monthly obligations under a selected debt treatment

Aggregate supplied debts using a selected program scenario and its model rules for short installments, student loans and missing revolving minimums.

Example result · value: 200 USD/month 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 mortgage-debt-treatment.

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/mortgage-debt-treatment";
const input = {
  "debts": [
    {
      "debt_type": "student",
      "current_balance": 15000,
      "monthly_payment": 0
    },
    {
      "debt_type": "credit_card",
      "current_balance": 1000,
      "monthly_payment": 0
    }
  ],
  "program": "CONVENTIONAL",
  "grossMonthlyIncome": 6000
};
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/mortgage-debt-treatment' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "debts": [
    {
      "debt_type": "student",
      "current_balance": 15000,
      "monthly_payment": 0
    },
    {
      "debt_type": "credit_card",
      "current_balance": 1000,
      "monthly_payment": 0
    }
  ],
  "program": "CONVENTIONAL",
  "grossMonthlyIncome": 6000
}
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 mortgage-debt-treatment.
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.

value
200 USD/month
How to interpret this result
  • HT Calc policy snapshot 719df2c, November 2026. Program comparisons are planning estimates. A lender determines underwriting and eligibility.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "value": 200
  },
  "formulaVersion": "mortgage-debt-treatment-htcalc-719df2c0e105",
  "units": {
    "value": "USD/month"
  },
  "assumptions": [
    "HT Calc policy snapshot 719df2c, November 2026. Program comparisons are planning estimates. A lender determines underwriting and eligibility."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

debtsRequired
arrayMin items 0 · Max items 100
debts[].debt_typeRequired
stringAllowed: "auto", "student", "credit_card", "personal", "medical", "collections", "other"
debts[].current_balanceRequired
number

US dollars

Min 0 · Max 1000000000
debts[].monthly_paymentRequired
number

US dollars per month

Min 0 · Max 100000000
debts[].months_remainingOptional
integer

Whole remaining installments

Min 0 · Max 600
debts[].is_excluded_from_dtiOptional
boolean
debts[].will_pay_offOptional
boolean
debts[].imputed_payment_amountOptional
number

US dollars per month

Min 0 · Max 100000000
debts[].descriptionOptional
stringMin length 0 · Max length 140
debts[].detailsOptional
object
debts[].details.notesOptional
stringMin length 0 · Max length 300
programRequired
stringAllowed: "FHA", "CONVENTIONAL", "VA", "USDA", "GENERIC"
grossMonthlyIncomeRequired
number

US dollars per month

Min 0 · Max 100000000
Example request body (JSON)
{
  "debts": [
    {
      "debt_type": "student",
      "current_balance": 15000,
      "monthly_payment": 0
    },
    {
      "debt_type": "credit_card",
      "current_balance": 1000,
      "monthly_payment": 0
    }
  ],
  "program": "CONVENTIONAL",
  "grossMonthlyIncome": 6000
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "debts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "debt_type": {
            "type": "string",
            "enum": [
              "auto",
              "student",
              "credit_card",
              "personal",
              "medical",
              "collections",
              "other"
            ]
          },
          "current_balance": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars"
          },
          "monthly_payment": {
            "type": "number",
            "minimum": 0,
            "maximum": 100000000,
            "description": "US dollars per month"
          },
          "months_remaining": {
            "type": "integer",
            "minimum": 0,
            "maximum": 600,
            "description": "Whole remaining installments"
          },
          "is_excluded_from_dti": {
            "type": "boolean"
          },
          "will_pay_off": {
            "type": "boolean"
          },
          "imputed_payment_amount": {
            "type": "number",
            "minimum": 0,
            "maximum": 100000000,
            "description": "US dollars per month"
          },
          "description": {
            "type": "string",
            "minLength": 0,
            "maxLength": 140,
            "pattern": "^[^\\u0000-\\u001f\\u007f]*$"
          },
          "details": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "notes": {
                "type": "string",
                "minLength": 0,
                "maxLength": 300,
                "pattern": "^[^\\u0000-\\u001f\\u007f]*$"
              }
            },
            "required": []
          }
        },
        "required": [
          "debt_type",
          "current_balance",
          "monthly_payment"
        ]
      },
      "minItems": 0,
      "maxItems": 100
    },
    "program": {
      "type": "string",
      "enum": [
        "FHA",
        "CONVENTIONAL",
        "VA",
        "USDA",
        "GENERIC"
      ]
    },
    "grossMonthlyIncome": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000000,
      "description": "US dollars per month"
    }
  },
  "required": [
    "debts",
    "program",
    "grossMonthlyIncome"
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/mortgage-debt-treatment
Formula: mortgage-debt-treatment-htcalc-719df2c0e105

Method and sources

Model timing and inclusion of manually reported non-housing debt, payments, and a selected program, including imputed minimums. No credit file or actual lender determination.

Reviewed .