Suburb - Development

Zoning map (polygons)

Zoning polygons clipped to the suburb, with per-class and parent-group area shares.

Exact suburb identifier required. Exact ABS Suburb and Locality (SAL) name, e.g. Burwood (NSW) — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call GET /v1/geocode/suburb?q=<text>, then use the exact data[].area_name it returns. Suburb data endpoints do not guess a state or typo-correct names.

Price: 25¢ per call.

get/v1/suburbs/{suburb_name}/development/zoning-map

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/development/zoning-map
  • Auth: HTTP bearer

Path parameters

suburb_namestring required
Example:Belmont North

Exact ABS Suburb and Locality (SAL) name, e.g. Burwood (NSW) — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call GET /v1/geocode/suburb?q=<text>, then use the exact data[].area_name it returns. Suburb data endpoints do not guess a state or typo-correct names.

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": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "geojson": {
      "features": [
        {
          "geometry": {
            "coordinates": [
              [
                [
                  151.6695,
                  -33.0018
                ],
                [
                  151.6702,
                  -33.0021
                ],
                [
                  151.6698,
                  -33.0027
                ],
                [
                  151.6695,
                  -33.0018
                ]
              ]
            ],
            "type": "Polygon"
          },
          "properties": {
            "lay_class": "Environmental Conservation",
            "sym_code": "C2",
            "parent": "Environmental",
            "color": "#27ae60"
          },
          "type": "Feature"
        }
      ],
      "type": "FeatureCollection"
    },
    "groups": [
      {
        "color": "#27ae60",
        "label": "Environmental",
        "pct": 24.3
      },
      {
        "color": "#e85d75",
        "label": "Residential",
        "pct": 64.1
      },
      {
        "color": "#f6c445",
        "label": "Commercial",
        "pct": 1.6
      },
      {
        "color": "#b8b8b8",
        "label": "Other",
        "pct": 10
      }
    ],
    "legend": [
      {
        "color": "#e85d75",
        "lay_class": "Low Density Residential",
        "parent": "Residential",
        "pct": 62.4,
        "sym_code": "R2"
      },
      {
        "color": "#27ae60",
        "lay_class": "Environmental Conservation",
        "parent": "Environmental",
        "pct": 21.9,
        "sym_code": "C2"
      }
    ]
  }
}

Changes

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