Skip to content

Mortgage · Calculation

Mortgage purchase program comparison

Compare modeled down payments, financed balances and housing payments under the worksheet's conventional, FHA and VA presets. The scenario flags describe the worksheet assumptions only.

Example result · conventional.program: conventional 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 purchase-program-scenarios.

Keep the key on your server. A successful call uses 2 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/purchase-program-scenarios";
const input = {
  "inputs": {
    "homePrice": 300000,
    "interestRate": 6,
    "loanTerm": 30,
    "annualIncome": 90000,
    "monthlyDebts": 500,
    "propertyTaxRate": 1.2,
    "insuranceRate": 0.4
  },
  "programs": [
    "conventional",
    "fha",
    "va"
  ]
};
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/purchase-program-scenarios' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "inputs": {
    "homePrice": 300000,
    "interestRate": 6,
    "loanTerm": 30,
    "annualIncome": 90000,
    "monthlyDebts": 500,
    "propertyTaxRate": 1.2,
    "insuranceRate": 0.4
  },
  "programs": [
    "conventional",
    "fha",
    "va"
  ]
}
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 purchase-program-scenarios.
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.

conventional.program
conventional
conventional.label
Conventional
conventional.homePrice
300000
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": {
    "conventional": {
      "program": "conventional",
      "label": "Conventional",
      "homePrice": 300000,
      "baseLoanAmount": 285000,
      "financedLoanAmount": 285000,
      "downPaymentCash": 15000,
      "downPaymentPercent": 5,
      "ltv": 95,
      "upfrontFee": 0,
      "upfrontFeeRate": 0,
      "monthlyPrincipalAndInterest": 1708.72,
      "monthlyTax": 300,
      "monthlyInsurance": 100,
      "monthlyMortgageInsurance": 118.75,
      "totalMonthlyPayment": 2227.47,
      "requiredAnnualIncome": 53459.26,
      "maxDti": 50,
      "minDownPaymentPercent": 5,
      "programEligible": true,
      "eligibilityIssues": [],
      "actualDti": 36.37,
      "qualifies": true,
      "maxQualifyingRate": null,
      "additionalDownPaymentNeeded": 0,
      "details": {
        "principalAndInterest": 1708.7189966853,
        "monthlyTax": 300,
        "monthlyInsurance": 100,
        "monthlyPMI": 118.75,
        "monthlyPayment": 2227.4689966853,
        "monthlyPrincipal": 283.7189966853,
        "monthlyInterest": 1425,
        "totalPayment": 774456.78,
        "totalFinancingPayment": 615138.03,
        "totalInterest": 330138.03,
        "loanAmount": 285000,
        "upfrontFees": 0,
        "originationFeeAmount": 0,
        "feeDeductedFromProceeds": 0,
        "capitalizedInterest": 0,
        "businessDscr": 0,
        "pmiMonths": 129
      }
    },
    "fha": {
      "program": "fha",
      "label": "FHA",
      "homePrice": 300000,
      "baseLoanAmount": 289500,
      "financedLoanAmount": 294566.25,
      "downPaymentCash": 10500,
      "downPaymentPercent": 3.5,
      "ltv": 96.5,
      "upfrontFee": 5066.25,
      "upfrontFeeRate": 0.0175,
      "monthlyPrincipalAndInterest": 1766.07,
      "monthlyTax": 300,
      "monthlyInsurance": 100,
      "monthlyMortgageInsurance": 135.01,
      "totalMonthlyPayment": 2301.08,
      "requiredAnnualIncome": 48443.85,
      "maxDti": 57,
      "minDownPaymentPercent": 3.5,
      "programEligible": true,
      "eligibilityIssues": [],
      "actualDti": 37.35,
      "qualifies": true,
      "maxQualifyingRate": null,
      "additionalDownPaymentNeeded": 0,
      "details": {
        "principalAndInterest": 1766.0734987978,
        "monthlyTax": 300,
        "monthlyInsurance": 100,
        "monthlyPMI": 135.00953125,
        "monthlyPayment": 2301.0830300478,
        "monthlyPrincipal": 293.24224879780013,
        "monthlyInterest": 1472.83125,
        "totalPayment": 828392.26125,
        "totalFinancingPayment": 635788.8300000001,
        "totalInterest": 341222.58,
        "loanAmount": 294566.25,
        "upfrontFees": 0,
        "originationFeeAmount": 0,
        "feeDeductedFromProceeds": 0,
        "capitalizedInterest": 0,
        "businessDscr": 0,
        "pmiMonths": 360
      }
    },
    "va": {
      "program": "va",
      "label": "VA",
      "homePrice": 300000,
      "baseLoanAmount": 300000,
      "financedLoanAmount": 306450,
      "downPaymentCash": 0,
      "downPaymentPercent": 0,
      "ltv": 100,
      "upfrontFee": 6450,
      "upfrontFeeRate": 0.0215,
      "monthlyPrincipalAndInterest": 1837.32,
      "monthlyTax": 300,
      "monthlyInsurance": 100,
      "monthlyMortgageInsurance": 0,
      "totalMonthlyPayment": 2237.32,
      "requiredAnnualIncome": 44746.45,
      "maxDti": 60,
      "minDownPaymentPercent": 0,
      "programEligible": true,
      "eligibilityIssues": [],
      "actualDti": 36.5,
      "qualifies": true,
      "maxQualifyingRate": null,
      "additionalDownPaymentNeeded": 0,
      "details": {
        "principalAndInterest": 1837.3225843306,
        "monthlyTax": 300,
        "monthlyInsurance": 100,
        "monthlyPMI": 0,
        "monthlyPayment": 2237.3225843306,
        "monthlyPrincipal": 305.07258433059997,
        "monthlyInterest": 1532.25,
        "totalPayment": 805437.71,
        "totalFinancingPayment": 661437.71,
        "totalInterest": 354987.71,
        "loanAmount": 306450,
        "upfrontFees": 0,
        "originationFeeAmount": 0,
        "feeDeductedFromProceeds": 0,
        "capitalizedInterest": 0,
        "businessDscr": 0
      }
    }
  },
  "formulaVersion": "purchase-program-scenarios-htcalc-719df2c0e105",
  "units": {
    "conventional.monthlyTax": "USD/month",
    "fha.financedLoanAmount": "USD",
    "va.downPaymentCash": "USD",
    "fha.monthlyMortgageInsurance": "USD/month"
  },
  "assumptions": [
    "HT Calc policy snapshot 719df2c, November 2026. Program comparisons are planning estimates. A lender determines underwriting and eligibility."
  ],
  "warnings": [],
  "creditCost": 2
}

Request contract

Accepted inputs

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

FieldType, units and limits

inputsRequired
object
inputs.homePriceRequired
number

Positive US dollars

Min 0.01 · Max 1000000000
inputs.interestRateRequired
number

Annual note rate in percent; 6 means 6%

Min 0 · Max 50
inputs.loanTermRequired
integer

Whole years

Min 1 · Max 50
inputs.annualIncomeRequired
number

US dollars per year

Min 0 · Max 1000000000
inputs.monthlyDebtsRequired
number

US dollars per month

Min 0 · Max 100000000
inputs.propertyTaxRateRequired
number

Percent; 5 means 5%

Min 0 · Max 100
inputs.insuranceRateRequired
number

Percent; 5 means 5%

Min 0 · Max 100
programsRequired
arrayMin items 1 · Max items 3
Example request body (JSON)
{
  "inputs": {
    "homePrice": 300000,
    "interestRate": 6,
    "loanTerm": 30,
    "annualIncome": 90000,
    "monthlyDebts": 500,
    "propertyTaxRate": 1.2,
    "insuranceRate": 0.4
  },
  "programs": [
    "conventional",
    "fha",
    "va"
  ]
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "inputs": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "homePrice": {
          "type": "number",
          "minimum": 0.01,
          "maximum": 1000000000,
          "description": "Positive US dollars"
        },
        "interestRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 50,
          "description": "Annual note rate in percent; 6 means 6%"
        },
        "loanTerm": {
          "type": "integer",
          "minimum": 1,
          "maximum": 50,
          "description": "Whole years"
        },
        "annualIncome": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "US dollars per year"
        },
        "monthlyDebts": {
          "type": "number",
          "minimum": 0,
          "maximum": 100000000,
          "description": "US dollars per month"
        },
        "propertyTaxRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 100,
          "description": "Percent; 5 means 5%"
        },
        "insuranceRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 100,
          "description": "Percent; 5 means 5%"
        }
      },
      "required": [
        "homePrice",
        "interestRate",
        "loanTerm",
        "annualIncome",
        "monthlyDebts",
        "propertyTaxRate",
        "insuranceRate"
      ]
    },
    "programs": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "conventional",
          "fha",
          "va"
        ]
      },
      "minItems": 1,
      "maxItems": 3
    }
  },
  "required": [
    "inputs",
    "programs"
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/purchase-program-scenarios
Formula: purchase-program-scenarios-htcalc-719df2c0e105

Method and sources

Conventional, FHA and VA model presets share the supplied price and term. Any qualifies/programEligible output is a worksheet flag, not underwriting, available pricing or actual eligibility.

Reviewed .