Skip to main contentSkip to main content
PropRadarAPI
Get free key

Suggest addresses as the user types

GET/v1/addresses/suggest1 credit

Priced per session: pass the same `session` token (any 8-64 letters, digits, `-` or `_` you make up per address being typed) on each call and the first call costs 1 credit, then the next 15 within 3 minutes are free. The response's `session` block shows the call number and free calls left. Without a token every call costs 1 credit. Type-ahead for an address box. Send what the user has typed so far and get back the properties whose address contains it, ranked with on-market properties first, then sold, then off-market. No postcode needed. Every word must appear in the address; a leading street number or unit (`12`, `5/10`) must start it, and street-type abbreviations match either form (`st` finds Street, `rd` finds Road). Each suggestion carries the `property_id` to pass to `/v1/properties/{property_id}`. Identity only, so it is available on every plan. Needs at least 3 letters or digits; call it after a short pause in typing rather than on every keystroke.

Parameters

NameInRequiredDescription
qqueryyesThe address typed so far, e.g. `12 smith st rich`. 3 to 120 characters.
statequerynoLimit to one state (VIC, NSW, QLD, WA, SA, TAS, ACT, NT).
postcodequerynoLimit to one postcode.
limitquerynoSuggestions to return (default 5, max 10).
sessionquerynoYour own token for one address being typed (8-64 of A-Z a-z 0-9 - _). The first call in a session costs 1 credit; the next 15 within 3 minutes are free.

Example request

curl "https://api.propradar.com.au/v1/addresses/suggest?q=284%20o%27hea%20st&limit=5&session=addr-7f3c9a21" \
  -H "X-API-Key: pr_live_..."

Example response

{ "query": { "q": "284 o'hea st", "state": null, "postcode": null, "limit": 5 },
  "session": { "call": 3, "free_calls_left": 13 },
  "suggestions": [{ "property_id": "b4b38060",
                    "address": "284 O'Hea Street, Pascoe Vale South, VIC, 3044",
                    "suburb": "PASCOE VALE SOUTH", "state": "VIC", "postcode": 3044,
                    "status": "on_market" }] }

Get an API key

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

Get a free API keyFull API documentation

Other endpoints