Skip to content

PDF report

Capitalization rate

Annual net operating income and property value with the resulting capitalization rate.

Related HT Calc tool: Cap Rate Calculator

The API uses two supplied figures: annual net operating income and property value. The related calculator also models property income and expenses. This HT Calc screen includes a Pro sample for visitors.

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 cap-rate 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/cap-rate";
const input = {
  "annualNoi": 100,
  "propertyValue": 100
};
const requestId = Date.now() + "." + randomUUID();
const output = "cap-rate-" + 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 cap-rate-<requestId>.pdf.

See the Capitalization rate 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

annualNoiRequired
number · USD/year

Annual net operating income. A loss may be negative.

Min -1000000000 · Max 1000000000 · Step 0.01
propertyValueRequired
number · USD

Property value used as the denominator.

Max 1000000000 · Greater than 0 · Step 0.01
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "annualNoi": 100,
    "propertyValue": 100
  }
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "annualNoi": {
      "type": "number",
      "description": "Annual net operating income. A loss may be negative.",
      "x-unit": "USD/year",
      "minimum": -1000000000,
      "maximum": 1000000000,
      "multipleOf": 0.01,
      "x-core-refinement": true
    },
    "propertyValue": {
      "type": "number",
      "description": "Property value used as the denominator.",
      "x-unit": "USD",
      "maximum": 1000000000,
      "multipleOf": 0.01,
      "exclusiveMinimum": 0,
      "x-core-refinement": true
    }
  },
  "required": [
    "annualNoi",
    "propertyValue"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/cap-rate
Formula: cap-rate-2.0.0 · Report version: 1.0.0