Suburb - Demographics

Regional & neighbour cohort ranks

GET/v1/suburbs/{suburb_name}/demographics/cohorts10¢ per call

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

Price: 10¢ per call.

Authorization

Bearer tokentest

Sandbox key test works for the allowlisted GNAF + SAL — no signup.

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

SuburbCohortsfields returned to you

suburbstringalways returned

Canonical SAL name.

sa4objectmay be null

The suburb's SA4 cohort.

n_neighboursintegeralways returned

Touching suburbs in the cohort.

metricsarray of CohortMetricalways returned

Per-metric comparisons.

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

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/demographics/cohorts' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "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"
  }
}

Successful Response200

application/json