Suburb - Market

Comparable suburbs

GET/v1/suburbs/{suburb_name}/market/comparable-suburbs10¢ per call

Same-SA3 comparable-suburb candidates (canonical SAL names).

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

ComparableSuburbsfields returned to you

area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

nintegermay be null

Number of candidates.

comparable_suburbsarray of stringalways returned

Canonical SAL names in the same SA3.

GET/v1/suburbs/{suburb_name}/market/comparable-suburbs

cURL

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

Example Responses

Show schema

{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "comparable_suburbs": [
      "Argenton",
      "Belmont (NSW)",
      "Belmont South"
    ],
    "n": 49
  }
}

Successful Response200

application/json