GET
Similar Suburbs
http://127.0.0.1:2026/api/suburb/similar
Retrieves a list of suburbs that are similar to the specified suburb based on various characteristics. For each similar suburb, includes property prices, comparison keywords, and a summary of similarities and differences.
Important: The suburb parameter must use the official naming convention.
You can retrieve the official name for a suburb from the List Suburbs API Endpoint.
You can retrieve the official name for a suburb from the List Suburbs API Endpoint.
Click to see documentation
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
suburb |
text | Required | The name of the suburb |
geojson |
boolean | Optional | Set to 'true' to include geometric shape data of similar suburbs (default: false) |
Response Schema
| Field | Type | Description |
|---|---|---|
results |
array | Array of similar suburbs |
results[].area_level |
string | Geographical level (e.g., 'suburb') |
results[].area_name |
string | Name of the similar suburb |
results[].keywords |
string | Comma-separated list of key characteristics or differences |
results[].price |
object | Median property prices by property type |
results[].price.house |
number | Median house price in the similar suburb |
results[].price.unit |
number | Median unit/apartment price in the similar suburb |
results[].summary |
string | Descriptive summary comparing this suburb to the requested suburb |
results[].geometry |
object | GeoJSON geometry data of the suburb (only included when geojson=true) |
Request Examples
cURL
Python
JavaScript
curl -X GET "http://127.0.0.1:2026/api/suburb/similar?suburb=Belmont%20North" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Response Example
Response
{
"results": [
{
"area_level": "suburb",
"area_name": "Merewether",
"keywords": "Beach proximity, More upscale",
"price": {
"house": 1830000,
"unit": 799000
},
"summary": "Merewether shares the close proximity to the beach and green spaces, but is more upscale and trendy."
},
{
"area_level": "suburb",
"area_name": "The Junction",
"keywords": "Affluent, Urban proximity",
"price": {
"house": 1650000,
"unit": 803000
},
"summary": "The Junction shares the close-knit community feel but it's a bit more affluent and closer to the cosmopolitan city life."
},
{
"area_level": "suburb",
"area_name": "New Lambton",
"keywords": "Similar vibe, Pricier",
"price": {
"house": 1050000,
"unit": 700000
},
"summary": "New Lambton is similar with its surburbian vibe and availability of local amenities, but it has a higher median house price."
},
{
"area_level": "suburb",
"area_name": "Charlestown (NSW)",
"keywords": "More commercial, Greener",
"price": {
"house": 955000,
"unit": 710000
},
"summary": "Charlestown has a larger commercial center but similarly boasts a wide variety of houses and green spaces."
},
{
"area_level": "suburb",
"area_name": "Islington",
"keywords": "More Urban, Busier",
"price": {
"house": 947000,
"unit": 809000
},
"summary": "Islington is similar in the lively, community-centered atmosphere, but it has a more bustling and urban feel."
}
]
}