Skip to content

PDF report

Cost-adjusted mortgage rate

Cost-adjusted mortgage rate with the calculator’s supporting assumptions and breakdown.

Open Conventional True Rate Calculator in HT Calc

This HT Calc screen includes a Pro sample for visitors.

Cost per success
2 calculation credits + 1 PDF report
Production plans
Business, Scale, Enterprise
Plan allowances
Free sandbox
Not available

Integration example

Request a PDF

Before your first report

  1. Open Widgets & reports in your paid workspace. Save your brand name, accent and at least one exact HTTPS origin, such as https://app.example.com. The origins identify sites allowed to embed your widgets.
  2. Under Report credentials, name a credential, select mortgage-true-rate and choose Create report credential. Save the secret shown once in your server’s HT_REPORT_KEY.
  3. Run the example on your server against accounts.hasstechapi.com, without an Origin header. A successful request returns a PDF and uses 2 calculation credits and 1 PDF report. Running the example again starts a new paid request.
What if the PDF doesn’t arrive?

For 400 INVALID_INPUT, inspect error.details when present. Paths for template fields start with input. Fix the indicated field and send a new request. This validation error uses zero credits and zero reports.

Open the .pdf.request.json file the example saved before sending. Within 24 hours, open Request lookup in the same workspace, choose Production, and paste the file’s requestId. The response’s X-Request-Id is a separate support identifier.

A settled request shows the calculation credits and report used. The service doesn’t keep the PDF for download. Check your saved file first. A replacement with a new ID uses 2 calculation credits and 1 PDF report on success.

If the outcome is unclear, check the workspace and ID, then look it up again before requesting a replacement.

Download the production PDF

Set HT_REPORT_KEY on your server. Save as example.mjs and run node example.mjs with Node.js 18 or later.

import { randomUUID } from "node:crypto";
import { writeFile } from "node:fs/promises";

const key = process.env.HT_REPORT_KEY;
if (!key) throw new Error("Set HT_REPORT_KEY on your server.");
const endpoint = "https://accounts.hasstechapi.com/v2/reports/mortgage-true-rate";
const input = {
  "loanProgram": "conventional",
  "loanPurpose": "purchase",
  "homeValue": 300000,
  "loanAmount": 240000,
  "piPayment": 1438.92,
  "pmiPayment": 0,
  "remainingTermYears": 30,
  "currentRate": 6,
  "upfrontCosts": 1000,
  "discountPoints": 1,
  "lenderCredits": 400,
  "programFee": 0,
  "pmiCancellationMode": "auto78",
  "insuranceDurationMode": "auto",
  "pmiBasisValue": 300000,
  "fhaOriginalLtv": 80,
  "fhaOriginalTermYears": 30,
  "vaFundingFeeUse": "manual",
  "vaDownPaymentPercent": 20,
  "usdaAnnualFeeRate": 0.35,
  "programFeeTreatment": "paidUpfront",
  "holdingPeriodYears": 5
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-true-rate-" + requestId + ".pdf";
await writeFile(output + ".request.json", JSON.stringify({ requestId, endpoint }), {
  flag: "wx", mode: 0o600
});
console.error("Usage lookup ID:", requestId);

const response = await fetch(endpoint, {
  method: "POST",
  redirect: "error",
  headers: {
    "Authorization": "Bearer " + key,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ requestId, 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 {
  if (response.headers.get("content-type")?.split(";")[0] !== "application/pdf") {
    throw new Error("Expected a PDF. Look up request " + requestId);
  }
  await writeFile(output, new Uint8Array(await response.arrayBuffer()), { flag: "wx" });
  console.log("Saved", output);
}

Output

PDF output

A successful request returns the PDF file as application/pdf. The example writes a file named mortgage-true-rate-<requestId>.pdf.

See the Mortgage effective borrowing rate calculation and example result.

Request contract

Accepted inputs

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

FieldType, units and limits

loanProgramRequired
stringAllowed: "conventional", "fha", "va", "usda"
loanPurposeRequired
stringAllowed: "purchase", "rateTermRefinance", "cashOutRefinance", "streamlineRefinance"
homeValueRequired
number

Positive US dollars

Min 0.01 · Max 1000000000 · Greater than 0
loanAmountRequired
number

Positive US dollars

Min 0.01 · Max 1000000000 · Greater than 0
piPaymentRequired
number

Scheduled principal and interest in US dollars per month

Min 0.01 · Max 100000000 · Greater than 0
pmiPaymentRequired
number

US dollars per month

Min 0 · Max 100000000
remainingTermYearsRequired
integer

Years remaining, including fractional years

Min 1 · Max 50
currentRateRequired
number

Annual note rate in percent; 6 means 6%

Min 0 · Max 50
upfrontCostsRequired
number

US dollars

Min 0 · Max 1000000000
discountPointsRequired
number

Discount points as a percent of the loan

Min 0 · Max 25
lenderCreditsRequired
number

US dollars

Min 0 · Max 1000000000
programFeeRequired
number

US dollars

Min 0 · Max 1000000000
pmiCancellationModeRequired
stringAllowed: "auto78", "request80", "fullTerm"
insuranceDurationModeRequired
stringAllowed: "auto", "elevenYears", "fullTerm"
pmiBasisValueRequired
number

Positive US dollars

Min 0.01 · Max 1000000000 · Greater than 0
fhaOriginalLtvOptional
number

Original loan-to-value in percent

Min 0.01 · Max 100
fhaOriginalTermYearsOptional
integer

Whole years

Min 1 · Max 50
vaFundingFeeUseOptional
stringAllowed: "first", "subsequent", "irrrl", "exempt", "manual"
vaDownPaymentPercentOptional
number

Percent; 5 means 5%

Min 0 · Max 100
usdaAnnualFeeRateOptional
number

Percent; 5 means 5%

Min 0 · Max 100
programFeeTreatmentRequired
stringAllowed: "financed", "paidUpfront", "includedInBalance"
holdingPeriodYearsRequired
integer

Holding period, in years

Min 1 · Max 50
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "loanProgram": "conventional",
    "loanPurpose": "purchase",
    "homeValue": 300000,
    "loanAmount": 240000,
    "piPayment": 1438.92,
    "pmiPayment": 0,
    "remainingTermYears": 30,
    "currentRate": 6,
    "upfrontCosts": 1000,
    "discountPoints": 1,
    "lenderCredits": 400,
    "programFee": 0,
    "pmiCancellationMode": "auto78",
    "insuranceDurationMode": "auto",
    "pmiBasisValue": 300000,
    "fhaOriginalLtv": 80,
    "fhaOriginalTermYears": 30,
    "vaFundingFeeUse": "manual",
    "vaDownPaymentPercent": 20,
    "usdaAnnualFeeRate": 0.35,
    "programFeeTreatment": "paidUpfront",
    "holdingPeriodYears": 5
  }
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "loanProgram": {
      "type": "string",
      "enum": [
        "conventional",
        "fha",
        "va",
        "usda"
      ]
    },
    "loanPurpose": {
      "type": "string",
      "enum": [
        "purchase",
        "rateTermRefinance",
        "cashOutRefinance",
        "streamlineRefinance"
      ]
    },
    "homeValue": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "Positive US dollars",
      "exclusiveMinimum": 0
    },
    "loanAmount": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "Positive US dollars",
      "exclusiveMinimum": 0
    },
    "piPayment": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 100000000,
      "description": "Scheduled principal and interest in US dollars per month",
      "exclusiveMinimum": 0
    },
    "pmiPayment": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000000,
      "description": "US dollars per month"
    },
    "remainingTermYears": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Years remaining, including fractional years"
    },
    "currentRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 50,
      "description": "Annual note rate in percent; 6 means 6%"
    },
    "upfrontCosts": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "discountPoints": {
      "type": "number",
      "minimum": 0,
      "maximum": 25,
      "description": "Discount points as a percent of the loan"
    },
    "lenderCredits": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "programFee": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "pmiCancellationMode": {
      "type": "string",
      "enum": [
        "auto78",
        "request80",
        "fullTerm"
      ]
    },
    "insuranceDurationMode": {
      "type": "string",
      "enum": [
        "auto",
        "elevenYears",
        "fullTerm"
      ]
    },
    "pmiBasisValue": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "Positive US dollars",
      "exclusiveMinimum": 0
    },
    "fhaOriginalLtv": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 100,
      "description": "Original loan-to-value in percent"
    },
    "fhaOriginalTermYears": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Whole years"
    },
    "vaFundingFeeUse": {
      "type": "string",
      "enum": [
        "first",
        "subsequent",
        "irrrl",
        "exempt",
        "manual"
      ]
    },
    "vaDownPaymentPercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "usdaAnnualFeeRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "programFeeTreatment": {
      "type": "string",
      "enum": [
        "financed",
        "paidUpfront",
        "includedInBalance"
      ]
    },
    "holdingPeriodYears": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Holding period, in years"
    }
  },
  "required": [
    "loanProgram",
    "loanPurpose",
    "homeValue",
    "loanAmount",
    "piPayment",
    "pmiPayment",
    "remainingTermYears",
    "currentRate",
    "upfrontCosts",
    "discountPoints",
    "lenderCredits",
    "holdingPeriodYears",
    "programFee",
    "programFeeTreatment",
    "pmiCancellationMode",
    "insuranceDurationMode",
    "pmiBasisValue"
  ]
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-true-rate
Formula: mortgage-true-rate-htcalc-719df2c0e105 · Report version: 1.0.0

Method and sources

Model an entered quote and its holding-period cost; optional note rate can be inferred. Accept rounded P&I. Effective net proceeds must be positive. Four program modes share one contract.

Reviewed .