Microburbs
Live sandbox. Send any request below against one sample suburb and property — no signup needed. For full coverage, create an API key.
Classic docs
Microburbs Property Data API
Suburb - Demographics

Population and dwellings by mesh block (by suburb)

GET/v1/suburbs/{suburb_name}/demographics/population-map20¢ per call

Residents and dwellings on every microburb (mesh block) in the suburb, with the suburb totals. Values only; polygons come from /shapes/mesh-blocks.

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.

Authorization

Request

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

Path parameters

suburb_namestringrequired

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.

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
SuburbPopulationMapfields returned to you
suburbstringalways returned

Canonical SAL name.

metricstringalways returned

Always 'population'.

unitstringalways returned

Always 'people'.

definitionstringalways returned

How the figure is derived.

populationintegeralways returned

Residents summed over the suburb's microburbs.

dwellingsintegeralways returned

Dwellings summed over the suburb's microburbs.

n_microburbsintegeralways returned

Microburbs in the suburb.

microburbsarray of PopulationMbalways returned

Every microburb, by mesh-block code.

GET/v1/suburbs/{suburb_name}/demographics/population-map
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/demographics/population-map' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "suburb": "Belmont North",
    "metric": "population",
    "unit": "people",
    "definition": "Usual residents and dwellings on each mesh block ('microburb', ~30-60 dwellings). Every block in the suburb is listed, including parkland and commercial blocks with no residents. The sums are the suburb's totals.",
    "population": 6280,
    "dwellings": 2453,
    "n_microburbs": 85,
    "microburbs": [
      {
        "mb": "10431160000",
        "street": "Floraville",
        "population": 51,
        "dwellings": 23
      }
    ]
  }
}
Successful Response200
application/json