PDF report
Loan Estimate comparison
Loan Estimate comparison prepared from validated scenario inputs by the original HT Calc report builder.
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
- 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. - Under Report credentials, name a credential, select
mortgage-loan-estimate-comparisonand choose Create report credential. Save the secret shown once in your server’sHT_REPORT_KEY. - Run the example on your server against
accounts.hasstechapi.com, without anOriginheader. 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.
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-estimate-comparison";
const input = {
"offers": [
{
"lenderName": "First quote",
"loanAmount": 300000,
"interestRate": 6.5,
"monthlyPI": 1896.2,
"loanTerm": 30,
"loanType": "Conventional",
"loanPurpose": "Purchase",
"productType": "Fixed Rate",
"balloonPayment": false,
"estimatedCashToClose": 40000,
"loanCostsD": 4600,
"closingCostsJ": 8500
},
{
"lenderName": "Second quote",
"loanAmount": 300000,
"interestRate": 6.25,
"monthlyPI": 1847.15,
"loanTerm": 30,
"loanType": "Conventional",
"loanPurpose": "Purchase",
"productType": "Fixed Rate",
"balloonPayment": false,
"estimatedCashToClose": 40000,
"loanCostsD": 7200,
"closingCostsJ": 11100
}
]
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-loan-estimate-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-estimate-comparison-<requestId>.pdf.
Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
offersRequiredoffers[].lenderNameRequiredShort plain-text scenario label.
Min length 1 · Max length 64offers[].loanAmountRequiredUS dollars, greater than zero.
Max 1000000000 · Greater than 0offers[].interestRateRequiredPercentage points (6.5 means 6.5%).
Min 0 · Max 100offers[].monthlyPIRequiredDisclosed monthly principal and interest, in USD.
Max 1000000000 · Greater than 0offers[].loanTermRequiredWhole years of payments.
Min 1 · Max 50offers[].loanTypeRequiredoffers[].loanPurposeRequiredoffers[].productTypeRequiredoffers[].balloonPaymentRequiredoffers[].estimatedEscrowOptionalUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000offers[].pmiOptionalUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000offers[].estimatedCashToCloseOptionalUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000offers[].lenderCreditsOptionalUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000offers[].loanCostsDOptionalUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000offers[].servicesCanShopCOptionalUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000offers[].originationAOptionalUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000offers[].closingCostsJOptionalUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000offers[].aprOptionalPercentage points (6.5 means 6.5%).
Min 0 · Max 100offers[].inFiveYearsTotalOptionalUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000offers[].inFiveYearsPrincipalOptionalUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000Example input (JSON)
The server example adds a fresh requestId to this input.
{
"input": {
"offers": [
{
"lenderName": "First quote",
"loanAmount": 300000,
"interestRate": 6.5,
"monthlyPI": 1896.2,
"loanTerm": 30,
"loanType": "Conventional",
"loanPurpose": "Purchase",
"productType": "Fixed Rate",
"balloonPayment": false,
"estimatedCashToClose": 40000,
"loanCostsD": 4600,
"closingCostsJ": 8500
},
{
"lenderName": "Second quote",
"loanAmount": 300000,
"interestRate": 6.25,
"monthlyPI": 1847.15,
"loanTerm": 30,
"loanType": "Conventional",
"loanPurpose": "Purchase",
"productType": "Fixed Rate",
"balloonPayment": false,
"estimatedCashToClose": 40000,
"loanCostsD": 7200,
"closingCostsJ": 11100
}
]
}
} Full JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"offers": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "object",
"properties": {
"lenderName": {
"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%)."
},
"monthlyPI": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000000,
"description": "Disclosed monthly principal and interest, in USD."
},
"loanTerm": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"description": "Whole years of payments."
},
"loanType": {
"type": "string",
"enum": [
"Conventional",
"FHA",
"VA",
"USDA"
]
},
"loanPurpose": {
"type": "string",
"enum": [
"Purchase",
"Refinance"
]
},
"productType": {
"type": "string",
"enum": [
"Fixed Rate",
"Adjustable Rate",
"Interest Only"
]
},
"balloonPayment": {
"type": "boolean"
},
"estimatedEscrow": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"pmi": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"estimatedCashToClose": {
"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."
},
"loanCostsD": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"servicesCanShopC": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"originationA": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"closingCostsJ": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"apr": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Percentage points (6.5 means 6.5%)."
},
"inFiveYearsTotal": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"inFiveYearsPrincipal": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
}
},
"required": [
"lenderName",
"loanAmount",
"interestRate",
"monthlyPI",
"loanTerm",
"loanType",
"loanPurpose",
"productType",
"balloonPayment"
],
"additionalProperties": false,
"description": "Manually transcribed Loan Estimate. All optional figures come from the lender disclosure. Omit a line if it is unavailable."
}
}
},
"required": [
"offers"
],
"additionalProperties": false
}Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-loan-estimate-comparison
Formula: prepare-mortgage-loan-estimate-comparison-1.0.0 · Report version: 1.0.0