Skip to content

Investment · Calculation

Compare field deals

Compares two to four supplied property scenarios. Rental scores are comparable across rental rows. Flip rows show the same rental baseline as the comparison table and retain their independent flip ledger. Equal highest scores share the top rank.

Open Field Notes in HT Calc

This comparison is part of the Field Notes workflow. This HT Calc screen includes a Pro sample for visitors.

Example result · combinedPurchasePrice: 480000 See output

Cost per success
20 calculation credits
Production plans
Standard, Business, Scale, Enterprise
Plan allowances
Free sandbox
Not available

Integration example

Make a request

Use a production key scoped to investor-deal-comparison.

Keep the key on your server. A successful call uses 20 calculation credits.

Production request

Set HT_PRODUCTION_KEY on your server. Save as example.mjs and run node example.mjs with Node.js 18 or later.

import { randomUUID } from "node:crypto";

const key = process.env.HT_PRODUCTION_KEY;
if (!key) throw new Error("Set HT_PRODUCTION_KEY on your server.");
const endpoint = "https://calc.hasstechapi.com/v2/calc/investor-deal-comparison";
const input = {
  "deals": [
    {
      "analysisType": "rental",
      "asOfDate": "2026-01-01",
      "unitRents": [
        1200,
        1200
      ],
      "maintenancePercent": 5,
      "managementPercent": 8,
      "purchasePrice": 240000,
      "downPayment": 48000,
      "interestRate": 6,
      "loanTerm": 30,
      "closingCosts": 3500,
      "renovationCosts": 12000,
      "otherIncome": 0,
      "vacancyRate": 5,
      "propertyTax": 210,
      "insurance": 75,
      "hoaFees": 0,
      "utilities": 75,
      "otherExpenses": 50,
      "targetDscr": 1.25
    },
    {
      "analysisType": "rental",
      "asOfDate": "2026-01-01",
      "unitRents": [
        1300,
        1300
      ],
      "maintenancePercent": 5,
      "managementPercent": 8,
      "purchasePrice": 240000,
      "downPayment": 48000,
      "interestRate": 6,
      "loanTerm": 30,
      "closingCosts": 3500,
      "renovationCosts": 12000,
      "otherIncome": 0,
      "vacancyRate": 5,
      "propertyTax": 210,
      "insurance": 75,
      "hoaFees": 0,
      "utilities": 75,
      "otherExpenses": 50,
      "targetDscr": 1.25
    }
  ]
};
const requestId = process.env.HT_REQUEST_ID || Date.now() + "." + randomUUID();
// Keep this ID to look up usage if the connection is interrupted.
console.error("Usage lookup ID:", requestId);

const response = await fetch(endpoint, {
  method: "POST",
  redirect: "error",
  headers: {
    "Authorization": "Bearer " + key,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId
  },
  body: JSON.stringify(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 {
  console.log(JSON.stringify(await response.json(), null, 2));
}
cURL (shell)

Set HT_PRODUCTION_KEY on your server. Run in a POSIX shell with cURL 7.76+ and Python 3.7+ to create a request ID.

(
  set -eu
  : "${HT_PRODUCTION_KEY:?Set HT_PRODUCTION_KEY on your server}"
  request_id="${HT_REQUEST_ID:-}"
  if [ -z "$request_id" ]; then
    request_id=$(python3 -c 'import time, uuid; print(str(time.time_ns() // 1000000) + "." + str(uuid.uuid4()))')
  fi
  printf 'Usage lookup ID: %s\n' "$request_id" >&2
  # On INVALID_INPUT, read error.details in the JSON response body.
  curl --disable --silent --show-error --fail-with-body --include \
    --request POST 'https://calc.hasstechapi.com/v2/calc/investor-deal-comparison' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "deals": [
    {
      "analysisType": "rental",
      "asOfDate": "2026-01-01",
      "unitRents": [
        1200,
        1200
      ],
      "maintenancePercent": 5,
      "managementPercent": 8,
      "purchasePrice": 240000,
      "downPayment": 48000,
      "interestRate": 6,
      "loanTerm": 30,
      "closingCosts": 3500,
      "renovationCosts": 12000,
      "otherIncome": 0,
      "vacancyRate": 5,
      "propertyTax": 210,
      "insurance": 75,
      "hoaFees": 0,
      "utilities": 75,
      "otherExpenses": 50,
      "targetDscr": 1.25
    },
    {
      "analysisType": "rental",
      "asOfDate": "2026-01-01",
      "unitRents": [
        1300,
        1300
      ],
      "maintenancePercent": 5,
      "managementPercent": 8,
      "purchasePrice": 240000,
      "downPayment": 48000,
      "interestRate": 6,
      "loanTerm": 30,
      "closingCosts": 3500,
      "renovationCosts": 12000,
      "otherIncome": 0,
      "vacancyRate": 5,
      "propertyTax": 210,
      "insurance": 75,
      "hoaFees": 0,
      "utilities": 75,
      "otherExpenses": 50,
      "targetDscr": 1.25
    }
  ]
}
HT_INPUT
)
If your request fails
400 INVALID_INPUT

Read error.details when present. Node prints each issue. cURL returns the JSON body. Each path points into your request. An empty path refers to the whole body.

Check the accepted inputs for required fields, units and ranges. Send the corrected JSON as a new request.

401 or 403
Check that the server has the bearer key for the endpoint’s environment and that the key includes investor-deal-comparison.
429
Read the service error code, check your allowance, and wait for the Retry-After interval when supplied before trying again.
Lost response, 409 or 503
Open Request lookup, select the same environment and enter the printed usage lookup ID. A settled ID has already consumed credits. To retry the same calculation, set HT_REQUEST_ID to the original ID and reuse the same inputs. A settled request does not return its result again. Unset the variable for a new request, which can consume credits.

The usage lookup ID is the Idempotency-Key your server sends. The response’s x-request-id identifies the HTTP exchange for support.

Output

Example result

These values come from running this operation on the example inputs.

combinedPurchasePrice
480000
combinedMonthlyCashFlow
978
averageCapRate
8.2
How to interpret this result
  • Compares two to four supplied property scenarios. Rental scores are comparable across rental rows. Flip rows show the same rental baseline as the comparison table and retain their independent flip ledger. Equal highest scores share the top rank.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "rows": [
      {
        "flipResults": null,
        "onePercentRule": {
          "scheduledGrossMonthlyRent": 2400,
          "rentToPriceRatio": 0.01,
          "passes": true
        },
        "fiftyPercentRule": {
          "scheduledGrossMonthlyRent": 2400,
          "monthlyOperatingExpenses": 722,
          "operatingExpenseRatio": 0.30083333333333334,
          "passes": true
        },
        "seventyPercentRule": null,
        "dealScore": 93,
        "results": {
          "monthlyCashFlow": 406.8629917067001,
          "annualCashFlow": 4882.355900480401,
          "noi": 18696,
          "capRate": 7.79,
          "allInCapRate": 7.419047619047619,
          "cashOnCashReturn": 7.688749449575434,
          "dscr": 1.3534444542877861,
          "dscrStatus": "available",
          "grm": 8.333333333333334,
          "breakEvenRatio": 82.1551319426886,
          "totalInvestment": 63500,
          "loanAmount": 192000,
          "monthlyPI": 1151.1370082933,
          "grossMonthlyIncome": 2400,
          "effectiveMonthlyIncome": 2280,
          "totalMonthlyOperatingExpenses": 722,
          "totalMonthlyExpenses": 1873.1370082933,
          "monthlyPmi": 0,
          "firstYearPrincipalPaydown": 2357.7824875714887,
          "expenseBreakdown": {
            "pi": 1151.1370082933,
            "tax": 210,
            "insurance": 75,
            "management": 192,
            "maintenance": 120,
            "other": 125
          },
          "meetsSuppliedDscr": true
        },
        "scheduledRent": 2400,
        "appliedMaintenance": 120,
        "appliedManagement": 192,
        "assumptions": [
          {
            "key": "propertyType",
            "value": "single_family",
            "source": "default"
          }
        ]
      },
      {
        "flipResults": null,
        "onePercentRule": {
          "scheduledGrossMonthlyRent": 2600,
          "rentToPriceRatio": 0.010833333333333334,
          "passes": true
        },
        "fiftyPercentRule": {
          "scheduledGrossMonthlyRent": 2600,
          "monthlyOperatingExpenses": 748,
          "operatingExpenseRatio": 0.2876923076923077,
          "passes": true
        },
        "seventyPercentRule": null,
        "dealScore": 100,
        "results": {
          "monthlyCashFlow": 570.8629917067001,
          "annualCashFlow": 6850.355900480401,
          "noi": 20664,
          "capRate": 8.61,
          "allInCapRate": 8.200000000000001,
          "cashOnCashReturn": 10.787962048000633,
          "dscr": 1.4959122915812373,
          "dscrStatus": "available",
          "grm": 7.6923076923076925,
          "breakEvenRatio": 76.888137987583,
          "totalInvestment": 63500,
          "loanAmount": 192000,
          "monthlyPI": 1151.1370082933,
          "grossMonthlyIncome": 2600,
          "effectiveMonthlyIncome": 2470,
          "totalMonthlyOperatingExpenses": 748,
          "totalMonthlyExpenses": 1899.1370082933,
          "monthlyPmi": 0,
          "firstYearPrincipalPaydown": 2357.7824875714887,
          "expenseBreakdown": {
            "pi": 1151.1370082933,
            "tax": 210,
            "insurance": 75,
            "management": 208,
            "maintenance": 130,
            "other": 125
          },
          "meetsSuppliedDscr": true
        },
        "scheduledRent": 2600,
        "appliedMaintenance": 130,
        "appliedManagement": 208,
        "assumptions": [
          {
            "key": "propertyType",
            "value": "single_family",
            "source": "default"
          }
        ]
      }
    ],
    "topRentalIndexes": [
      1
    ],
    "combinedPurchasePrice": 480000,
    "combinedMonthlyCashFlow": 978,
    "averageCapRate": 8.2,
    "averageCashOnCash": 9.238355748788035
  },
  "formulaVersion": "investor-deal-comparison-1.0.0",
  "units": {
    "loanTerm": "years",
    "flip.holdingPeriod": "months",
    "interestRate": "annual percentage points",
    "*Percent": "percentage points",
    "vacancyRate": "percentage points",
    "targetDscr": "ratio",
    "unitRents": "USD/month per unit",
    "propertyTax": "USD/month",
    "insurance": "USD/month",
    "operatingAmounts": "USD/month",
    "acquisitionAndRehab": "USD",
    "noi": "USD/year",
    "dealScore": "screening score 0–100",
    "*Ratio": "decimal ratio"
  },
  "assumptions": [
    "Compares two to four supplied property scenarios. Rental scores are comparable across rental rows. Flip rows show the same rental baseline as the comparison table and retain their independent flip ledger. Equal highest scores share the top rank."
  ],
  "warnings": [],
  "creditCost": 20
}

Request contract

Accepted inputs

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

FieldType, units and limits

dealsRequired
arrayMin items 2 · Max items 4
deals[].asOfDateRequired
string

Gregorian calendar date, YYYY-MM-DD.

Format: date · Min length 10 · Max length 10
deals[].unitRentsRequired
arrayMin items 1 · Max items 50
deals[].maintenancePercentRequired
number

Percentage points of scheduled monthly rent (8 means 8%).

Min 0 · Max 100
deals[].managementPercentRequired
number

Percentage points of scheduled monthly rent (8 means 8%).

Min 0 · Max 100
deals[].managementMonthlyAmountOptional
number

USD per month.

Min 0 · Max 1000000000
deals[].purchasePriceRequired
number

USD, one-time amount.

Min 0.01 · Max 1000000000
deals[].downPaymentRequired
number

USD, one-time amount.

Min 0 · Max 1000000000
deals[].interestRateRequired
number

Annual nominal interest rate in percentage points (6.5 means 6.5%).

Min 0 · Max 50
deals[].loanTermRequired
integer

Amortization term in whole years.

Min 1 · Max 50
deals[].closingCostsRequired
number

USD, one-time amount.

Min 0 · Max 1000000000
deals[].renovationCostsRequired
number

USD, one-time amount.

Min 0 · Max 1000000000
deals[].otherIncomeRequired
number

USD per month.

Min 0 · Max 1000000000
deals[].vacancyRateRequired
number

Percentage points of gross monthly income lost to vacancy.

Min 0 · Max 100
deals[].propertyTaxRequired
number

USD per month.

Min 0 · Max 1000000000
deals[].insuranceRequired
number

USD per month.

Min 0 · Max 1000000000
deals[].hoaFeesRequired
number

USD per month.

Min 0 · Max 1000000000
deals[].utilitiesRequired
number

USD per month.

Min 0 · Max 1000000000
deals[].otherExpensesRequired
number

USD per month.

Min 0 · Max 1000000000
deals[].targetDscrRequired
number

Debt-service coverage multiple (1.25 means 1.25×).

Min 0 · Max 20
deals[].pmiOptional
number

USD per month.

Min 0 · Max 1000000000
deals[].analysisTypeRequired
stringMust equal "rental"
Example request body (JSON)
{
  "deals": [
    {
      "analysisType": "rental",
      "asOfDate": "2026-01-01",
      "unitRents": [
        1200,
        1200
      ],
      "maintenancePercent": 5,
      "managementPercent": 8,
      "purchasePrice": 240000,
      "downPayment": 48000,
      "interestRate": 6,
      "loanTerm": 30,
      "closingCosts": 3500,
      "renovationCosts": 12000,
      "otherIncome": 0,
      "vacancyRate": 5,
      "propertyTax": 210,
      "insurance": 75,
      "hoaFees": 0,
      "utilities": 75,
      "otherExpenses": 50,
      "targetDscr": 1.25
    },
    {
      "analysisType": "rental",
      "asOfDate": "2026-01-01",
      "unitRents": [
        1300,
        1300
      ],
      "maintenancePercent": 5,
      "managementPercent": 8,
      "purchasePrice": 240000,
      "downPayment": 48000,
      "interestRate": 6,
      "loanTerm": 30,
      "closingCosts": 3500,
      "renovationCosts": 12000,
      "otherIncome": 0,
      "vacancyRate": 5,
      "propertyTax": 210,
      "insurance": 75,
      "hoaFees": 0,
      "utilities": 75,
      "otherExpenses": 50,
      "targetDscr": 1.25
    }
  ]
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "deals": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "asOfDate": {
                "type": "string",
                "format": "date",
                "minLength": 10,
                "maxLength": 10,
                "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                "description": "Gregorian calendar date, YYYY-MM-DD."
              },
              "unitRents": {
                "type": "array",
                "items": {
                  "type": "number",
                  "minimum": 0,
                  "maximum": 1000000000,
                  "description": "USD per month for this unit."
                },
                "minItems": 1,
                "maxItems": 50
              },
              "maintenancePercent": {
                "type": "number",
                "minimum": 0,
                "maximum": 100,
                "description": "Percentage points of scheduled monthly rent (8 means 8%)."
              },
              "managementPercent": {
                "type": "number",
                "minimum": 0,
                "maximum": 100,
                "description": "Percentage points of scheduled monthly rent (8 means 8%)."
              },
              "managementMonthlyAmount": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "purchasePrice": {
                "type": "number",
                "minimum": 0.01,
                "maximum": 1000000000,
                "description": "USD, one-time amount."
              },
              "downPayment": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD, one-time amount."
              },
              "interestRate": {
                "type": "number",
                "minimum": 0,
                "maximum": 50,
                "description": "Annual nominal interest rate in percentage points (6.5 means 6.5%)."
              },
              "loanTerm": {
                "type": "integer",
                "minimum": 1,
                "maximum": 50,
                "description": "Amortization term in whole years."
              },
              "closingCosts": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD, one-time amount."
              },
              "renovationCosts": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD, one-time amount."
              },
              "otherIncome": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "vacancyRate": {
                "type": "number",
                "minimum": 0,
                "maximum": 100,
                "description": "Percentage points of gross monthly income lost to vacancy."
              },
              "propertyTax": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "insurance": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "hoaFees": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "utilities": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "otherExpenses": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "targetDscr": {
                "type": "number",
                "minimum": 0,
                "maximum": 20,
                "description": "Debt-service coverage multiple (1.25 means 1.25×)."
              },
              "pmi": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "analysisType": {
                "const": "rental"
              }
            },
            "required": [
              "asOfDate",
              "unitRents",
              "maintenancePercent",
              "managementPercent",
              "purchasePrice",
              "downPayment",
              "interestRate",
              "loanTerm",
              "closingCosts",
              "renovationCosts",
              "otherIncome",
              "vacancyRate",
              "propertyTax",
              "insurance",
              "hoaFees",
              "utilities",
              "otherExpenses",
              "targetDscr",
              "analysisType"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "asOfDate": {
                "type": "string",
                "format": "date",
                "minLength": 10,
                "maxLength": 10,
                "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                "description": "Gregorian calendar date, YYYY-MM-DD."
              },
              "unitRents": {
                "type": "array",
                "items": {
                  "type": "number",
                  "minimum": 0,
                  "maximum": 1000000000,
                  "description": "USD per month for this unit."
                },
                "minItems": 1,
                "maxItems": 50
              },
              "maintenancePercent": {
                "type": "number",
                "minimum": 0,
                "maximum": 100,
                "description": "Percentage points of scheduled monthly rent (8 means 8%)."
              },
              "managementPercent": {
                "type": "number",
                "minimum": 0,
                "maximum": 100,
                "description": "Percentage points of scheduled monthly rent (8 means 8%)."
              },
              "managementMonthlyAmount": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "purchasePrice": {
                "type": "number",
                "minimum": 0.01,
                "maximum": 1000000000,
                "description": "USD, one-time amount."
              },
              "downPayment": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD, one-time amount."
              },
              "interestRate": {
                "type": "number",
                "minimum": 0,
                "maximum": 50,
                "description": "Annual nominal interest rate in percentage points (6.5 means 6.5%)."
              },
              "loanTerm": {
                "type": "integer",
                "minimum": 1,
                "maximum": 50,
                "description": "Amortization term in whole years."
              },
              "closingCosts": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD, one-time amount."
              },
              "renovationCosts": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD, one-time amount."
              },
              "otherIncome": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "vacancyRate": {
                "type": "number",
                "minimum": 0,
                "maximum": 100,
                "description": "Percentage points of gross monthly income lost to vacancy."
              },
              "propertyTax": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "insurance": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "hoaFees": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "utilities": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "otherExpenses": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "targetDscr": {
                "type": "number",
                "minimum": 0,
                "maximum": 20,
                "description": "Debt-service coverage multiple (1.25 means 1.25×)."
              },
              "pmi": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD per month."
              },
              "analysisType": {
                "const": "flip"
              },
              "flip": {
                "type": "object",
                "properties": {
                  "arv": {
                    "type": "number",
                    "minimum": 0.01,
                    "maximum": 1000000000,
                    "description": "Caller-assumed after-repair sale price in USD."
                  },
                  "rehabCosts": {
                    "type": "number",
                    "minimum": 0,
                    "maximum": 1000000000,
                    "description": "USD, one-time amount."
                  },
                  "holdingPeriod": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 120,
                    "description": "Holding period in whole months."
                  },
                  "monthlyHoldingCosts": {
                    "type": "number",
                    "minimum": 0,
                    "maximum": 1000000000,
                    "description": "USD per month."
                  }
                },
                "required": [
                  "arv",
                  "rehabCosts",
                  "holdingPeriod",
                  "monthlyHoldingCosts"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "asOfDate",
              "unitRents",
              "maintenancePercent",
              "managementPercent",
              "purchasePrice",
              "downPayment",
              "interestRate",
              "loanTerm",
              "closingCosts",
              "renovationCosts",
              "otherIncome",
              "vacancyRate",
              "propertyTax",
              "insurance",
              "hoaFees",
              "utilities",
              "otherExpenses",
              "targetDscr",
              "analysisType",
              "flip"
            ],
            "additionalProperties": false
          }
        ]
      },
      "minItems": 2,
      "maxItems": 4
    }
  },
  "required": [
    "deals"
  ],
  "additionalProperties": false,
  "description": "Compares two to four supplied property scenarios. Rental scores are comparable across rental rows. Flip rows show the same rental baseline as the comparison table and retain their independent flip ledger. Equal highest scores share the top rank."
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/investor-deal-comparison
Formula: investor-deal-comparison-1.0.0