Schools

England
Wales
gethttps://crystalroof.co.uk/customer-api/education/closest-schools/v1/{location}

Description

This method returns the closest schools based on the specified criteria.

The dataset comprises multiple source datasets published by the Department for Education, and it is updated as soon as relevant datasets become available.

Parameters

NameDescription
location
path
string
Postcode, coordinates in the lat,long format or UPRN in the uprn12345678 format.
educationPhase
query
array
Education phase: primary, secondary and 16 plus.
ofstedRating
query
array
Ofsted rating is a system used in the United Kingdom to assess and categorise the quality of education and services provided by schools, colleges, and other educational institutions, ranging from "Outstanding" to "Inadequate".
funding
query
array
State-funded schools do not charge tuition fees. Independent schools charge tuition fees.
gender
query
array
Boys, girls or co-education (mixed)
limit
query
enum

Number of elements to be returned by the method.

The returned number of elements may be less than the requested amount if fewer elements are found based on your criteria (in very rare cases). The maximum value is 20. To retrieve only the metadata, use the value 0.

api_key
query
enum

Your API key.

DEMO key allows you to test the method in the W6 0 postcode sector, or in the [[51.492, -0.25], [51.502, -0.225]] rectangle.

Request URL:
https://crystalroof.co.uk/customer-api/education/closest-schools/v1/{location}?api_key=DEMO
Possible responses with examples
Code
Description
200
Success
401
Unauthorized
402
Payment Required
403
Forbidden
429
Too Many Requests
500
Internal Server Error