Skip to content

PDF report

Rent versus buy

Rent versus buy prepared from validated scenario inputs by the original HT Calc report builder.

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-rent-vs-buy 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-rent-vs-buy";
const input = {
  "homePrice": 475000,
  "downPaymentPercent": 5,
  "mortgageRate": 6.75,
  "loanTermYears": 30,
  "propertyTaxRate": 1.1,
  "annualInsurance": 1662,
  "maintenanceRate": 1,
  "hoaMonthly": 0,
  "closingCostRate": 3,
  "sellingCostRate": 6,
  "homeAppreciationRate": 3.5,
  "monthlyRent": 2650,
  "annualRentIncrease": 3,
  "rentersInsuranceMonthly": 25,
  "investmentReturnRate": 7,
  "timeHorizonYears": 10
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-rent-vs-buy-" + 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-rent-vs-buy-<requestId>.pdf.

Request contract

Accepted inputs

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

FieldType, units and limits

homePriceRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
downPaymentPercentRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
mortgageRateRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
loanTermYearsRequired
integer

Whole years of payments.

Min 1 · Max 50
propertyTaxRateRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
annualInsuranceRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
maintenanceRateRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
hoaMonthlyRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
closingCostRateRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
sellingCostRateRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
homeAppreciationRateRequired
number

Signed percentage points (−1 means a decrease of one point).

Min -50 · Max 50
monthlyRentRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
annualRentIncreaseRequired
number

Signed percentage points (−1 means a decrease of one point).

Min -50 · Max 50
rentersInsuranceMonthlyRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
investmentReturnRateRequired
number

Signed percentage points (−1 means a decrease of one point).

Min -50 · Max 50
timeHorizonYearsRequired
integerMin 1 · Max 50
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "homePrice": 475000,
    "downPaymentPercent": 5,
    "mortgageRate": 6.75,
    "loanTermYears": 30,
    "propertyTaxRate": 1.1,
    "annualInsurance": 1662,
    "maintenanceRate": 1,
    "hoaMonthly": 0,
    "closingCostRate": 3,
    "sellingCostRate": 6,
    "homeAppreciationRate": 3.5,
    "monthlyRent": 2650,
    "annualRentIncrease": 3,
    "rentersInsuranceMonthly": 25,
    "investmentReturnRate": 7,
    "timeHorizonYears": 10
  }
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "homePrice": {
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 1000000000,
      "description": "US dollars, greater than zero."
    },
    "downPaymentPercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (6.5 means 6.5%)."
    },
    "mortgageRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (6.5 means 6.5%)."
    },
    "loanTermYears": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Whole years of payments."
    },
    "propertyTaxRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (6.5 means 6.5%)."
    },
    "annualInsurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars; enter zero when this cost is absent."
    },
    "maintenanceRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (6.5 means 6.5%)."
    },
    "hoaMonthly": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars; enter zero when this cost is absent."
    },
    "closingCostRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (6.5 means 6.5%)."
    },
    "sellingCostRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (6.5 means 6.5%)."
    },
    "homeAppreciationRate": {
      "type": "number",
      "minimum": -50,
      "maximum": 50,
      "description": "Signed percentage points (−1 means a decrease of one point)."
    },
    "monthlyRent": {
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 1000000000,
      "description": "US dollars, greater than zero."
    },
    "annualRentIncrease": {
      "type": "number",
      "minimum": -50,
      "maximum": 50,
      "description": "Signed percentage points (−1 means a decrease of one point)."
    },
    "rentersInsuranceMonthly": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars; enter zero when this cost is absent."
    },
    "investmentReturnRate": {
      "type": "number",
      "minimum": -50,
      "maximum": 50,
      "description": "Signed percentage points (−1 means a decrease of one point)."
    },
    "timeHorizonYears": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "required": [
    "homePrice",
    "downPaymentPercent",
    "mortgageRate",
    "loanTermYears",
    "propertyTaxRate",
    "annualInsurance",
    "maintenanceRate",
    "hoaMonthly",
    "closingCostRate",
    "sellingCostRate",
    "homeAppreciationRate",
    "monthlyRent",
    "annualRentIncrease",
    "rentersInsuranceMonthly",
    "investmentReturnRate",
    "timeHorizonYears"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-rent-vs-buy
Formula: prepare-mortgage-rent-vs-buy-1.0.0 · Report version: 1.0.0