GET
School Catchments
https://www.microburbs.com.au/report_generator/api/suburb/catchments
Retrieves information about public school catchment areas that intersect with the specified suburb, including details about the schools in those catchments.
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 |
| geojson | boolean | Optional | Set to 'true' to include geometric shape data of the catchment boundaries (default: false) |
Response Schema
| Field | Type | Description |
|---|---|---|
| results | array | Array of school catchment areas intersecting with the suburb |
| results[].area_level | string | Level of geographical detail (e.g., 'suburb') |
| results[].area_name | string | Name of the suburb |
| results[].attendance_rate | number | Student attendance rate as a decimal (e.g., 0.89 means 89%) |
| results[].boys | number | Number of male students enrolled |
| results[].catchment_name | string | Short name or abbreviation of the school catchment |
| results[].gender | string | Gender composition of the school (e.g., 'Coed') |
| results[].girls | number | Number of female students enrolled |
| results[].id | number | Unique identifier for the school |
| results[].naplan | number | NAPLAN performance score as a decimal |
| results[].naplan_rank | string | Descriptive ranking of NAPLAN performance |
| results[].school_level_type | string | Level of education (e.g., 'Primary', 'Secondary') |
| results[].school_name | string | Full name of the school |
| results[].school_sector_type | string | School sector (e.g., 'Public', 'Catholic', 'Independent') |
| results[].socioeconomic | number | Socioeconomic score as a decimal |
| results[].socioeconomic_rank | string | Descriptive ranking of socioeconomic status |
| results[].geometry | object | GeoJSON geometry data of the catchment boundary (only included when geojson=true) |
Request Examples
cURL
Python
JavaScript
curl -X GET "https://www.microburbs.com.au/report_generator/api/suburb/catchments?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",
"attendance_rate": 0.78,
"boys": 406,
"catchment_name": "Belmont HS",
"gender": "Coed",
"girls": 389,
"id": 42097,
"naplan": 0.43112933634992456,
"naplan_rank": "NAPLAN bottom 43%",
"school_level_type": "Secondary",
"school_name": "Belmont High School",
"school_sector_type": "Public",
"socioeconomic": 0.2934553872053872,
"socioeconomic_rank": "Affluence bottom 29%"
},
{
"area_level": "suburb",
"area_name": "Belmont North",
"attendance_rate": 0.89,
"boys": 90,
"catchment_name": "Belmont NPS",
"gender": "Coed",
"girls": 82,
"id": 42002,
"naplan": 0.6282832390938133,
"naplan_rank": "NAPLAN top 37%",
"school_level_type": "Primary",
"school_name": "Belmont North Public School",
"school_sector_type": "Public",
"socioeconomic": 0.17342543077837194,
"socioeconomic_rank": "Affluence bottom 17%"
}
]
}