Skip to content

PDF report

Property buy-box screen

Property buy-box screen with the calculator’s supporting assumptions and breakdown.

Cost per success
10 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 investment-deal-screener-v1 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 10 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 10 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/investment-deal-screener-v1";
const input = {
  "scenario": {
    "purchasePrice": 200000,
    "monthlyRent": 2000,
    "estimatedRepairs": 0
  },
  "criteria": {
    "monthlyOperatingExpenses": 600,
    "annualDebtService": 14400,
    "minRentToPricePct": 1,
    "maxGrm": 12,
    "minMonthlyCashFlow": 0,
    "minDscr": 1.25
  }
};
const requestId = Date.now() + "." + randomUUID();
const output = "investment-deal-screener-v1-" + 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 investment-deal-screener-v1-<requestId>.pdf.

See the Rental deal and buy-box screen 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

scenarioRequired
object
scenario.purchasePriceRequired
numberMin 0 · Max 1000000000000
scenario.monthlyRentRequired
numberMin 0 · Max 1000000000000
scenario.estimatedRepairsRequired
numberMin 0 · Max 1000000000000
criteriaRequired
object
criteria.monthlyOperatingExpensesRequired
numberMin 0 · Max 1000000000000
criteria.annualDebtServiceRequired
numberMin 0 · Max 1000000000000
criteria.minRentToPricePctRequired
numberMin 0 · Max 100
criteria.maxGrmRequired
numberMin 0 · Max 1000000000000
criteria.minMonthlyCashFlowRequired
numberMin -1000000000000 · Max 1000000000000
criteria.minDscrRequired
numberMin 0 · Max 1000000000000
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "scenario": {
      "purchasePrice": 200000,
      "monthlyRent": 2000,
      "estimatedRepairs": 0
    },
    "criteria": {
      "monthlyOperatingExpenses": 600,
      "annualDebtService": 14400,
      "minRentToPricePct": 1,
      "maxGrm": 12,
      "minMonthlyCashFlow": 0,
      "minDscr": 1.25
    }
  }
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "scenario": {
      "type": "object",
      "properties": {
        "purchasePrice": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "monthlyRent": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "estimatedRepairs": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        }
      },
      "required": [
        "purchasePrice",
        "monthlyRent",
        "estimatedRepairs"
      ],
      "additionalProperties": false
    },
    "criteria": {
      "type": "object",
      "properties": {
        "monthlyOperatingExpenses": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "annualDebtService": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "minRentToPricePct": {
          "type": "number",
          "minimum": 0,
          "maximum": 100
        },
        "maxGrm": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "minMonthlyCashFlow": {
          "type": "number",
          "minimum": -1000000000000,
          "maximum": 1000000000000
        },
        "minDscr": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        }
      },
      "required": [
        "monthlyOperatingExpenses",
        "annualDebtService",
        "minRentToPricePct",
        "maxGrm",
        "minMonthlyCashFlow",
        "minDscr"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "scenario",
    "criteria"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/investment-deal-screener-v1
Formula: deal-screener-buy-box-1.0.0 · Report version: 1.0.0