Skip to content

Mortgage · Calculation

ARM payment at the entered lifetime cap

Estimate monthly principal and interest at the current rate plus the maximum additional rate increase supplied by the caller.

Open Loan Estimate Analyzer in HT Calc

This HT Calc screen includes a Pro sample for visitors.

Example result · value: 3199.2888945386 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 arm-cap-payment.

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/arm-cap-payment";
const input = {
  "currentRate": 6.5,
  "lifetimeCap": 5,
  "balance": 300000,
  "monthsRemaining": 240
};
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/arm-cap-payment' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "currentRate": 6.5,
  "lifetimeCap": 5,
  "balance": 300000,
  "monthsRemaining": 240
}
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 arm-cap-payment.
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
3199.2888945386 USD/month
Full example response (JSON)
{
  "status": "available",
  "result": {
    "value": 3199.2888945386
  },
  "formulaVersion": "arm-cap-payment-htcalc-719df2c0e105",
  "units": {
    "value": "USD/month"
  },
  "assumptions": [],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

currentRateRequired
number

Current annual rate. In percentage points (6.5 means 6.5%).

Min 0 · Max 100
lifetimeCapRequired
number

Maximum further increase, in percentage points above currentRate.

Min 0 · Max 25
balanceRequired
number

Outstanding principal. In USD.

Min 1 · Max 100000000
monthsRemainingRequired
integer

Remaining term. In whole months.

Min 1 · Max 600
Example request body (JSON)
{
  "currentRate": 6.5,
  "lifetimeCap": 5,
  "balance": 300000,
  "monthsRemaining": 240
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "currentRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Current annual rate. In percentage points (6.5 means 6.5%).",
      "anyOf": [
        {
          "const": 0
        },
        {
          "minimum": 0.000001
        }
      ]
    },
    "lifetimeCap": {
      "type": "number",
      "minimum": 0,
      "maximum": 25,
      "description": "Maximum further increase, in percentage points above currentRate."
    },
    "balance": {
      "type": "number",
      "minimum": 1,
      "maximum": 100000000,
      "description": "Outstanding principal. In USD."
    },
    "monthsRemaining": {
      "type": "integer",
      "minimum": 1,
      "maximum": 600,
      "description": "Remaining term. In whole months."
    }
  },
  "required": [
    "currentRate",
    "lifetimeCap",
    "balance",
    "monthsRemaining"
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/arm-cap-payment
Formula: arm-cap-payment-htcalc-719df2c0e105