Investment score + cashflow (Pro+ tier)

GET/v1/properties/{property_id}/investment_analysis3 credits

Costs 3 credits. Full investment-score component breakdown plus derived gross/net yield using the property's reference price. Same score the consumer site shows behind its Pro paywall: yield, capital growth, market dynamics, location, value-buy, risk. Hobby/Starter callers get 403 plan_upgrade_required; the credits are refunded.

Parameters

Name	In	Required	Description
property_id	path	yes	8- or 12-char hex property id

Example request

curl "https://api.propradar.com.au/v1/properties/{property_id}/investment_analysis" \
  -H "X-API-Key: pr_live_..."

Example response

{
  "property_id": "a1b2c3d4",
  "investment_score": 68.2,
  "confidence": "high",
  "score_breakdown": {
    "yield_score": 7.2, "capital_growth": 14.5,
    "market_dynamics": 12.1, "value_buy": 16.2,
    "location": 11.3, "risk_adjustment": -8.4,
    "base_score": 57.7, "relative_percentile": 68.0,
    "version": 9
  },
  "cashflow": {
    "reference_price": 665000,
    "annual_rental_income": 25688,
    "gross_yield_pct": 3.9, "net_yield_pct": 2.8,
    "assumptions": { "expense_ratio_pct": 25, "vacant_weeks_per_year": 2,
                     "reference_price_source": "potential_sell_price" }
  }
}

Get an API key

Every endpoint takes an X-API-Key header. The free tier needs no credit card.

Get a free API key Full API documentation

Other endpoints

Many suburbs in one call: statistics and recent sales POST /v1/suburbs/batch
List every suburb in the dataset (coverage index) GET /v1/suburbs
Authenticated health probe GET /v1/health
Account usage and credit allowance GET /v1/usage
Resolve an address to a property_id GET /v1/properties/search
Look up a single property GET /v1/properties/{property_id}
Recent sold comparables (Hobby+; lat/lng mode Pro+) GET /v1/comparables
Suburb statistics GET /v1/suburbs/{state}/{suburb}
Trust-gated suburb rankings (Pro+ tier) GET /v1/suburbs/rankings
Multi-criteria suburb screener (Pro+ tier) GET /v1/suburbs/screen
Recent sold properties in a suburb GET /v1/suburbs/{state}/{suburb}/sold
Current active listings in a suburb GET /v1/suburbs/{state}/{suburb}/listings
Search current listings across a whole state (Pro+ tier) GET /v1/properties/listings
Property event history GET /v1/properties/{property_id}/history
Most recent sold record (Hobby+ tier) GET /v1/properties/{property_id}/sold_summary
Potential sell price confidence band GET /v1/properties/{property_id}/psp_with_confidence
Similar active listings GET /v1/properties/{property_id}/similar
Nearby active listings GET /v1/properties/{property_id}/nearby
Batch property lookup (Starter+ tier) POST /v1/properties/bulk
Value an off-market address: instant estimate or enhanced valuation (Hobby+ tier) POST /v1/valuations
Poll an off-market valuation job GET /v1/valuations/{id}
Valuation range for a locality, no address needed (Pro+ tier) POST /v1/valuations/estimate
12-month outlook for house/unit price and rent (Pro+ tier) GET /v1/suburbs/{state}/{suburb}/forecast
Development applications near a point (Pro+ tier) GET /v1/developments/nearby
Properties currently advertised for rent in a suburb (Hobby+ tier) GET /v1/suburbs/{state}/{suburb}/rentals
Weekly rent estimate for a locality, no address needed (Pro+ tier) POST /v1/rent/estimate
Recently-modified event feed (Starter+ tier) GET /v1/properties/recently-modified
Market cycle classification (Pro+ tier) GET /v1/suburbs/{state}/{suburb}/market_cycle
Annual price/rent/yield time-series (Pro+ tier) GET /v1/suburbs/{state}/{suburb}/price_history
Market-heat time-series (Pro+ tier) GET /v1/suburbs/{state}/{suburb}/heat_history
List macro regions (Growth+ tier) GET /v1/regions
Region macro indicators (Growth+ tier) GET /v1/regions/{slug}
Suggest addresses as the user types GET /v1/addresses/suggest
Turn free text into suburbs GET /v1/suburbs/resolve