Skip to main contentSkip to main content

Resolve an address to a property_id

GET/v1/properties/search1 credit

Pass 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

NameInRequiredDescription
addressqueryyesStreet address (e.g. "1/8 Bristol Road" or "284 O'Hea Street"). Trailing comma tolerated.
postcodequeryyes4-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