Skip to content

PDF report

Entered Loan Estimates side by side

Disclosed terms, cash requirements and comparable scheduled outlay across two to five offers. Optional disclosed five-year total paid and principal paid show the borrowing cost for each complete offer.

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 manual-lender-offer-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/manual-lender-offer-comparison";
const input = {
  "offers": [
    {
      "loanAmount": 200000,
      "loanTerm": 30,
      "loanPurpose": "purchase",
      "loanType": "conventional",
      "productType": "fixed",
      "balloonPayment": false,
      "monthlyPI": 1200,
      "totalClosingCostsDI": 5000,
      "closingCostsBasis": "gross",
      "lenderCredits": 1000,
      "estimatedCashToClose": 34000,
      "apr": 6.125
    },
    {
      "loanAmount": 200000,
      "loanTerm": 30,
      "loanPurpose": "purchase",
      "loanType": "conventional",
      "productType": "fixed",
      "balloonPayment": false,
      "monthlyPI": 1220,
      "totalClosingCostsDI": 2500,
      "closingCostsBasis": "net",
      "lenderCredits": 800,
      "estimatedCashToClose": 32500,
      "apr": 6.25
    }
  ]
};
const requestId = Date.now() + "." + randomUUID();
const output = "manual-lender-offer-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 manual-lender-offer-comparison-<requestId>.pdf.

See the Compare entered Loan Estimates 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

offersRequired
arrayMin items 2 · Max items 5
offers[].loanAmountRequired
numberMin 0.01 · Max 100000000
offers[].loanTermRequired
integerMin 1 · Max 40
offers[].loanPurposeRequired
stringAllowed: "purchase", "refinance"
offers[].loanTypeRequired
stringAllowed: "conventional", "fha", "va", "usda"
offers[].productTypeRequired
stringAllowed: "fixed", "arm", "interest-only", "balloon"
offers[].balloonPaymentRequired
boolean
offers[].monthlyPIRequired
numberMin 0.01 · Max 1000000
offers[].totalClosingCostsDIRequired
number

Total closing costs on the selected gross or net basis.

Min -100000000 · Max 100000000
offers[].closingCostsBasisRequired
stringAllowed: "net", "gross"
offers[].lenderCreditsRequired
number

Enter the positive credit amount. A net total already includes this credit.

Min 0 · Max 100000000
offers[].estimatedCashToCloseRequired
numberMin 0 · Max 100000000
offers[].aprRequired
numberMin 0 · Max 100
offers[].inFiveYearsTotalOptional
number

Manually entered five-year figure from Loan Estimate page 3, in dollars.

Min 0 · Max 1000000000
offers[].inFiveYearsPrincipalOptional
number

Manually entered five-year figure from Loan Estimate page 3, in dollars.

Min 0 · Max 1000000000
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "offers": [
      {
        "loanAmount": 200000,
        "loanTerm": 30,
        "loanPurpose": "purchase",
        "loanType": "conventional",
        "productType": "fixed",
        "balloonPayment": false,
        "monthlyPI": 1200,
        "totalClosingCostsDI": 5000,
        "closingCostsBasis": "gross",
        "lenderCredits": 1000,
        "estimatedCashToClose": 34000,
        "apr": 6.125
      },
      {
        "loanAmount": 200000,
        "loanTerm": 30,
        "loanPurpose": "purchase",
        "loanType": "conventional",
        "productType": "fixed",
        "balloonPayment": false,
        "monthlyPI": 1220,
        "totalClosingCostsDI": 2500,
        "closingCostsBasis": "net",
        "lenderCredits": 800,
        "estimatedCashToClose": 32500,
        "apr": 6.25
      }
    ]
  }
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "offers": {
      "type": "array",
      "minItems": 2,
      "maxItems": 5,
      "items": {
        "type": "object",
        "properties": {
          "loanAmount": {
            "type": "number",
            "minimum": 0.01,
            "maximum": 100000000
          },
          "loanTerm": {
            "type": "integer",
            "minimum": 1,
            "maximum": 40
          },
          "loanPurpose": {
            "type": "string",
            "enum": [
              "purchase",
              "refinance"
            ]
          },
          "loanType": {
            "type": "string",
            "enum": [
              "conventional",
              "fha",
              "va",
              "usda"
            ]
          },
          "productType": {
            "type": "string",
            "enum": [
              "fixed",
              "arm",
              "interest-only",
              "balloon"
            ]
          },
          "balloonPayment": {
            "type": "boolean"
          },
          "monthlyPI": {
            "type": "number",
            "minimum": 0.01,
            "maximum": 1000000
          },
          "totalClosingCostsDI": {
            "type": "number",
            "minimum": -100000000,
            "maximum": 100000000,
            "description": "Total closing costs on the selected gross or net basis."
          },
          "closingCostsBasis": {
            "type": "string",
            "enum": [
              "net",
              "gross"
            ]
          },
          "lenderCredits": {
            "type": "number",
            "minimum": 0,
            "maximum": 100000000,
            "description": "Enter the positive credit amount. A net total already includes this credit."
          },
          "estimatedCashToClose": {
            "type": "number",
            "minimum": 0,
            "maximum": 100000000
          },
          "apr": {
            "type": "number",
            "minimum": 0,
            "maximum": 100
          },
          "inFiveYearsTotal": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "Manually entered five-year figure from Loan Estimate page 3, in dollars."
          },
          "inFiveYearsPrincipal": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "Manually entered five-year figure from Loan Estimate page 3, in dollars."
          }
        },
        "required": [
          "loanAmount",
          "loanTerm",
          "loanPurpose",
          "loanType",
          "productType",
          "balloonPayment",
          "monthlyPI",
          "totalClosingCostsDI",
          "closingCostsBasis",
          "lenderCredits",
          "estimatedCashToClose",
          "apr"
        ],
        "additionalProperties": false,
        "allOf": [
          {
            "if": {
              "properties": {
                "closingCostsBasis": {
                  "const": "gross"
                }
              }
            },
            "then": {
              "properties": {
                "totalClosingCostsDI": {
                  "minimum": 0
                }
              }
            }
          }
        ]
      }
    }
  },
  "required": [
    "offers"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/manual-lender-offer-comparison
Formula: structured-loan-estimate-comparison-htcalc-719df2c0e105 · Report version: 1.0.0