Microburbs
Microburbs API
Open in the full API reference →
Suburb - Development

Zoning map (polygons)

GET/v1/suburbs/{suburb_name}/development/zoning-map25¢ per call

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

Price: 25¢ per call.

Authorization

Request

The only values you send. Fields under Responses below are what comes back — you never pass those.

Path parameters

suburb_namestringrequired

Query parameters

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Responses

Successful Response

application/json
SuburbZoningMapfields returned to you
area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb'.

legendarray of ZoningLegendRowalways returned

Per-class area shares, largest first.

groupsarray of ZoningGroupalways returned

Parent-group area shares (Environmental / Residential / Commercial / Other).

geojsonobjectalways returned

RFC 7946 FeatureCollection.

GET/v1/suburbs/{suburb_name}/development/zoning-map
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/development/zoning-map' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "area_name": "Belmont North",
    "area_level": "suburb",
    "legend": [
      {
        "lay_class": "Low Density Residential",
        "sym_code": "R2",
        "parent": "Residential",
        "color": "#e85d75",
        "pct": 62.4
      },
      {
        "lay_class": "Environmental Conservation",
        "sym_code": "C2",
        "parent": "Environmental",
        "color": "#27ae60",
        "pct": 21.9
      }
    ],
    "groups": [
      {
        "label": "Environmental",
        "pct": 24.3,
        "color": "#27ae60"
      },
      {
        "label": "Residential",
        "pct": 64.1,
        "color": "#e85d75"
      },
      {
        "label": "Commercial",
        "pct": 1.6,
        "color": "#f6c445"
      },
      {
        "label": "Other",
        "pct": 10,
        "color": "#b8b8b8"
      }
    ],
    "geojson": {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  151.6695,
                  -33.0018
                ],
                [
                  151.6702,
                  -33.0021
                ],
                [
                  151.6698,
                  -33.0027
                ],
                [
                  151.6695,
                  -33.0018
                ]
              ]
            ]
          },
          "properties": {
            "lay_class": "Environmental Conservation",
            "sym_code": "C2",
            "parent": "Environmental",
            "color": "#27ae60"
          }
        }
      ]
    }
  }
}
Successful Response200
application/json