Skip to main content
POST
Rental Property ROI Calculator

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioPurchasePrice
number
required

Purchase Price ($)

Required range: 0 <= x <= 999999999
ioDownPayment
number
required

Down Payment

Required range: 0 <= x <= 999999999
ioAnnualRate
number
required

Loan Interest Rate (%)

Required range: 0 <= x <= 100
ioMonthlyRent
number
required

Monthly Rent ($)

Required range: 0 <= x <= 999999
ioDownPaymentType
enum<string>

Down Payment Is

Available options:
percent,
dollar
ioLoanTermYears
enum<string>

Loan Term

Available options:
10,
15,
20,
30
ioClosingCosts
number

Closing & Rehab Costs ($)

Required range: 0 <= x <= 999999999
ioVacancyRate
number

Vacancy Rate (%)

Required range: 0 <= x <= 100
ioPropertyTaxAnnual
number

Property Tax ($/year)

Required range: 0 <= x <= 999999
ioInsuranceAnnual
number

Insurance ($/year)

Required range: 0 <= x <= 999999
ioHoaAnnual
number

HOA & Other ($/year)

Required range: 0 <= x <= 999999
ioManagementRate
number

Property Management (% of rent collected)

Required range: 0 <= x <= 100
ioMaintenanceRate
number

Maintenance & Repairs (% of rent collected)

Required range: 0 <= x <= 100

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.