Property - Schools

Nearby schools

GET/v1/properties/{gnaf_id}/schools/nearby5¢ per call

Schools within ~5km of the property, with rank + student counts.

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

gnaf_idstringrequired

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[SchoolNearby]fields returned to you

Array of:

idintegermay be null

School identifier (MySchool ID).

namestringmay be null

School name.

sectorstringmay be null

public / private.

school_level_typestringmay be null

Primary / Secondary / Combined.

distance_mintegermay be null

Distance from the property in metres.

GET/v1/properties/{gnaf_id}/schools/nearby

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/schools/nearby' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": [
    {
      "distance_m": 612,
      "id": 42002,
      "name": "Belmont North Public School",
      "school_level_type": "Primary",
      "sector": "public"
    }
  ]
}

Successful Response200

application/json