Property - Profile

ABS geo profile

GET/v1/properties/{gnaf_id}/profile3¢ per call

Resolve a GNAF to its full ABS Statistical Geography Standard hierarchy (Mesh Block → SA1 → SA2 → SA3 → SA4 → GCCSA → State) plus the parallel admin chain (LGA, suburb (SAL), postcode). Call this once to get every ABS key the rest of the data layers index on.

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

gnaf_idstringrequired

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

PropertyProfilefields returned to you

mesh_blockstringalways returned

ABS Mesh Block code.

sa1stringalways returned

SA1 code.

sa2stringalways returned

SA2 name.

sa3stringalways returned

SA3 name.

sa4stringalways returned

SA4 name.

gccsastringalways returned

Greater Capital City Statistical Area.

statestringalways returned

State / Territory.

lgastringmay be null

Local Government Area.

suburbstringmay be null

Suburb (SAL — ABS Suburb and Locality).

postcodestringmay be null

Postcode (POA).

GET/v1/properties/{gnaf_id}/profile

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/profile' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "gccsa": "Australian Capital Territory",
    "lga": "Unincorporated ACT",
    "mesh_block": "80111103200",
    "postcode": "2902",
    "sa1": "80101102001",
    "sa2": "Kambah",
    "sa3": "Tuggeranong",
    "sa4": "Australian Capital Territory",
    "state": "ACT",
    "suburb": "Kambah (ACT)"
  }
}

Successful Response200

application/json