Suburb - Lifestyle

Livability narrative sentences

GET/v1/suburbs/{suburb_name}/lifestyle/narrative10¢ per call

One plain-English sentence per livability dimension for the suburb.

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

LifestyleNarrativefields returned to you

area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

sentencesobjectalways returned

One plain-English sentence per livability dimension. A dimension is omitted when no sentence exists for it. No ``safety`` key — the upstream crime sentence is SEIFA text, deliberately excluded.

GET/v1/suburbs/{suburb_name}/lifestyle/narrative

cURL

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

Example Responses

Show schema

{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "sentences": {
      "affluence": "37% own outright. Only 10% hold university degrees. Household income $1,728/wk.",
      "convenience": "No train nearby (9 km). Nearest supermarket: Coles (851m). Hospital 2.9 km."
    }
  }
}

Successful Response200

application/json