REST API · v1.0
Build with 3Y
Real Estate Intelligence as a Service
One call delivers goal-convergent price, decision-grade scores, location intelligence, and multi-horizon exit projections across income-producing property types with customizable assumptions.
POST /v1/analyze
Analyzes a multifamily investment property against your goals. Only
address and number_of_units are required —
all other parameters are optional and default to location-calibrated
market values when omitted.
Required headers
X-3Y-API-Key
Your secret API key — keep server-side only.
Content-Type
application/json
Property & Goal
2 required · 4 optional
▾
FieldTypeDescription
address
Full US property address including street, city, state,
and ZIP.
number_of_units
Total rentable units at the property.
1 – 500
asking_price
Purchase price in USD. Enables cash-on-cash, DSCR, and ROI
calculations.
$50,000 – $100,000,000
monthly_rent
Average monthly rent per unit in USD. Defaults to local
market rent.
$200 – $25,000
goal_metric
Return metric to optimize for. Defaults to
cash_on_cash_return.
cash_on_cash_return · cap_rate ·
debt_service_coverage_ratio · cash_velocity
goal_value
Target threshold for
goal_metric as a
percentage. Defaults to location-calibrated value.
Performance & Stabilization
5 optional
▾
FieldTypeDescription
vacancy_rate
Expected vacancy as a percentage. Under 4% is tight; above
8% suggests softer demand. Defaults to market average.
0 – 30%
management_fee_rate
Property management fee as a percentage of gross rent.
Typically 3–12%.
0 – 25%
repair_maintenance_capex_rate
Repairs, maintenance, and capex reserve as a percentage of
gross rent. Typically 8–20% depending on property age.
0 – 30%
make_ready_amount
One-time post-acquisition touch-up allowance in USD. Often
$0 for stabilized properties.
$0 – $10,000,000
total_monthly_other_expenses
Total landlord-paid monthly expenses not captured
elsewhere (utilities, HOA, etc.) in USD for the whole
property.
$0 – $25,000 / month
Financing
4 optional
▾
FieldTypeDescription
mortgage_interest_rate
Annual mortgage interest rate as a percentage. Defaults to
current market rate for the location. A 0.5% change ≈
$180/mo on a $400k loan.
0 – 25%
mortgage_term
Loan term in years. Defaults to 30. Common values: 10, 15,
20, 25, 30.
1 – 30 years
down_payment_percentage
Down payment as a percentage of purchase price. Typical:
20–25% for conventional loans.
0 – 100%
closing_cost_percentage
Closing costs as a percentage of purchase price. Typically
2–5%; varies by lender and local taxes.
0 – 10%
Location Dynamics
4 optional
▾
FieldTypeDescription
property_tax_rate
Annual property tax as a percentage of assessed value.
Varies by county and local levy.
0 – 5%
market_cap_rate
Local market cap rate as a percentage. Lower (4–5%) in
premium markets, higher (8–10%) in more affordable
markets.
1 – 25%
home_price_growth
Expected annual property value growth as a percentage,
driven by local supply, demand, and job trends.
-10 – 20%
rent_growth
Expected annual rent increase as a percentage. Negative
values model declining rent markets.
-10 – 30%
Insurance
3 optional
▾
FieldTypeDescription
property_insurance_rate
Standard property insurance as a percentage of property
value annually. Typically 0.3–0.8%; higher in coastal
areas.
0 – 8%
flood_insurance_rate
Flood insurance as a percentage of property value. Applies
only in flood zones; varies by elevation and coverage.
0 – 8%
wind_insurance_rate
Wind insurance as a percentage of property value. Common
in hurricane-prone regions.
0 – 8%
Note on percentage fields: All rate and
percentage parameters are plain numbers — e.g.
7.12 for 7.12%, not 0.0712.
Headers
Minimal (required
only)
curl
Full example
200 Success
400 Bad Request
401 Unauthorized
429 Rate Limited
200 Response
Ready to start building?
Create a free account to get your API key. The Free plan includes 5 analyses every month to keep you moving.
Get Your API Key →