SA4 - Profile

ABS geo profile

GET/v1/sa4/{sa4_name}/profile3¢ per call

SA4's parent chain — GCCSA + state.

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

sa4_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

Sa4Profilefields returned to you

sa4stringalways returned

SA4 name.

gccsastringmay be null

Greater Capital City Statistical Area.

statestringmay be null

State / Territory abbreviation.

GET/v1/sa4/{sa4_name}/profile

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/sa4/Newcastle%20and%20Lake%20Macquarie/profile' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "gccsa": "Rest of NSW",
    "sa4": "Newcastle and Lake Macquarie",
    "state": "NSW"
  }
}

Successful Response200

application/json