Suburb - Demographics

Dominant ancestry per microburb

GET/v1/suburbs/{suburb_name}/demographics/ancestry-map10¢ per call

The dominant ancestry (and its share) in each of the suburb's microburbs, plus suburb-level ancestry shares. Pilot coverage.

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

SuburbAncestryMapfields returned to you

suburbstringalways returned

Canonical SAL name.

n_microburbsintegeralways returned

Microburbs with ancestry data.

microburbsarray of AncestryMbalways returned

Dominant ancestry per microburb.

suburb_ancestry_sharesarray of AncestrySharealways returned

Suburb-level ancestry shares, descending.

GET/v1/suburbs/{suburb_name}/demographics/ancestry-map

cURL

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

Example Responses

Show schema

{
  "data": {
    "microburbs": [
      {
        "dominant_ancestry": "Anglo-Australian",
        "mb": "10694860000",
        "persons": 118,
        "share_pct": 62.1,
        "street": "Edinburgh Rd"
      }
    ],
    "n_microburbs": 37,
    "suburb": "Castlecrag",
    "suburb_ancestry_shares": [
      {
        "ancestry": "Anglo-Australian",
        "pct": 58.4
      },
      {
        "ancestry": "Chinese",
        "pct": 12.9
      }
    ]
  }
}

Successful Response200

application/json