Property - Profile

ABS geo profile

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.

get/v1/properties/{gnaf_id}/profile

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/properties/{gnaf_id}/profile
  • Auth: HTTP bearer

Path parameters

gnaf_idstring required
Example:GANSW704074813

Response

Successful Response

availableboolean nullable

false on no-data responses. Omitted on success — branch on data !== null if you want a single discriminator.

reasonstring nullable

Machine-readable slug naming the no-data condition (e.g. no_avm_for_GANSW704074813). Stable per endpoint. Omitted on success.

messagestring nullable

Human-readable explanation. Omitted on success.

Example response

{
  "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)"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.