Skip to content
Transdirect Developer Centre

Search valid suburbs and postcodes

GET
/api/v5/locations/search

Searches the V5 database copy of valid Australian suburb/postcode/state rows. This route intentionally runs in V5 instead of the old PHP location autocomplete endpoint.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
q

Suburb or postcode prefix. Blank returns a bounded default list plus countries.

string

Suburb or postcode prefix. Blank returns a bounded default list plus countries.

limit

Maximum suburb rows to return. Defaults to 1000 for blank search and 100 for prefix search.

integer
<= 5000
Example
100

Maximum suburb rows to return. Defaults to 1000 for blank search and 100 for prefix search.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Location search response

object
locations
required

Matching suburb and country locations for the search query.

Array
Any of:
object
id
Any of:
number
locality
required

Suburb or town name.

string
postcode
required

Postal code for the locality (4-digit for Australia).

string
state
required

State or territory code (e.g. NSW, VIC, QLD).

string
priority
Any of:
number