Mesh Block - Profile

List mesh blocks in a suburb

GET/v1/mbs/list3¢ per call

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.

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.

Query parameters

salstringrequired

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

Responses

Successful Response

application/json

list[MeshBlockListItem]fields returned to you

Array of:

mb_codestringalways returned

ABS Mesh Block code.

suburbstringalways returned

Suburb (SAL) the MB sits in.

statestringalways returned

State / Territory abbreviation.

GET/v1/mbs/list

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/mbs/list?sal=Belmont%20North' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": [
    {
      "mb_code": "10434270000",
      "state": "NSW",
      "suburb": "Belmont North"
    }
  ]
}

Successful Response200

application/json