Similar suburbs
/v1/suburbs/{suburb_name}/similar60¢ per callTop-10 suburbs ranked closest by Microburbs' similarity model.
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: 60¢ per call.
Authorization
Request
The only values you send. Fields under Responses below are what comes back — you never pass those.
Path parameters
suburb_namestringrequiredExact 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
Responses
Successful Response
area_namestringalways returnedSimilar suburb's SAL name.
area_levelstringalways returnedAlways 'suburb'.
summarystringmay be nullPlain-language explanation of the similarity.
keywordsstringmay be nullComma-separated tags describing the suburb.
priceobjectmay be nullA scalar value broken down by property type.
/v1/suburbs/{suburb_name}/similarcurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/similar' \
--header 'Authorization: Bearer test'{
"data": [
{
"area_name": "Coogee",
"area_level": "suburb",
"summary": "Like Bondi, Coogee also has a buzzing beach culture and vibrant cafe scene. However, Coogee is generally considered quieter and more family-friendly.",
"keywords": "Quieter, Family-friendly",
"price": {}
},
{
"area_name": "Manly",
"area_level": "suburb",
"summary": "Manly is similar to Bondi in terms of its beachside lifestyle and tourist attractions. But it's somewhat isolated from the city center compared to Bondi.",
"keywords": "Isolated, Tourist Spot",
"price": {}
},
{
"area_name": "Bronte",
"area_level": "suburb",
"summary": "Bronte, just like Bondi, is known for its stunning beach and popular coastal walk. Unlike Bondi, Bronte has a quieter and more relaxed vibe.",
"keywords": "Relaxed, Less Crowded",
"price": {
"house": 6120000,
"unit": 1910000
}
}
]
}