Documentation
Version V1.0.2
GET Risk Factors
https://www.microburbs.com.au/report_generator/api/suburb/risk
Retrieves information about various risk factors that affect a specified suburb, including environmental hazards (bushfire, flood) and social factors (public housing density).
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.
Click to see documentation

Parameters

Name Type Required Description
suburb text Required The name of the suburb
geojson boolean Optional Set to 'true' to include geometric shape data of risk areas (default: false)

Response Schema

Field Type Description
results array Array of risk factors affecting the suburb
results[].area_level string Geographical level (e.g., 'suburb')
results[].area_name string Name of the suburb
results[].name string Type of risk factor (e.g., 'Bushfire Prone Area', 'Flood Prone Area', 'Public Housing')
results[].value string Risk value or percentage (for Public Housing, represents proportion of properties; may be empty for environmental risks)
results[].geometry object GeoJSON geometry data of the risk area (only included when geojson=true)

Request Examples

cURL
Python
JavaScript
curl -X GET "https://www.microburbs.com.au/report_generator/api/suburb/risk?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", "name": "Bushfire Prone Area", "value": "" }, { "area_level": "suburb", "area_name": "Belmont North", "name": "Flood Prone Area", "value": "" }, { "area_level": "suburb", "area_name": "Belmont North", "name": "Heritage", "value": "" }, { "area_level": "suburb", "area_name": "Belmont North", "name": "Public Housing", "value": "36.9%" }, { "area_level": "suburb", "area_name": "Belmont North", "name": "Public Housing", "value": "2.2%" }, { "area_level": "suburb", "area_name": "Belmont North", "name": "Public Housing", "value": "6.2%" }, { "area_level": "suburb", "area_name": "Belmont North", "name": "Public Housing", "value": "28.7%" }, { "area_level": "suburb", "area_name": "Belmont North", "name": "Public Housing", "value": "15.7%" }, { "area_level": "suburb", "area_name": "Belmont North", "name": "Public Housing", "value": "2.5%" }, { "area_level": "suburb", "area_name": "Belmont North", "name": "Public Housing", "value": "6.3%" } ] }
Try it in Sandbox