Skip to content

PDF report

Loan type comparison

Loan type comparison prepared from validated scenario inputs by the original HT Calc report builder.

Open Loan Estimate Analyzer 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-loan-type-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-loan-type-comparison";
const input = {
  "options": [
    {
      "productName": "30-year fixed",
      "loanAmount": 300000,
      "interestRate": 6.75,
      "termYears": 30,
      "loanType": "fixed",
      "discountPoints": 0,
      "closingCosts": 4000,
      "lenderCredits": 0
    },
    {
      "productName": "15-year fixed",
      "loanAmount": 300000,
      "interestRate": 6,
      "termYears": 15,
      "loanType": "fixed",
      "discountPoints": 0,
      "closingCosts": 4000,
      "lenderCredits": 0
    }
  ]
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-loan-type-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-loan-type-comparison-<requestId>.pdf.

Request contract

Accepted inputs

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

FieldType, units and limits

optionsRequired
arrayMin items 2 · Max items 4
options[].productNameRequired
string

Short plain-text scenario label.

Min length 1 · Max length 64
options[].loanAmountRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
options[].interestRateRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
options[].termYearsRequired
integer

Whole years of payments.

Min 1 · Max 50
options[].loanTypeRequired
stringAllowed: "fixed", "arm", "interest-only"
options[].armInitialMonthsOptional
integer

Whole months of payments.

Min 1 · Max 600
options[].armAdjustmentCapOptional
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
options[].armLifetimeCapOptional
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
options[].discountPointsRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
options[].closingCostsRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
options[].lenderCreditsRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "options": [
      {
        "productName": "30-year fixed",
        "loanAmount": 300000,
        "interestRate": 6.75,
        "termYears": 30,
        "loanType": "fixed",
        "discountPoints": 0,
        "closingCosts": 4000,
        "lenderCredits": 0
      },
      {
        "productName": "15-year fixed",
        "loanAmount": 300000,
        "interestRate": 6,
        "termYears": 15,
        "loanType": "fixed",
        "discountPoints": 0,
        "closingCosts": 4000,
        "lenderCredits": 0
      }
    ]
  }
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "options": {
      "minItems": 2,
      "maxItems": 4,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "productName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "pattern": "^[^<>\\p{Cc}]+$",
            "description": "Short plain-text scenario label."
          },
          "loanAmount": {
            "type": "number",
            "exclusiveMinimum": 0,
            "maximum": 1000000000,
            "description": "US dollars, greater than zero."
          },
          "interestRate": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Percentage points (6.5 means 6.5%)."
          },
          "termYears": {
            "type": "integer",
            "minimum": 1,
            "maximum": 50,
            "description": "Whole years of payments."
          },
          "loanType": {
            "type": "string",
            "enum": [
              "fixed",
              "arm",
              "interest-only"
            ]
          },
          "armInitialMonths": {
            "type": "integer",
            "minimum": 1,
            "maximum": 600,
            "description": "Whole months of payments."
          },
          "armAdjustmentCap": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Percentage points (6.5 means 6.5%)."
          },
          "armLifetimeCap": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Percentage points (6.5 means 6.5%)."
          },
          "discountPoints": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars; enter zero when this cost is absent."
          },
          "closingCosts": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars; enter zero when this cost is absent."
          },
          "lenderCredits": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars; enter zero when this cost is absent."
          }
        },
        "required": [
          "productName",
          "loanAmount",
          "interestRate",
          "termYears",
          "loanType",
          "discountPoints",
          "closingCosts",
          "lenderCredits"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "options"
  ],
  "additionalProperties": false
}

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