List valid suburbs (paged)

GET

/api/v5/locations

• Production

Returns a page of valid Australian suburb/postcode/state rows. When a q query is supplied the request is redirected to the location search endpoint.

Parameters

Query Parameters

q

When present, the request is redirected to the location search endpoint.

string

When present, the request is redirected to the location search endpoint.

limit

Maximum suburb rows per page (1-5000); defaults to 1000.

string

Maximum suburb rows per page (1-5000); defaults to 1000.

Responses

200

Paged suburb list

object

code

required

Status code echoed in the body; always 200 for a successful page.

number

Allowed values: 200

next_page

Absolute URL of the next page of results; present only when the current page is full and more rows may exist.

string

prev_page

Absolute URL of the previous page of results; present only when the current page number is greater than 1.

string

locations

required

Suburb/locality rows for this page, ordered by postcode.

Array<object>

object

id

Any of:

number

number

string

string

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

number

string

string

302

Redirect to the location search endpoint when q is supplied