Skip to content

PDF report

Short-term rental

Short-term rental with the calculator’s supporting assumptions and breakdown. Set legalStatus to permitted and provide marketSourceName and marketSourceAsOf for the nightly rate and occupancy assumptions. Use a source date on or before asOfDate.

Open Short-Term Rental Analysis in HT Calc

This HT Calc screen includes a Pro sample for visitors.

Cost per success
20 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-str-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 20 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 20 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-str-v1";
const input = {
  "asOfDate": "2026-10-16",
  "scenario": {
    "purchasePrice": 200000,
    "downPayment": 40000,
    "closingCosts": 4000,
    "repairCosts": 5000,
    "furnitureCost": 10000,
    "interestRate": 6.5,
    "loanTerm": 30,
    "dailyRentalRate": 150,
    "dailyCleaningFee": 0,
    "additionalGuestFee": 0,
    "airbnbExperiences": 0,
    "laundryRevenue": 0,
    "additionalRevenue": 0,
    "occupancyRate": 70,
    "propertyTax": 250,
    "insurance": 120,
    "trash": 0,
    "utilities": 150,
    "internet": 80,
    "hoaFees": 0,
    "cleanerExpense": 300,
    "lawnSnow": 50,
    "otherExpenses": 0,
    "maintenanceRate": 5,
    "vacancyRate": 0,
    "managementRate": 20,
    "airbnbServiceFeeRate": 3
  },
  "monthlyLTRRent": 0,
  "annualPermitCost": 0,
  "lodgingTaxPct": 0,
  "legalStatus": "permitted",
  "marketSourceName": "Caller-supplied nightly rent observations",
  "marketSourceAsOf": "2026-10-16",
  "seasonalProfile": "uniform"
};
const requestId = Date.now() + "." + randomUUID();
const output = "investment-str-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-str-v1-<requestId>.pdf.

See the Short-term rental ownership 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

asOfDateRequired
string

Calendar date of the scenario, UTC

Format: date
scenarioRequired
object
scenario.purchasePriceRequired
numberMin 0 · Max 1000000000000
scenario.downPaymentRequired
numberMin 0 · Max 1000000000000
scenario.closingCostsRequired
numberMin 0 · Max 1000000000000
scenario.repairCostsRequired
numberMin 0 · Max 1000000000000
scenario.furnitureCostRequired
numberMin 0 · Max 1000000000000
scenario.interestRateRequired
numberMin 0 · Max 1000000000000
scenario.loanTermRequired
numberMin 0 · Max 50
scenario.dailyRentalRateRequired
numberMin 0 · Max 1000000000000
scenario.dailyCleaningFeeRequired
numberMin 0 · Max 1000000000000
scenario.additionalGuestFeeRequired
numberMin 0 · Max 1000000000000
scenario.airbnbExperiencesRequired
numberMin 0 · Max 1000000000000
scenario.laundryRevenueRequired
numberMin 0 · Max 1000000000000
scenario.additionalRevenueRequired
numberMin 0 · Max 1000000000000
scenario.occupancyRateRequired
numberMin 0 · Max 1000000000000
scenario.propertyTaxRequired
numberMin 0 · Max 1000000000000
scenario.insuranceRequired
numberMin 0 · Max 1000000000000
scenario.trashRequired
numberMin 0 · Max 1000000000000
scenario.utilitiesRequired
numberMin 0 · Max 1000000000000
scenario.internetRequired
numberMin 0 · Max 1000000000000
scenario.hoaFeesRequired
numberMin 0 · Max 1000000000000
scenario.cleanerExpenseRequired
numberMin 0 · Max 1000000000000
scenario.lawnSnowRequired
numberMin 0 · Max 1000000000000
scenario.otherExpensesRequired
numberMin 0 · Max 1000000000000
scenario.maintenanceRateRequired
numberMin 0 · Max 1000000000000
scenario.vacancyRateRequired
numberMin 0 · Max 1000000000000
scenario.managementRateRequired
numberMin 0 · Max 1000000000000
scenario.airbnbServiceFeeRateRequired
numberMin 0 · Max 1000000000000
monthlyLTRRentRequired
numberMin 0 · Max 1000000000000
annualPermitCostRequired
numberMin 0 · Max 1000000000000
lodgingTaxPctRequired
numberMin 0 · Max 100
legalStatusRequired
stringAllowed: "permitted", "prohibited", "unknown"
marketSourceNameRequired
stringMax length 120
marketSourceAsOfRequired
string
seasonalProfileRequired
stringAllowed: "uniform", "beach", "mountain", "urban"
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "asOfDate": "2026-10-16",
    "scenario": {
      "purchasePrice": 200000,
      "downPayment": 40000,
      "closingCosts": 4000,
      "repairCosts": 5000,
      "furnitureCost": 10000,
      "interestRate": 6.5,
      "loanTerm": 30,
      "dailyRentalRate": 150,
      "dailyCleaningFee": 0,
      "additionalGuestFee": 0,
      "airbnbExperiences": 0,
      "laundryRevenue": 0,
      "additionalRevenue": 0,
      "occupancyRate": 70,
      "propertyTax": 250,
      "insurance": 120,
      "trash": 0,
      "utilities": 150,
      "internet": 80,
      "hoaFees": 0,
      "cleanerExpense": 300,
      "lawnSnow": 50,
      "otherExpenses": 0,
      "maintenanceRate": 5,
      "vacancyRate": 0,
      "managementRate": 20,
      "airbnbServiceFeeRate": 3
    },
    "monthlyLTRRent": 0,
    "annualPermitCost": 0,
    "lodgingTaxPct": 0,
    "legalStatus": "permitted",
    "marketSourceName": "Caller-supplied nightly rent observations",
    "marketSourceAsOf": "2026-10-16",
    "seasonalProfile": "uniform"
  }
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "asOfDate": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
      "description": "Calendar date of the scenario, UTC"
    },
    "scenario": {
      "type": "object",
      "properties": {
        "purchasePrice": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "downPayment": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "closingCosts": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "repairCosts": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "furnitureCost": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "interestRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "loanTerm": {
          "type": "number",
          "minimum": 0,
          "maximum": 50
        },
        "dailyRentalRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "dailyCleaningFee": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "additionalGuestFee": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "airbnbExperiences": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "laundryRevenue": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "additionalRevenue": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "occupancyRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "propertyTax": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "insurance": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "trash": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "utilities": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "internet": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "hoaFees": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "cleanerExpense": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "lawnSnow": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "otherExpenses": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "maintenanceRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "vacancyRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "managementRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        },
        "airbnbServiceFeeRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000
        }
      },
      "required": [
        "purchasePrice",
        "downPayment",
        "closingCosts",
        "repairCosts",
        "furnitureCost",
        "interestRate",
        "loanTerm",
        "dailyRentalRate",
        "dailyCleaningFee",
        "additionalGuestFee",
        "airbnbExperiences",
        "laundryRevenue",
        "additionalRevenue",
        "occupancyRate",
        "propertyTax",
        "insurance",
        "trash",
        "utilities",
        "internet",
        "hoaFees",
        "cleanerExpense",
        "lawnSnow",
        "otherExpenses",
        "maintenanceRate",
        "vacancyRate",
        "managementRate",
        "airbnbServiceFeeRate"
      ],
      "additionalProperties": false
    },
    "monthlyLTRRent": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000000
    },
    "annualPermitCost": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000000
    },
    "lodgingTaxPct": {
      "type": "number",
      "minimum": 0,
      "maximum": 100
    },
    "legalStatus": {
      "type": "string",
      "enum": [
        "permitted",
        "prohibited",
        "unknown"
      ]
    },
    "marketSourceName": {
      "type": "string",
      "maxLength": 120,
      "pattern": "^[^<>\\u0000-\\u001f]*$"
    },
    "marketSourceAsOf": {
      "anyOf": [
        {
          "type": "string",
          "format": "date",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
        },
        {
          "type": "string",
          "const": ""
        }
      ]
    },
    "seasonalProfile": {
      "type": "string",
      "enum": [
        "uniform",
        "beach",
        "mountain",
        "urban"
      ]
    }
  },
  "required": [
    "asOfDate",
    "scenario",
    "monthlyLTRRent",
    "annualPermitCost",
    "lodgingTaxPct",
    "legalStatus",
    "marketSourceName",
    "marketSourceAsOf",
    "seasonalProfile"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/investment-str-v1
Formula: investor-str-owned-1.0.0 · Report version: 1.0.0