Trust-gated suburb rankings (Pro+ tier)

GET/v1/suburbs/rankings2 credits

Costs 2 credits. Ranks suburbs in a state by yield, growth, market heat, median price, or days on market after applying source-agreement, sample-size, suspicious-data, and sanity filters. Use it to build high-confidence suburb screens without surfacing raw data artifacts.

Parameters

Name	In	Required	Description
state	query	yes	State code, e.g. VIC or NSW
metric	query	no	yield_houses, yield_units, growth_1yr_houses, growth_1yr_units, heat_score_houses, heat_score_units, median_price_houses, median_price_units, days_on_market_houses, or days_on_market_units
property_type	query	no	houses or units; shorthand when metric is omitted
min_median_price	query	no	Optional trusted median price floor
max_median_price	query	no	Optional trusted median price ceiling
top	query	no	Rows to return (default 20, max 50)

Example request

curl "https://api.propradar.com.au/v1/suburbs/rankings?state=VIC&metric=yield_units&top=10" \
  -H "X-API-Key: pr_live_..."

Example response

{ "metric": "yield_units", "state": "VIC", "top": 10,
  "results": [{ "rank": 1, "suburb": "PASCOE VALE", "postcode": 3044,
                "metric_value": 5.4, "metric_confidence": "medium",
                "median_unit_price": 615000, "yield_units": 5.4,
                "sales_12mo_units": 42 }] }

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}
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
Investment score + cashflow (Pro+ tier) GET /v1/properties/{property_id}/investment_analysis
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