Bulk suburb/postcode reference dump
GET /api/v5/locations/all/
GET
/api/v5/locations/all/
Returns the entire Australian suburb/postcode/state reference table for client-side (IndexedDB) caching. Edge-cached and identical for every visitor. The trailing slash is part of the route.
Responses
Section titled “ Responses ”Full suburb reference dump
object
count
required
Total number of suburb rows returned in suburbs.
integer
suburbs
required
Every valid Australian suburb/postcode/state row, for client-side (IndexedDB) caching.
Array<object>
object
id
Suburbs_code row id. A soft reference for ranking and joins, not an identity — reference data gets reloaded.
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
Ranking hint used to order localities that share a postcode.
number