Mesh Block - Profile

ABS geo profile

The mesh block's upward ABS chain — SA1, SA2/3/4, GCCSA, state — plus the parallel admin chain (LGA, suburb (SAL), postcode).

Price: 3¢ per call.

get/v1/mbs/{mb_code}/profile

Request

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

Path parameters

mb_codestring required
Example:10434270000

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",
    "lga": "Lake Macquarie",
    "mesh_block": "10434270000",
    "postcode": "2280",
    "sa1": "11101120618",
    "sa2": "Belmont - Bennetts Green",
    "sa3": "Lake Macquarie - East",
    "sa4": "Newcastle and Lake Macquarie",
    "state": "NSW",
    "suburb": "Belmont North"
  }
}

Changes

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