Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
purchasePrice
number
required

Purchase Price ($)

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

Down Payment

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

Loan Interest Rate (%)

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

Monthly Rent ($)

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

Down Payment Is

Available options:
percent,
dollar
loanTermYears
enum<string>

Loan Term

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

Closing & Rehab Costs ($)

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

Vacancy Rate (%)

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

Property Tax ($/year)

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

Insurance ($/year)

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

HOA & Other ($/year)

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

Property Management (% of rent collected)

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

Maintenance & Repairs (% of rent collected)

Required range: 0 <= x <= 100

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

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

credits_remaining
integer | null
required

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

request_id
string

Correlation id, also sent as x-request-id.