Suburb - Similar

Similar suburbs

GET/v1/suburbs/{suburb_name}/similar60¢ per call

Top-10 suburbs ranked closest by Microburbs' similarity model.

Price: 60¢ 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

list[SimilarSuburb]fields returned to you

Array of:

area_namestringalways returned

Similar suburb's SAL name.

area_levelstringalways returned

Always 'suburb'.

summarystringmay be null

Plain-language explanation of the similarity.

keywordsstringmay be null

Comma-separated tags describing the suburb.

priceobjectmay be null

A scalar value broken down by property type.

GET/v1/suburbs/{suburb_name}/similar

cURL

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

Example Responses

Show schema

{
  "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
      }
    }
  ]
}

Successful Response200

application/json