Skip to content

PDF report

Supplied mortgage rate snapshot

Compare up to 12 dated mortgage quotes and up to 60 caller-supplied observations using the same financed amount. Includes initial ARM payments and any supplied APR.

Related HT Calc tool: Rate Tracker

Rate Tracker shows market observations in HT Calc. This API report uses a quote sheet you supply.

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 supplied-rate-snapshot 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/supplied-rate-snapshot";
const input = {
  "source": "Example lender rate sheet",
  "asOf": "2026-11-13",
  "loanAmount": 300000,
  "quotes": [
    {
      "program": "30-year fixed",
      "termYears": 30,
      "noteRatePct": 6.25,
      "quotedAprPct": 6.42,
      "basis": "observed"
    },
    {
      "program": "5/1 adjustable",
      "termYears": 30,
      "noteRatePct": 5.875,
      "basis": "modeled",
      "fixedIntroMonths": 60
    },
    {
      "program": "15-year fixed",
      "termYears": 15,
      "noteRatePct": 5.75,
      "basis": "observed"
    }
  ],
  "focusProgram": "30-year fixed",
  "history": [
    {
      "date": "2026-11-06",
      "noteRatePct": 6.375
    },
    {
      "date": "2026-11-13",
      "noteRatePct": 6.25
    }
  ]
};
const requestId = Date.now() + "." + randomUUID();
const output = "supplied-rate-snapshot-" + 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 supplied-rate-snapshot-<requestId>.pdf.

Request contract

Accepted inputs

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

FieldType, units and limits

sourceRequired
string

Name of the source whose supplied rates the caller may distribute

Min length 1 · Max length 48
asOfRequired
stringFormat: date
loanAmountRequired
number

US dollars

Max 1000000000 · Greater than 0
quotesRequired
arrayMin items 1 · Max items 12
quotes[].programRequired
stringMin length 1 · Max length 48
quotes[].termYearsRequired
integer

Whole years

Min 1 · Max 50
quotes[].noteRatePctRequired
number

Annual percent, e.g. 6.25

Min 0 · Max 100
quotes[].quotedAprPctOptional
number

Annual percent, e.g. 6.25

Min 0 · Max 100
quotes[].basisRequired
stringAllowed: "observed", "modeled"
quotes[].fixedIntroMonthsOptional
integer

For an adjustable-rate mortgage, months before the rate may reset. Omit for fixed-rate loans.

Max 9007199254740991 · Greater than 0
focusProgramRequired
stringMin length 1 · Max length 48
historyOptional
array

Observed note-rate series for the focus program only; dates ascend and end at the supplied quote

Max items 60
history[].dateRequired
stringFormat: date
history[].noteRatePctRequired
number

Annual percent, e.g. 6.25

Min 0 · Max 100
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "source": "Example lender rate sheet",
    "asOf": "2026-11-13",
    "loanAmount": 300000,
    "quotes": [
      {
        "program": "30-year fixed",
        "termYears": 30,
        "noteRatePct": 6.25,
        "quotedAprPct": 6.42,
        "basis": "observed"
      },
      {
        "program": "5/1 adjustable",
        "termYears": 30,
        "noteRatePct": 5.875,
        "basis": "modeled",
        "fixedIntroMonths": 60
      },
      {
        "program": "15-year fixed",
        "termYears": 15,
        "noteRatePct": 5.75,
        "basis": "observed"
      }
    ],
    "focusProgram": "30-year fixed",
    "history": [
      {
        "date": "2026-11-06",
        "noteRatePct": 6.375
      },
      {
        "date": "2026-11-13",
        "noteRatePct": 6.25
      }
    ]
  }
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "minLength": 1,
      "maxLength": 48,
      "pattern": "^[\\p{L}\\p{N} .,&()'’/-]+$",
      "description": "Name of the source whose supplied rates the caller may distribute"
    },
    "asOf": {
      "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])))$"
    },
    "loanAmount": {
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "quotes": {
      "minItems": 1,
      "maxItems": 12,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "program": {
            "type": "string",
            "minLength": 1,
            "maxLength": 48,
            "pattern": "^[\\p{L}\\p{N} .,&()'’/-]+$"
          },
          "termYears": {
            "type": "integer",
            "minimum": 1,
            "maximum": 50,
            "description": "Whole years"
          },
          "noteRatePct": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Annual percent, e.g. 6.25"
          },
          "quotedAprPct": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Annual percent, e.g. 6.25"
          },
          "basis": {
            "type": "string",
            "enum": [
              "observed",
              "modeled"
            ]
          },
          "fixedIntroMonths": {
            "description": "For an adjustable-rate mortgage, months before the rate may reset. Omit for fixed-rate loans.",
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "program",
          "termYears",
          "noteRatePct",
          "basis"
        ],
        "additionalProperties": false
      }
    },
    "focusProgram": {
      "type": "string",
      "minLength": 1,
      "maxLength": 48,
      "pattern": "^[\\p{L}\\p{N} .,&()'’/-]+$"
    },
    "history": {
      "description": "Observed note-rate series for the focus program only; dates ascend and end at the supplied quote",
      "maxItems": 60,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "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])))$"
          },
          "noteRatePct": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Annual percent, e.g. 6.25"
          }
        },
        "required": [
          "date",
          "noteRatePct"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "source",
    "asOf",
    "loanAmount",
    "quotes",
    "focusProgram"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/supplied-rate-snapshot
Formula: htcalc-supplied-rate-snapshot-1.0.0 · Report version: 1.0.0