Resolve an address to a property_id
/v1/properties/search1 creditPass a street + postcode; the API does a case-insensitive prefix match against on-market and sold records and returns up to 10 matching property_ids in `matches[]`. The top-level `property_id`, `found`, `on_market`, and `sold_record_available` fields mirror the first match for v1 back-compat. You don't need the full "street, SUBURB, STATE, postcode" form; just the street as it would appear on a listing. If no match is found, `property_id` is null, `found:false`, `matches:[]`, and a scope hint explains that off-market properties may be outside coverage. Start here for any workflow that needs a property_id: the other property endpoints all take an id, and search is the only one that can resolve a raw address.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
| address | query | yes | Street address (e.g. "1/8 Bristol Road" or "284 O'Hea Street"). Trailing comma tolerated. |
| postcode | query | yes | 4-digit postcode |
Example request
curl "https://api.propradar.com.au/v1/properties/search?address=1/8+Bristol+Road&postcode=3044" \
-H "X-API-Key: pr_live_..."Example response
{
"property_id": "a1b2c3d4",
"found": true,
"on_market": true,
"sold_record_available": false,
"matches": [
{ "property_id": "a1b2c3d4",
"address": "1/8 Bristol Road, PASCOE VALE, VIC, 3044",
"on_market": true,
"sold_record_available": false }
]
}Get an API key
Every endpoint takes an X-API-Key header. The free tier needs no credit card.
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
- 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
- Turn free text into suburbs GET /v1/suburbs/resolve