Calculators

Run what-if loan sizing across a range of assumptions: a rate ladder, an NOI sensitivity table, or the feasibility of...

Run what-if loan sizing across a range of assumptions: a rate ladder, an NOI sensitivity table, or the feasibility of a target loan amount against each constraint. Deterministic — same math as size_loan, swept.

post/api/v1/tools/run_scenario

Request

  • Base URL: https://relendi.com
  • URL: https://relendi.com/api/v1/tools/run_scenario
  • Auth: none declared

Request body

netOperatingIncomenumber required
estimatedValuenumber required
totalCostnumber
mode'rate_ladder' | 'noi_sensitivity' | 'loan_feasibility' required
ratesnumber[]
noiDeltaPctsnumber[]
desiredLoanAmountnumber

Response

The computed result.

tool'run_scenario' required
deterministicboolean
resultobject required

Result fields: mode, note, scenarios.recommendedLoan, scenarios.bindingConstraint, scenarios.byLtv, scenarios.byDscr, scenarios.byDebtYield, scenarios.byLtc, scenarios.thresholds.maxLtv, scenarios.thresholds.minDscr, scenarios.thresholds.minDebtYield, scenarios.thresholds.maxLtc, scenarios.thresholds.proposedRate, scenarios.thresholds.amortizationYears, scenarios.inputs.noi, scenarios.inputs.estimatedValue, scenarios.inputs.totalCost, scenarios.note, scenarios.label, feasibility.constraint, feasibility.maxLoan, feasibility.passes, feasibility.headroom.

Changes

No recorded changes to this operation across all 1 revision of this API.