Microburbs
Microburbs API
Live sandbox. Send any request below against one sample suburb and property — no signup needed. For full coverage, create an API key.
Classic docs
Microburbs Property Data API
Suburb - Hero

Suburb at a glance

GET/v1/suburbs/{suburb_name}/hero/summary5¢ per call

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.

Authorization

Request

The only values you send. Fields under Responses below are what comes back — you never pass those.

Path parameters

suburb_namestringrequired

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.

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
HeroSummaryfields returned to you
area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

statestringmay be null

State / territory full name, e.g. 'New South Wales'.

state_abbrstringmay be null

State / territory abbreviation, e.g. 'NSW'.

sa3stringmay be null

ABS SA3 region the suburb sits in.

sa4stringmay be null

ABS SA4 region the suburb sits in.

postcodestringmay be null

Postcode (POA) covering the suburb.

populationintegermay be null

Total population (sum over the suburb's mesh blocks, ABS Census).

dwellingsintegermay be null

Total dwellings (sum over the suburb's mesh blocks, ABS Census).

latnumbermay be null

Latitude of the suburb boundary's centroid.

lngnumbermay be null

Longitude of the suburb boundary's centroid.

GET/v1/suburbs/{suburb_name}/hero/summary
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/hero/summary' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "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"
  }
}
Successful Response200
application/json