Skip to content

PDF report

HELOC analysis

Draw and repayment payments, rate stress, equity cushion and fees for a positive draw over whole-year terms.

Open HELOC Calculator in HT Calc

This HT Calc screen includes a Plus 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-heloc 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-heloc";
const input = {
  "homeValue": 450000,
  "mortgageBalance": 250000,
  "ltv": 85,
  "drawAmount": 50000,
  "interestRate": 9,
  "drawPeriod": 10,
  "repaymentPeriod": 20,
  "extraPayment": 0,
  "indexRate": 5.5,
  "rateMargin": 3.5,
  "rateCap": 18,
  "annualFee": 75,
  "closingCosts": 500
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-heloc-" + 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-heloc-<requestId>.pdf.

See the HELOC draw and repayment 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

homeValueRequired
number

US dollars

Min 0.01 · Max 1000000000
mortgageBalanceRequired
number

US dollars

Min 0 · Max 1000000000
ltvRequired
number

Percent

Min 0.01 · Max 100
drawAmountRequired
number

US dollars

Min 0 · Max 1000000000 · Greater than 0
interestRateRequired
number

Annual rate in percent

Min 0 · Max 100
drawPeriodRequired
integer

Years, rounded to the nearest month

Min 1 · Max 50
repaymentPeriodRequired
integer

Years, rounded to the nearest month

Min 1 · Max 50
extraPaymentRequired
number

US dollars per month

Min 0 · Max 1000000000
indexRateRequired
number

Annual rate in percent

Min 0 · Max 100
rateMarginRequired
number

Percent, e.g. 5 means 5%

Min 0 · Max 100
rateCapRequired
number

Annual rate in percent

Min 0 · Max 100
annualFeeRequired
number

US dollars per year

Min 0 · Max 1000000000
closingCostsRequired
number

US dollars

Min 0 · Max 1000000000
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "homeValue": 450000,
    "mortgageBalance": 250000,
    "ltv": 85,
    "drawAmount": 50000,
    "interestRate": 9,
    "drawPeriod": 10,
    "repaymentPeriod": 20,
    "extraPayment": 0,
    "indexRate": 5.5,
    "rateMargin": 3.5,
    "rateCap": 18,
    "annualFee": 75,
    "closingCosts": 500
  }
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "homeValue": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "mortgageBalance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "ltv": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 100,
      "description": "Percent"
    },
    "drawAmount": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars",
      "exclusiveMinimum": 0
    },
    "interestRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual rate in percent"
    },
    "drawPeriod": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Years, rounded to the nearest month"
    },
    "repaymentPeriod": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Years, rounded to the nearest month"
    },
    "extraPayment": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "indexRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual rate in percent"
    },
    "rateMargin": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent, e.g. 5 means 5%"
    },
    "rateCap": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual rate in percent"
    },
    "annualFee": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "closingCosts": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    }
  },
  "required": [
    "homeValue",
    "mortgageBalance",
    "ltv",
    "drawAmount",
    "interestRate",
    "drawPeriod",
    "repaymentPeriod",
    "extraPayment",
    "indexRate",
    "rateMargin",
    "rateCap",
    "annualFee",
    "closingCosts"
  ]
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-heloc
Formula: heloc-draw-and-repayment-htcalc-719df2c0e105 · Report version: 1.0.0