GET
List Suburbs
http://127.0.0.1:2025/api/suburb/suburbs
Retrieves Australian suburbs. Use the 'suburb' parameter to perform a fuzzy search on suburb names.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
suburb |
text | Optional | Search for suburbs by name (fuzzy search) |
state |
text | Optional | State (NSW, ACT, VIC, SA, WA, TAS, NT, OT) |
page |
number | Optional | Page number (default: 1) |
limit |
number | Optional | Number of results per page (default: 50, max: 500) |
Response Schema
| Field | Type | Description |
|---|---|---|
page |
number | Current page number |
total_pages |
number | Total number of pages available |
total_records |
number | Total number of suburbs matching the criteria |
results |
array | Array of suburb objects |
results[].area_level |
string | Type of area (e.g., 'suburb') |
results[].area_name |
string | Suburb name |
results[].information |
object | Administrative information about the suburb |
results[].information.ced |
string | Electoral Division |
results[].information.cr |
string | City Region |
results[].information.gccsa |
string | Greater Capital City Statistical Area |
results[].information.lga |
string | Local Government Area |
results[].information.poa |
string | Postal Area (postcode) |
results[].information.sa2 |
string | Statistical Area Level 2 |
results[].information.sa3 |
string | Statistical Area Level 3 |
results[].information.sa4 |
string | Statistical Area Level 4 |
results[].information.sed |
string | State Electoral Division |
results[].information.state |
string | State or territory |
Request Examples
cURL
Python
JavaScript
curl -X GET "http://127.0.0.1:2025/api/suburb/suburbs?suburb=Belmont%20North" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Response Example
Response
{
"page": 1,
"results": [
{
"area_level": "suburb",
"area_name": "Belmont North",
"information": {
"ced": "Shortland",
"cr": "Newcastle and Lake Macquarie",
"gccsa": "Rest of NSW",
"lga": "Lake Macquarie",
"poa": "2280",
"sa2": "Belmont - Bennetts Green",
"sa3": "Lake Macquarie - East",
"sa4": "Newcastle and Lake Macquarie",
"sed": "Swansea",
"state": "New South Wales"
}
}
],
"total_pages": 1,
"total_records": 1
}