GET
Neighbours Information
https://www.microburbs.com.au/report_generator/api/property/neighbours
Retrieves a property's information and its surrounding neighbours with attributes and transaction history. Optionally includes geometry data.
Important: The id parameter refers to the property's GNAF ID.
You can retrieve this value from Get GNAF_ID (Geocoder) API Endpoint. Click to see documentation
You can retrieve this value from Get GNAF_ID (Geocoder) API Endpoint. Click to see documentation
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | text | Required | Property identifier (GnafID) |
| geojson | boolean | Optional | Set to 'true' to include geometric shape data for each pocket (default: false) |
Response Schema
| Field | Type | Description |
|---|---|---|
| property | object | Main property information |
| property.address | string | Street address of the property |
| property.bathrooms | number | Number of bathrooms |
| property.bedrooms | number | Number of bedrooms |
| property.garage_spaces | number | Number of garage spaces |
| property.gnaf_pid | string | Unique GNAF property identifier |
| property.property_type | string | Type of property (e.g., 'house', 'unit') |
| property.status | string | Current status (e.g., 'owner-occupied', 'rented', 'for sale') |
| property.property_history | array | List of historical transactions for the property |
| property.property_history[].date | string | Transaction date |
| property.property_history[].price | number|null | Transaction price, may be null for rentals |
| property.property_history[].type | string | Transaction type ('Sold', 'For Rent', 'For Sale') |
| neighbours | array | List of neighboring properties |
| neighbours[].address | string | Address of the neighbor |
| neighbours[].bathrooms | number | Number of bathrooms |
| neighbours[].bedrooms | number | Number of bedrooms |
| neighbours[].garage_spaces | number | Number of garage spaces |
| neighbours[].gnaf_pid | string | GNAF ID of the neighbor |
| neighbours[].property_type | string|null | Type of property (e.g., 'house', 'unit'), may be null |
| neighbours[].status | string | Current status (e.g., 'owner-occupied') |
| neighbours[].property_history | array | List of historical transactions |
| neighbours[].property_history[].date | string | Transaction date |
| neighbours[].property_history[].price | number|null | Transaction price or rental amount |
| neighbours[].property_history[].type | string | Transaction type ('Sold', 'For Rent', 'For Sale') |
Request Examples
cURL
Python
JavaScript
curl -X GET "https://www.microburbs.com.au/report_generator/api/property/neighbours?suburb=Belmont%20North" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Response Example
Response
{
"property": {
"address": "27 Arlington Street",
"bathrooms": 1,
"bedrooms": 2,
"garage_spaces": 0,
"gnaf_pid": "GANSW704074813",
"property_history": [
{ "date": "2012-03-15", "price": 220000, "type": "Sold" },
{ "date": "2022-04-08", "price": 615000, "type": "Sold" },
{ "date": "2023-04-26", "price": 759000, "type": "For Sale" }
],
"property_type": "house",
"status": "owner-occupied"
},
"neighbours": [
{
"address": "38 Arlington Street",
"bathrooms": 1,
"bedrooms": 3,
"garage_spaces": 1,
"gnaf_pid": "GANSW704076649",
"property_history": [
{ "date": "2001-02-13", "price": 80000, "type": "Sold" },
{ "date": "2016-01-25", "price": 50000, "type": "Sold" }
],
"property_type": "house",
"status": "owner-occupied"
},
{
"address": "42 Mirambeena Street",
"bathrooms": 1,
"bedrooms": 3,
"garage_spaces": 1,
"gnaf_pid": "GANSW704082375",
"property_history": [
{ "date": "2001-04-11", "price": 168000, "type": "Sold" },
{ "date": "2004-06-22", "price": 340000, "type": "Sold" },
{ "date": "2006-10-26", "price": 270, "type": "For Rent" },
{ "date": "2009-03-13", "price": 330, "type": "For Rent" },
{ "date": "2011-03-08", "price": 362500, "type": "Sold" }
],
"property_type": "house",
"status": "owner-occupied"
}
]
}