GET
Market Insights
https://www.microburbs.com.au/report_generator/api/property/market
Retrieves historical and current market data for a specific property with time series comparisons to suburb, SA3, and City Region levels. Includes property transaction history when available.
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) |
| metric | text | Optional | Type of market data to retrieve. Default is 'price'. |
Response Schema
| Field | Type | Description |
|---|---|---|
| address | string | Property street address |
| gnaf_id | string | Geocoded National Address File identifier |
| metric | string | Type of market data returned (e.g., 'sell_price', 'rent_price', 'yield') |
| property_transactions | array | Array of actual property transactions (empty for rent/yield metrics) |
| property_transactions[].address | string | Transaction property address |
| property_transactions[].date | string | Transaction date in GMT format |
| property_transactions[].price | number | Transaction price in AUD |
| property_transactions[].transaction_type | string | Type of transaction (e.g., 'Sale') |
| property_type | string | Property type (e.g., 'house', 'unit') |
| series | array | Time series data with comparative regional values |
| series[].date | string | Date of the observation in GMT format |
| series[].metric | string | Metric type for this data point |
| series[].property_type | string | Property type for comparison |
| series[].suburb | object | Suburb-level comparative data |
| series[].suburb.area_level | string | Geographic level ('suburb') |
| series[].suburb.area_name | string | Suburb name |
| series[].suburb.value | number | Metric value for the suburb |
| series[].sa3 | object | Statistical Area Level 3 comparative data |
| series[].sa3.area_level | string | Geographic level ('sa3') |
| series[].sa3.area_name | string | SA3 region name |
| series[].sa3.value | number | Metric value for the SA3 region |
| series[].cr | object | City Region comparative data |
| series[].cr.area_level | string | Geographic level ('cr') |
| series[].cr.area_name | string | City Region name |
| series[].cr.value | number | Metric value for the City Region |
Request Examples
cURL
Python
JavaScript
curl -X GET "https://www.microburbs.com.au/report_generator/api/property/market?suburb=Belmont%20North" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Response Example
Response
{
"address": "27 Arlington Street",
"gnaf_id": "GANSW704074813",
"metric": "sell_price",
"property_transactions": [
{
"address": "27 ARLINGTON STREET",
"date": "Thu, 15 Mar 2012 00:00:00 GMT",
"price": 220000,
"transaction_type": "Sale"
},
{
"address": "27 ARLINGTON STREET",
"date": "Thu, 28 Apr 2022 00:00:00 GMT",
"price": 615000,
"transaction_type": "Sale"
}
],
"property_type": "house",
"series": [
{
"cr": {
"area_level": "cr",
"area_name": "Newcastle and Lake Macquarie",
"value": 255000
},
"date": "Fri, 31 Jan 2003 00:00:00 GMT",
"metric": "sell_price",
"property_type": "house",
"sa3": {
"area_level": "sa3",
"area_name": "Lake Macquarie - East",
"value": 269000
},
"suburb": {
"area_level": "suburb",
"area_name": "Belmont North",
"value": 255000
}
},
{
"cr": {
"area_level": "cr",
"area_name": "Newcastle and Lake Macquarie",
"value": 255000
},
"date": "Fri, 28 Feb 2003 00:00:00 GMT",
"metric": "sell_price",
"property_type": "house",
"sa3": {
"area_level": "sa3",
"area_name": "Lake Macquarie - East",
"value": 261000
},
"suburb": {
"area_level": "suburb",
"area_name": "Belmont North",
"value": 253000
}
}
]
}