Suburb - Profile

ABS geo profile

GET/v1/suburbs/{suburb_name}/profile3¢ per call

The suburb's upward ABS admin chain — LGA, SA2/3/4, GCCSA, state, postcode. Use /v1/suburbs/list to discover canonical SAL names (and filter by state / LGA / SA4 / postcode).

Price: 3¢ per call.

Authorization

Bearer tokentest

Sandbox key test works for the allowlisted GNAF + SAL — no signup.

Request

The only values you send. Fields under Responses below are what comes back — you never pass those.

Path parameters

suburb_namestringrequired

Query parameters

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Responses

Successful Response

application/json

SuburbProfilefields returned to you

suburbstringalways returned

Suburb (SAL — ABS Suburb and Locality).

lgastringmay be null

Local Government Area.

sa2stringmay be null

SA2 name.

sa3stringmay be null

SA3 name.

sa4stringmay be null

SA4 name.

gccsastringmay be null

Greater Capital City Statistical Area.

statestringmay be null

State / Territory.

postcodestringmay be null

Postcode (POA).

GET/v1/suburbs/{suburb_name}/profile

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/profile' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "gccsa": "Rest of NSW",
    "lga": "Lake Macquarie",
    "postcode": "2280",
    "sa2": "Belmont - Bennetts Green",
    "sa3": "Lake Macquarie - East",
    "sa4": "Newcastle and Lake Macquarie",
    "state": "New South Wales",
    "suburb": "Belmont North"
  }
}

Successful Response200

application/json