Property - Schools

All schools — bundle

Schools for this address: the ones nearby with their distances, and how each ranks on NAPLAN alongside sector, level and attendance.

The priciest bundle in the Property family, because it joins the school register, the ranking table and distance calculations. Call /schools/nearby alone if rankings do not matter.

Price: 105¢ per call.

get/v1/properties/{gnaf_id}/schools/all

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/properties/{gnaf_id}/schools/all
  • Auth: HTTP bearer

Path parameters

gnaf_idstring required
Example:GANSW704074813

Response

Successful Response

availableboolean nullable

false on no-data responses. Omitted on success — branch on data !== null if you want a single discriminator.

reasonstring nullable

Machine-readable slug naming the no-data condition (e.g. no_avm_for_GANSW704074813). Stable per endpoint. Omitted on success.

messagestring nullable

Human-readable explanation. Omitted on success.

Example response

{
  "data": {
    "nearby": [
      {
        "distance_m": 612,
        "name": "Belmont North Public School",
        "school_level_type": "Primary",
        "sector": "public"
      }
    ],
    "ranking": [
      {
        "attendance_rate": 0.89,
        "distance_m": 612,
        "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
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.