Mesh Block - Profile

List mesh blocks in a suburb

Mesh-block codes inside a suburb. sal is required for now — nationwide / by-LGA / by-SA3 listings will land later when there's a story for the large payloads (a single LGA can hit a few thousand mesh blocks).

Price: 3¢ per call.

get/v1/mbs/list

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/mbs/list
  • Auth: HTTP bearer

Query parameters

salstring required

Required. Suburb (SAL) to list mesh blocks for.

Example:Belmont North

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": [
    {
      "mb_code": "10434270000",
      "state": "NSW",
      "suburb": "Belmont North"
    }
  ]
}

Changes

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