GET
Market Insights by Pocket
https://www.microburbs.com.au/report_generator/api/property/pocket
Shows the local pocket data for the property and compares it with surrounding SA1 areas, including growth rates and median prices. Optionally includes geometric shape data in GeoJSON format.
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 |
|---|---|---|
| address | string | Full street address of the property |
| gnaf_id | string | The GNAF (Geocoded National Address File) identifier for the property |
| local_pocket | object | Market data for the property's immediate SA1 area |
| local_pocket.area_level | string | Area classification level (e.g., 'sa1') |
| local_pocket.area_name | string | SA1 identifier code for the property's location |
| local_pocket.date | string | Date of the data point |
| local_pocket.growth | number | Price growth percentage (as decimal, e.g., 1.95 means 95% growth) |
| local_pocket.metric | string | Type of metric being reported (e.g., 'median_price_per_pocket') |
| local_pocket.property_type | string | Type of property (house, unit) |
| local_pocket.value | number | Median property price in the local pocket |
| results | array | Array containing surrounding pocket data for comparison |
| results[].area_level | string | Area classification level (e.g., 'sa1') |
| results[].area_name | string | SA1 identifier code |
| results[].date | string | Date of the data point |
| results[].growth | number | Price growth percentage (as decimal, e.g., 1.5 means 50% growth) |
| results[].metric | string | Type of metric being reported (e.g., 'median_price_per_pocket') |
| results[].property_type | string | Type of property (house, unit) |
| results[].value | number | Median property price in the pocket |
| results[].geometry | object | GeoJSON geometry data for the SA1 area (only included when geojson=true) |
| local_pocket.geometry | object | GeoJSON geometry data for the property's local SA1 area (only included when geojson=true) |
Request Examples
cURL
Python
JavaScript
curl -X GET "https://www.microburbs.com.au/report_generator/api/property/pocket?suburb=Belmont%20North" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Response Example
Response
{
"address": "27 Arlington Street",
"gnaf_id": "GANSW704074813",
"local_pocket": {
"area_level": "sa1",
"area_name": "11101120618",
"date": "2025-05-31",
"growth": 1.95,
"metric": "median_price_per_pocket",
"property_type": "house",
"value": 1180000
},
"results": [
{
"area_level": "sa1",
"area_name": "11101120609",
"date": "2025-05-31",
"growth": 1.5555555555555556,
"metric": "median_price_per_pocket",
"property_type": "house",
"value": 805000
},
{
"area_level": "sa1",
"area_name": "11101120636",
"date": "2025-05-31",
"growth": 1.1748768472906403,
"metric": "median_price_per_pocket",
"property_type": "house",
"value": 883000
},
{
"area_level": "sa1",
"area_name": "11101120634",
"date": "2025-05-31",
"growth": 1.2670807453416149,
"metric": "median_price_per_pocket",
"property_type": "house",
"value": 730000
},
{
"area_level": "sa1",
"area_name": "11101120635",
"date": "2025-05-31",
"growth": 2.4285714285714284,
"metric": "median_price_per_pocket",
"property_type": "house",
"value": 1950000
}
]
}