SA4 - Profile

ABS geo profile

SA4's parent chain — GCCSA + state.

Price: 3¢ per call.

get/v1/sa4/{sa4_name}/profile

Request

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

Path parameters

sa4_namestring required
Example:Newcastle and Lake Macquarie

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": "Rest of NSW",
    "sa4": "Newcastle and Lake Macquarie",
    "state": "NSW"
  }
}

Changes

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