GET
Summary
http://127.0.0.1:2025/api/property/summary
Generates a comprehensive AI-powered summary analyzing the property's location, neighborhood characteristics, demographics, amenities, and lifestyle factors with key insights and emojis for easy readability.
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 |
|---|---|---|
summary |
string | AI-generated comprehensive property and neighborhood summary with emoji indicators, covering affluence levels, community characteristics, demographic insights, amenities analysis, lifestyle scores, and socio-economic factors |
Request Examples
cURL
Python
JavaScript
curl -X GET "http://127.0.0.1:2025/api/property/summary?suburb=Belmont%20North" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Response Example
Response
{
"summary": "The property on 27 Arlington Street, Belmont North is situated in an average affluent neighbourhood with a strong community and good lifestyle score. However, it's noted that it is located quite far from the Central Business District and the nearest major hub.\n\nš The suburb shows a relatively high family household proportion (76.6%), indicating it's predominantly a suburban community.\nš There is an impressive number of schools (41) within 2 km distance, which is great for families with school-going children.\nšµ The number of people on pensions in the postcode is quite high, suggesting a sizeable elderly population.\nš³ The property enjoys tranquility with a score of 83 and there are no nightclubs within the vicinity ensuring peace and serenity.\nš The suburb sees a high rate of car commuters (71.4%), a potential testament to its distance from the CBD.\nš There was a significant reduction in public housing in the area, which might indicate potential capital growth.\nšØāš©āš¦ The suburb expects a relatively high rate of population growth (12.2%) over the next decade, indicating potential development and vibrancy.\nš The population is mostly monolingual with 97% English speakers and possesses quite low diversity.\nš The suburb has higher than average working class proportion (34.2%).\nš The number of welfare dependents in the suburb is above average, indicating some socio-economic challenges in the area."
}