GET
Summary
http://127.0.0.1:2025/api/suburb/summary
Retrieves AI-generated summaries and scores for various aspects of life in a suburb, including climate, community, safety, lifestyle, and more. Combines data-based scores with public reviews for rich, descriptive assessments.
Important: The suburb parameter must use the official naming convention.
You can retrieve the official name for a suburb from the List Suburbs API Endpoint.
You can retrieve the official name for a suburb from the List Suburbs API Endpoint.
Click to see documentation
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
suburb |
text | Required | The name of the suburb |
Response Schema
| Field | Type | Description |
|---|---|---|
results |
array | Array of aspect-specific suburb assessments |
results[].adjectives |
array | List of descriptive adjectives characterizing this aspect of the suburb |
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[].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[].summary |
array | Array of detailed paragraph summaries about this aspect |
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 "http://127.0.0.1:2025/api/suburb/summary?suburb=Belmont%20North" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Response Example
Response
{
"results": [
{
"adjectives": [
"comfortable",
"balanced",
"tolerable"
],
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Average climate and weather",
"id": "climate-score",
"name": "Climate Score",
"summary": [
"The weather in Belmont North is generally quite pleasant. The temperature rarely reaches extreme highs or lows, which contributes to a comfortable living environment throughout the year."
],
"value": "68/100"
},
{
"adjectives": [
"cohesive",
"welcoming",
"supportive"
],
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Very strong community",
"id": "community-score",
"name": "Community Score",
"summary": [
"Belmont North boasts a cohesive, supportive and active community. Residents here are known for being friendly, supportive and welcoming. Regular community events and local clubs further foster a strong sense of togetherness."
],
"value": "90/100"
},
{
"adjectives": [
"safe",
"peaceful",
"secure"
],
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Extremely low crime levels",
"id": "safety-score",
"name": "Safety Score",
"summary": [
"Belmont North is known for its safety and peacefulness. Crimes rates are extremely low, making this a neighborhood where residents feel comfortable walking around at any time of day or night."
],
"value": "86/100"
},
{
"adjectives": [
"vibrant",
"fulfilling",
"enriching"
],
"area_level": "suburb",
"area_name": "Belmont North",
"comment": "Above Average",
"id": "lifestyle-score",
"name": "Lifestyle Score",
"summary": [
"With stunning parks, quality amenities, and a strong community vibe, Belmont North offers a superior lifestyle. Whether it's weekend picnics or sport activities, there is always something to engage in."
],
"value": "78/100"
}
]
}