GET
Suburb Insights
https://www.microburbs.com.au/report_generator/api/property/suburb_insights
Retrieves AI-generated scores for various aspects of life in a specified property's suburb, including climate, community, safety, lifestyle, and more. Combines data-based scores with public reviews for rich, descriptive assessments.
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) |
Response Schema
| Field | Type | Description |
|---|---|---|
| results | array | Array of aspect-specific suburb assessments |
| results[].area_level | string | Geographical level (e.g., 'suburb') |
| results[].area_name | string | Name of the suburb |
| results[].comment | string | Brief summary assessment of this aspect |
| results[].definition_url | string | Insight definition URL |
| results[].id | string | Unique identifier for the aspect (e.g., 'climate-score', 'safety-score') |
| results[].name | string | Name of the aspect being assessed (e.g., 'Climate Score', 'Safety Score') |
| results[].type | string | Insight type ('distance' or 'score') |
| results[].value | string | Numerical score or rating (format varies by aspect, e.g., '86/100', '5/10') |
Request Examples
cURL
Python
JavaScript
curl -X GET "https://www.microburbs.com.au/report_generator/api/property/suburb_insights?suburb=Belmont%20North" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Response Example
Response
{
"results": [
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Average",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#affluence-score",
"id": "affluence-score",
"name": "Affluence Score",
"type": "score",
"value": "70/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Low",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#business-activity-score",
"id": "business-activity-score",
"name": "Business Activity Score",
"type": "score",
"value": "47/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Average climate and weather",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#climate-score",
"id": "climate-score",
"name": "Climate Score",
"type": "score",
"value": "68/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Very strong community",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#community-score",
"id": "community-score",
"name": "Community Score",
"type": "score",
"value": "90/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Below average",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#conservatism-score",
"id": "conservatism-score",
"name": "Conservatism Score",
"type": "score",
"value": "33/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Above Average quality of location and access to amenities",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#convenience-score",
"id": "convenience-score",
"name": "Convenience Score",
"type": "score",
"value": "76/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Average",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#education-score",
"id": "education-score",
"name": "Education Score",
"type": "score",
"value": "5/10"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Above Average",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#family-score",
"id": "family-score",
"name": "Family Score",
"type": "score",
"value": "80/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Some hills",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#hilliness-score",
"id": "hilliness-score",
"name": "Hilliness Score",
"type": "score",
"value": "23/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Average",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#hip-score",
"id": "hip-score",
"name": "Hip Score",
"type": "score",
"value": "59/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Very high diversity, many industries of businesses",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#industry-diversity-score",
"id": "industry-diversity-score",
"name": "Industry Diversity Score",
"type": "score",
"value": "94/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Above Average",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#lifestyle-score",
"id": "lifestyle-score",
"name": "Lifestyle Score",
"type": "score",
"value": "78/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Extremely low crime levels",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#safety-score",
"id": "safety-score",
"name": "Safety Score",
"type": "score",
"value": "86/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "High",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#tranquility-score",
"id": "tranquility-score",
"name": "Tranquility Score",
"type": "score",
"value": "83/100"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "A significant distance from hub",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#distance-to-nearest-hub",
"id": "distance-to-nearest-hub",
"name": "Distance to nearest hub",
"type": "distance",
"value": "14 km"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Far away from CBD",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#distance-to-cbd",
"id": "distance-to-cbd",
"name": "Distance to CBD",
"type": "distance",
"value": "137 km"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Somewhat near CBD",
"definition_url": "https://www2.microburbs.com.au/definitions?utm_source=suburb_reports#public-transport-distance-to-cbd",
"id": "public-transport-distance-to-cbd",
"name": "Public Transport Distance to CBD",
"type": "distance",
"value": "139 km"
}
]
}