Turn free text into suburbs

GET/v1/suburbs/resolve1 credit

Resolve what a user typed - a suburb, a misspelling, a wider place name, a postcode - into the suburbs we hold, each with the `path` to request it. Trailing state codes and postcodes in `q` act as filters (`richmond vic`, `Richmond VIC 3121`). `match_type` says why each suburb matched: `exact`, `postcode`, `prefix` (`logan` finds Logan Central and Logan Reserve), `word` (`noarlunga` finds Port Noarlunga), `contains`, or `fuzzy` for a likely misspelling (`werribbee` finds Werribee). Only suburbs with data are returned. Use it before `/v1/suburbs/{state}/{suburb}` instead of guessing names and paying for 404s.

Parameters

Name	In	Required	Description
q	query	yes	Suburb name, place, or postcode, optionally followed by a state code and postcode.
state	query	no	Limit to one state. Overrides a state code in `q`.
limit	query	no	Suburbs to return (default 5, max 20).

Example request

curl "https://api.propradar.com.au/v1/suburbs/resolve?q=werribbee" \
  -H "X-API-Key: pr_live_..."

Example response

{ "query": { "q": "werribbee", "name": "WERRIBBEE", "state": null, "postcode": null, "limit": 5 },
  "suburbs": [{ "suburb": "WERRIBEE", "state": "VIC", "postcode": 3030,
                "match_type": "fuzzy", "score": 0.73,
                "path": "/v1/suburbs/VIC/werribee" }] }

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
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