Property - Schools

Local school ranking

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

Schools within ~5km of the property, ranked by NAPLAN / socioeconomic score.

Price: 100¢ 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[SchoolRanking]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.

naplan_ranknumbermay be null

NAPLAN rank percentile (0–1, higher = better).

naplan_labelstringmay be null

Human-readable NAPLAN band — 'Top 5%', 'Top 40%', etc.

socioeconomic_ranknumbermay be null

Socio-economic rank percentile (0–1, higher = more advantaged).

socioeconomic_labelstringmay be null

Human-readable affluence band.

attendance_ratenumbermay be null

Mean attendance rate (0–1).

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

cURL

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

Example Responses

Show schema

{
  "data": [
    {
      "attendance_rate": 0.89,
      "distance_m": 612,
      "id": 42002,
      "name": "Belmont North Public School",
      "naplan_label": "Top 40%",
      "naplan_rank": 0.63,
      "school_level_type": "Primary",
      "sector": "public",
      "socioeconomic_label": "Bottom 20%",
      "socioeconomic_rank": 0.17
    }
  ]
}

Successful Response200

application/json