Mortgage · Calculation
Compare mortgage payment paths
Compare disclosed scheduled payments and upfront costs for fixed, initially fixed ARM and full-term interest-only loans.
This HT Calc screen includes a Pro sample for visitors.
Example result · horizonMonths: 12 See output
- Cost per success
- 2 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 loan-product-payment-paths.
Keep the key on your server. A successful call uses 2 calculation credits.
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/loan-product-payment-paths";
const input = {
"options": [
{
"loanType": "fixed",
"loanAmount": 180000,
"termYears": 20,
"monthlyPI": 1000,
"closingCosts": 1000,
"discountPoints": 0,
"lenderCredits": 0
},
{
"loanType": "fixed",
"loanAmount": 180000,
"termYears": 20,
"monthlyPI": 1100,
"closingCosts": 0,
"discountPoints": 0,
"lenderCredits": 0
},
{
"loanType": "arm",
"loanAmount": 180000,
"termYears": 20,
"monthlyPI": 950,
"closingCosts": 1000,
"discountPoints": 0,
"lenderCredits": 0,
"armInitialMonths": 6
}
],
"horizonMonths": 12
};
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/loan-product-payment-paths' \
--header "Authorization: Bearer $HT_PRODUCTION_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"options": [
{
"loanType": "fixed",
"loanAmount": 180000,
"termYears": 20,
"monthlyPI": 1000,
"closingCosts": 1000,
"discountPoints": 0,
"lenderCredits": 0
},
{
"loanType": "fixed",
"loanAmount": 180000,
"termYears": 20,
"monthlyPI": 1100,
"closingCosts": 0,
"discountPoints": 0,
"lenderCredits": 0
},
{
"loanType": "arm",
"loanAmount": 180000,
"termYears": 20,
"monthlyPI": 950,
"closingCosts": 1000,
"discountPoints": 0,
"lenderCredits": 0,
"armInitialMonths": 6
}
],
"horizonMonths": 12
}
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
loan-product-payment-paths. 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.
horizonMonths- 12
How to interpret this result
- Enter scheduled P&I from the offer; for interest-only enter the monthly interest charge. Closing costs exclude separately entered dollar points and credits.
- Fixed denotes a fully amortizing nonballoon loan. Interest-only denotes interest for its entire term with original principal paid at maturity. ARM amounts after the supplied initial period are unknown.
- Crossovers are reported through the requested horizon between two known fixed or interest-only paths. Outlay excludes escrows, insurance, and equity.
Full example response (JSON)
{
"status": "available",
"result": {
"horizonMonths": 12,
"paths": [
{
"optionIndex": 0,
"upfront": 1000,
"horizon": 13000,
"knownThroughMonth": 240,
"maturity": 241000
},
{
"optionIndex": 1,
"upfront": 0,
"horizon": 13200,
"knownThroughMonth": 240,
"maturity": 264000
},
{
"optionIndex": 2,
"upfront": 1000,
"horizon": null,
"knownThroughMonth": 6,
"maturity": null
}
],
"crossovers": [
{
"firstOption": 0,
"secondOption": 1,
"month": 10
}
]
},
"formulaVersion": "loan-product-payment-paths-htcalc-719df2c0e105",
"units": {
"paths[].upfront": "USD",
"paths[].horizon": "USD or null",
"paths[].maturity": "USD or null",
"paths[].knownThroughMonth": "months",
"crossovers[].month": "months"
},
"assumptions": [
"Enter scheduled P&I from the offer; for interest-only enter the monthly interest charge. Closing costs exclude separately entered dollar points and credits.",
"Fixed denotes a fully amortizing nonballoon loan. Interest-only denotes interest for its entire term with original principal paid at maturity. ARM amounts after the supplied initial period are unknown.",
"Crossovers are reported through the requested horizon between two known fixed or interest-only paths. Outlay excludes escrows, insurance, and equity."
],
"warnings": [],
"creditCost": 2
}Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
optionsRequiredoptions[].loanTypeRequiredoptions[].loanAmountRequiredoptions[].termYearsRequiredoptions[].monthlyPIRequiredoptions[].closingCostsRequiredoptions[].discountPointsRequiredoptions[].lenderCreditsRequiredoptions[].armInitialMonthsConditionalhorizonMonthsRequiredExample request body (JSON)
{
"options": [
{
"loanType": "fixed",
"loanAmount": 180000,
"termYears": 20,
"monthlyPI": 1000,
"closingCosts": 1000,
"discountPoints": 0,
"lenderCredits": 0
},
{
"loanType": "fixed",
"loanAmount": 180000,
"termYears": 20,
"monthlyPI": 1100,
"closingCosts": 0,
"discountPoints": 0,
"lenderCredits": 0
},
{
"loanType": "arm",
"loanAmount": 180000,
"termYears": 20,
"monthlyPI": 950,
"closingCosts": 1000,
"discountPoints": 0,
"lenderCredits": 0,
"armInitialMonths": 6
}
],
"horizonMonths": 12
} Full JSON schema
{
"type": "object",
"properties": {
"options": {
"type": "array",
"minItems": 2,
"maxItems": 5,
"items": {
"type": "object",
"properties": {
"loanType": {
"type": "string",
"enum": [
"fixed",
"arm",
"interest-only"
]
},
"loanAmount": {
"type": "number",
"minimum": 0.01,
"maximum": 100000000
},
"termYears": {
"type": "integer",
"minimum": 1,
"maximum": 40
},
"monthlyPI": {
"type": "number",
"minimum": 0,
"maximum": 1000000
},
"closingCosts": {
"type": "number",
"minimum": 0,
"maximum": 100000000
},
"discountPoints": {
"type": "number",
"minimum": 0,
"maximum": 100000000
},
"lenderCredits": {
"type": "number",
"minimum": 0,
"maximum": 100000000
},
"armInitialMonths": {
"type": "integer",
"minimum": 1,
"maximum": 480
}
},
"required": [
"loanType",
"loanAmount",
"termYears",
"monthlyPI",
"closingCosts",
"discountPoints",
"lenderCredits"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"loanType": {
"const": "arm"
}
}
},
"then": {
"required": [
"armInitialMonths"
]
}
},
{
"if": {
"properties": {
"loanType": {
"enum": [
"fixed",
"arm"
]
}
}
},
"then": {
"properties": {
"monthlyPI": {
"exclusiveMinimum": 0,
"type": "number"
}
}
}
}
]
}
},
"horizonMonths": {
"type": "integer",
"minimum": 0,
"maximum": 480
}
},
"required": [
"options",
"horizonMonths"
],
"additionalProperties": false
}Production endpoint: POST https://calc.hasstechapi.com/v2/calc/loan-product-payment-paths
Formula: loan-product-payment-paths-htcalc-719df2c0e105