Suburb - Schools

Nearby schools

GET/v1/suburbs/{suburb_name}/schools/nearby5¢ per call

Schools serving / near the suburb, with rank + attendance data.

Price: 5¢ per call.

Authorization

Bearer tokentest

Sandbox key test works for the allowlisted GNAF + SAL — no signup.

Request

The only values you send. Fields under Responses below are what comes back — you never pass those.

Path parameters

suburb_namestringrequired

Query parameters

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Responses

Successful Response

application/json

list[SchoolNearbyRow]fields returned to you

Array of:

area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb'.

idnumbermay be null

School identifier.

namestringmay be null

School name.

school_level_typestringmay be null

Primary / Secondary / Combined.

school_sector_typestringmay be null

Public / Private / Non-Government.

naplan_ranknumbermay be null

NAPLAN rank percentile (0–1).

socioeconomic_ranknumbermay be null

Socio-economic rank percentile (0–1).

attendance_ratenumbermay be null

Attendance rate (0–1).

genderstringmay be null

coed / girls / boys.

boysnumbermay be null

Number of male students.

girlsnumbermay be null

Number of female students.

GET/v1/suburbs/{suburb_name}/schools/nearby

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/schools/nearby' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": [
    {
      "area_name": "Belmont North",
      "area_level": "suburb",
      "id": 42002,
      "name": "Belmont North Public School",
      "school_level_type": "Primary",
      "school_sector_type": "Public",
      "naplan_rank": 0.6282832390938133,
      "socioeconomic_rank": 0.17342543077837194,
      "attendance_rate": 0.89,
      "gender": "coed",
      "boys": 90,
      "girls": 82
    },
    {
      "area_name": "Belmont North",
      "area_level": "suburb",
      "id": 44016,
      "name": "Belmont Christian College",
      "school_level_type": "Combined",
      "school_sector_type": "Private",
      "naplan_rank": 0.7306959133962242,
      "socioeconomic_rank": 0.7843137254901961,
      "attendance_rate": 0.88,
      "gender": "coed",
      "boys": 385,
      "girls": 350
    }
  ]
}

Successful Response200

application/json