Suburb - Hero

Suburb at a glance

State, SA3/SA4, postcode, population, dwellings and centroid for the suburb.

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

get/v1/suburbs/{suburb_name}/hero/summary

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/hero/summary
  • 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": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "dwellings": 2453,
    "lat": -33.01705,
    "lng": 151.672252,
    "population": 6280,
    "postcode": "2280",
    "sa3": "Lake Macquarie - East",
    "sa4": "Newcastle and Lake Macquarie",
    "state": "New South Wales",
    "state_abbr": "NSW"
  }
}

Changes

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