Suburb - Development

Building controls — height & FSR

Height-of-building and floor-space-ratio control polygons with band summaries.

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: 20¢ per call.

get/v1/suburbs/{suburb_name}/development/building-controls

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/development/building-controls
  • 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",
    "hob": {
      "geojson": {
        "features": [
          {
            "geometry": {
              "coordinates": [
                [
                  [
                    151.668,
                    -33.017
                  ],
                  [
                    151.672,
                    -33.017
                  ],
                  [
                    151.672,
                    -33.02
                  ],
                  [
                    151.668,
                    -33.017
                  ]
                ]
              ],
              "type": "Polygon"
            },
            "properties": {
              "height_m": 8.5,
              "units": "m",
              "band": "≤ 8.5m",
              "color": "#fef9c3"
            },
            "type": "Feature"
          }
        ],
        "type": "FeatureCollection"
      },
      "legend": [
        {
          "color": "#fef9c3",
          "label": "≤ 8.5m",
          "pct": 84.2
        },
        {
          "color": "#fbbf24",
          "label": "8.5–12m",
          "pct": 15.8
        }
      ],
      "most_common_height_m": 8.5,
      "pct_most_common": 71,
      "zones_mapped": 17
    }
  }
}

Changes

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