Skip to content

PDF report

True Rate comparison by loan program

True Rate comparison by loan program prepared from validated scenario inputs by the original HT Calc report builder.

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-program-comparison 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-program-comparison";
const input = {
  "quotes": [
    {
      "loanProgram": "conventional",
      "loanPurpose": "purchase",
      "homeValue": 350000,
      "loanAmount": 280000,
      "piPayment": 1770,
      "pmiPayment": 145,
      "remainingTermYears": 28,
      "currentRate": 0,
      "upfrontCosts": 1300,
      "discountPoints": 0,
      "lenderCredits": 0,
      "holdingPeriodYears": 5,
      "programFee": 0,
      "programFeeTreatment": "paidUpfront",
      "pmiCancellationMode": "auto78",
      "insuranceDurationMode": "auto",
      "pmiBasisValue": 350000
    },
    {
      "loanProgram": "fha",
      "loanPurpose": "purchase",
      "homeValue": 350000,
      "loanAmount": 280000,
      "piPayment": 1780,
      "pmiPayment": 120,
      "remainingTermYears": 28,
      "currentRate": 6.25,
      "upfrontCosts": 1300,
      "discountPoints": 0,
      "lenderCredits": 0,
      "holdingPeriodYears": 5,
      "programFee": 4900,
      "programFeeTreatment": "financed",
      "pmiCancellationMode": "auto78",
      "insuranceDurationMode": "auto",
      "pmiBasisValue": 350000,
      "fhaOriginalLtv": 80,
      "fhaOriginalTermYears": 30
    }
  ]
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-true-rate-program-comparison-" + 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-program-comparison-<requestId>.pdf.

Request contract

Accepted inputs

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

FieldType, units and limits

quotesRequired
array

One priced loan per program, with a common balance, home value and holding period.

Min items 2 · Max items 4
quotes[].loanProgramRequired
stringAllowed: "conventional", "fha", "va", "usda"
quotes[].loanPurposeRequired
stringAllowed: "purchase", "rateTermRefinance", "cashOutRefinance", "streamlineRefinance"
quotes[].homeValueRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
quotes[].loanAmountRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
quotes[].piPaymentRequired
number

Monthly P&I quoted or paid on this mortgage in USD.

Max 1000000000 · Greater than 0
quotes[].pmiPaymentRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
quotes[].remainingTermYearsRequired
integer

Whole years of payments.

Min 1 · Max 50
quotes[].currentRateRequired
number

Note rate in percent; zero asks the engine to infer it from P&I.

Min 0 · Max 100
quotes[].upfrontCostsRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
quotes[].discountPointsRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
quotes[].lenderCreditsRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
quotes[].holdingPeriodYearsRequired
integer

Whole years of payments.

Min 1 · Max 50
quotes[].programFeeRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
quotes[].programFeeTreatmentRequired
stringAllowed: "financed", "paidUpfront", "includedInBalance"
quotes[].pmiCancellationModeRequired
stringAllowed: "auto78", "request80", "fullTerm"
quotes[].insuranceDurationModeRequired
stringAllowed: "auto", "elevenYears", "fullTerm"
quotes[].pmiBasisValueRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
quotes[].fhaOriginalLtvOptional
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
quotes[].fhaOriginalTermYearsOptional
integer

Whole years of payments.

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

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
quotes[].usdaAnnualFeeRateOptional
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "quotes": [
      {
        "loanProgram": "conventional",
        "loanPurpose": "purchase",
        "homeValue": 350000,
        "loanAmount": 280000,
        "piPayment": 1770,
        "pmiPayment": 145,
        "remainingTermYears": 28,
        "currentRate": 0,
        "upfrontCosts": 1300,
        "discountPoints": 0,
        "lenderCredits": 0,
        "holdingPeriodYears": 5,
        "programFee": 0,
        "programFeeTreatment": "paidUpfront",
        "pmiCancellationMode": "auto78",
        "insuranceDurationMode": "auto",
        "pmiBasisValue": 350000
      },
      {
        "loanProgram": "fha",
        "loanPurpose": "purchase",
        "homeValue": 350000,
        "loanAmount": 280000,
        "piPayment": 1780,
        "pmiPayment": 120,
        "remainingTermYears": 28,
        "currentRate": 6.25,
        "upfrontCosts": 1300,
        "discountPoints": 0,
        "lenderCredits": 0,
        "holdingPeriodYears": 5,
        "programFee": 4900,
        "programFeeTreatment": "financed",
        "pmiCancellationMode": "auto78",
        "insuranceDurationMode": "auto",
        "pmiBasisValue": 350000,
        "fhaOriginalLtv": 80,
        "fhaOriginalTermYears": 30
      }
    ]
  }
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "quotes": {
      "minItems": 2,
      "maxItems": 4,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "loanProgram": {
            "type": "string",
            "enum": [
              "conventional",
              "fha",
              "va",
              "usda"
            ]
          },
          "loanPurpose": {
            "type": "string",
            "enum": [
              "purchase",
              "rateTermRefinance",
              "cashOutRefinance",
              "streamlineRefinance"
            ]
          },
          "homeValue": {
            "type": "number",
            "exclusiveMinimum": 0,
            "maximum": 1000000000,
            "description": "US dollars, greater than zero."
          },
          "loanAmount": {
            "type": "number",
            "exclusiveMinimum": 0,
            "maximum": 1000000000,
            "description": "US dollars, greater than zero."
          },
          "piPayment": {
            "type": "number",
            "exclusiveMinimum": 0,
            "maximum": 1000000000,
            "description": "Monthly P&I quoted or paid on this mortgage in USD."
          },
          "pmiPayment": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars; enter zero when this cost is absent."
          },
          "remainingTermYears": {
            "type": "integer",
            "minimum": 1,
            "maximum": 50,
            "description": "Whole years of payments."
          },
          "currentRate": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Note rate in percent; zero asks the engine to infer it from P&I."
          },
          "upfrontCosts": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars; enter zero when this cost is absent."
          },
          "discountPoints": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Percentage points (6.5 means 6.5%)."
          },
          "lenderCredits": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars; enter zero when this cost is absent."
          },
          "holdingPeriodYears": {
            "type": "integer",
            "minimum": 1,
            "maximum": 50,
            "description": "Whole years of payments."
          },
          "programFee": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars; enter zero when this cost is absent."
          },
          "programFeeTreatment": {
            "type": "string",
            "enum": [
              "financed",
              "paidUpfront",
              "includedInBalance"
            ]
          },
          "pmiCancellationMode": {
            "type": "string",
            "enum": [
              "auto78",
              "request80",
              "fullTerm"
            ]
          },
          "insuranceDurationMode": {
            "type": "string",
            "enum": [
              "auto",
              "elevenYears",
              "fullTerm"
            ]
          },
          "pmiBasisValue": {
            "type": "number",
            "exclusiveMinimum": 0,
            "maximum": 1000000000,
            "description": "US dollars, greater than zero."
          },
          "fhaOriginalLtv": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Percentage points (6.5 means 6.5%)."
          },
          "fhaOriginalTermYears": {
            "type": "integer",
            "minimum": 1,
            "maximum": 50,
            "description": "Whole years of payments."
          },
          "vaFundingFeeUse": {
            "type": "string",
            "enum": [
              "first",
              "subsequent",
              "irrrl",
              "exempt",
              "manual"
            ]
          },
          "vaDownPaymentPercent": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Percentage points (6.5 means 6.5%)."
          },
          "usdaAnnualFeeRate": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Percentage points (6.5 means 6.5%)."
          }
        },
        "required": [
          "loanProgram",
          "loanPurpose",
          "homeValue",
          "loanAmount",
          "piPayment",
          "pmiPayment",
          "remainingTermYears",
          "currentRate",
          "upfrontCosts",
          "discountPoints",
          "lenderCredits",
          "holdingPeriodYears",
          "programFee",
          "programFeeTreatment",
          "pmiCancellationMode",
          "insuranceDurationMode",
          "pmiBasisValue"
        ],
        "additionalProperties": false
      },
      "description": "One priced loan per program, with a common balance, home value and holding period."
    }
  },
  "required": [
    "quotes"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-true-rate-program-comparison
Formula: prepare-mortgage-true-rate-comparison-1.0.0 · Report version: 1.0.0