Skip to content

PDF report

Bridge loan estimate

Bridge funding gap, first- or second-lien costs, monthly carry and proceeds after sale.

Cost per success
1 calculation credit + 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-bridge-loan 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 1 calculation credit 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 1 calculation credit 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-bridge-loan";
const input = {
  "currentHomeValue": 500000,
  "currentMortgageBalance": 250000,
  "newHomePurchasePrice": 400000,
  "targetDownPaymentPercent": 20,
  "newClosingCostsPercent": 3,
  "cashAvailableForPurchase": 20000,
  "maxCombinedLtvPercent": 80,
  "bridgeRate": 6,
  "bridgeTermMonths": 6,
  "originationFeePercent": 1,
  "monthlyCurrentHomeCarry": 1000,
  "newMonthlyPayment": 2000,
  "otherMonthlyObligations": 0,
  "sellingCostsPercent": 6,
  "bridgeStructure": "second-lien"
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-bridge-loan-" + 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-bridge-loan-<requestId>.pdf.

See the Bridge loan and carrying cost 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

currentHomeValueRequired
number

US dollars

Min 0.01 · Max 1000000000
currentMortgageBalanceRequired
number

US dollars

Min 0 · Max 1000000000
newHomePurchasePriceRequired
number

US dollars

Min 0.01 · Max 1000000000
targetDownPaymentPercentRequired
number

Percent, e.g. 5 means 5%

Min 0 · Max 100
newClosingCostsPercentRequired
number

Percent, e.g. 5 means 5%

Min 0 · Max 100
cashAvailableForPurchaseRequired
number

US dollars

Min 0 · Max 1000000000
maxCombinedLtvPercentRequired
number

Percent

Min 0.01 · Max 100
bridgeRateRequired
number

Annual rate in percent

Min 0 · Max 100
bridgeTermMonthsRequired
integer

Whole months

Min 1 · Max 120
originationFeePercentRequired
number

Percent, e.g. 5 means 5%

Min 0 · Max 100
monthlyCurrentHomeCarryRequired
number

US dollars per month

Min 0 · Max 1000000000
newMonthlyPaymentOptional
number

US dollars per month

Min 0 · Max 1000000000
otherMonthlyObligationsOptional
number

US dollars per month

Min 0 · Max 1000000000
sellingCostsPercentRequired
number

Percent, e.g. 5 means 5%

Min 0 · Max 100
bridgeStructureOptional
stringAllowed: "second-lien", "payoff-first-lien"
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "currentHomeValue": 500000,
    "currentMortgageBalance": 250000,
    "newHomePurchasePrice": 400000,
    "targetDownPaymentPercent": 20,
    "newClosingCostsPercent": 3,
    "cashAvailableForPurchase": 20000,
    "maxCombinedLtvPercent": 80,
    "bridgeRate": 6,
    "bridgeTermMonths": 6,
    "originationFeePercent": 1,
    "monthlyCurrentHomeCarry": 1000,
    "newMonthlyPayment": 2000,
    "otherMonthlyObligations": 0,
    "sellingCostsPercent": 6,
    "bridgeStructure": "second-lien"
  }
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "currentHomeValue": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "currentMortgageBalance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "newHomePurchasePrice": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "targetDownPaymentPercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent, e.g. 5 means 5%"
    },
    "newClosingCostsPercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent, e.g. 5 means 5%"
    },
    "cashAvailableForPurchase": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "maxCombinedLtvPercent": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 100,
      "description": "Percent"
    },
    "bridgeRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual rate in percent"
    },
    "bridgeTermMonths": {
      "type": "integer",
      "minimum": 1,
      "maximum": 120,
      "description": "Whole months"
    },
    "originationFeePercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent, e.g. 5 means 5%"
    },
    "monthlyCurrentHomeCarry": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "newMonthlyPayment": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "otherMonthlyObligations": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "sellingCostsPercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent, e.g. 5 means 5%"
    },
    "bridgeStructure": {
      "type": "string",
      "enum": [
        "second-lien",
        "payoff-first-lien"
      ]
    }
  },
  "required": [
    "currentHomeValue",
    "currentMortgageBalance",
    "newHomePurchasePrice",
    "targetDownPaymentPercent",
    "newClosingCostsPercent",
    "cashAvailableForPurchase",
    "maxCombinedLtvPercent",
    "bridgeRate",
    "bridgeTermMonths",
    "originationFeePercent",
    "monthlyCurrentHomeCarry",
    "sellingCostsPercent"
  ]
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-bridge-loan
Formula: bridge-loan-carry-htcalc-719df2c0e105 · Report version: 1.0.0