Suburb - Demographics

Regional & neighbour cohort ranks

How the suburb ranks inside its SA4 region and against its touching neighbours on renter share, welfare dependency, overseas-born parents and public housing.

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

get/v1/suburbs/{suburb_name}/demographics/cohorts

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/demographics/cohorts
  • 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": {
    "metrics": [
      {
        "field": "mib_perc_renters",
        "label": "Renter share",
        "neighbours": {
          "dramatic": {
            "delta_pct": 258,
            "suburb": "Windale",
            "value_pct": 39.4
          },
          "highest_in_group": false,
          "lowest_in_group": false,
          "n": 7
        },
        "sa4": {
          "delta_pct": 34,
          "n": 135,
          "percentile": 34,
          "position": "bottom"
        },
        "value_pct": 11
      }
    ],
    "n_neighbours": 7,
    "sa4": {
      "cohort_size": 148,
      "name": "Newcastle and Lake Macquarie"
    },
    "suburb": "Belmont North"
  }
}

Changes

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