Education Petitions API Documentation

Search API

The Search API allows you to search for schools using various criteria including URN, LA code/name, establishment details, location, and contact information.

Endpoint

GET https://edu-report.hyperwave.uk/search?q={SEARCH}

Search Parameters

  • URN
  • LA (code)
  • LA (name)
  • EstablishmentNumber
  • EstablishmentName
  • TypeOfEstablishment (name)
  • EstablishmentTypeGroup (name)
  • EstablishmentStatus (name)
  • ReasonEstablishmentOpened (name)
  • OpenDate
  • PhaseOfEducation (name)
  • StatutoryLowAge
  • StatutoryHighAge
  • Gender (name)
  • Street
  • Locality
  • Address3
  • Town
  • County (name)
  • Postcode
  • SchoolWebsite
  • MainEmail
  • TelephoneNum
  • HeadTitle (name)
  • HeadFirstName
  • HeadLastName
  • HeadPreferredJobTitle
  • Region

Example Usage

For searches with spaces, use + instead of spaces. For example:

https://edu-report.hyperwave.uk/search?q=hello+how+are+you

Response Format

{
  "address": "St James's Passage Duke's Place London",
  "email": "[email protected]",
  "head_job": "Headteacher",
  "head_teacher": "Miss Alexandra Allan",
  "id": "100000",
  "name": "The Aldgate School",
  "phone": "02072831147",
  "postcode": "EC3A 5DE",
  "turnstileToken": ""
}

Response Fields

  • address - Full address of the school
  • email - Main email address of the school
  • head_job - Job title of the headteacher
  • head_teacher - Full name of the headteacher
  • id - Unique identifier for the school
  • name - Name of the school
  • phone - Phone number of the school
  • postcode - Postcode of the school
  • turnstileToken - Verification token (currently empty)

School Data API

The School Data API provides detailed information about a specific school using its unique ID.

Endpoint

GET https://edu-report.hyperwave.uk/schooldata/{ID}

Example Usage

If the school ID is 100000, the URL would be:

https://edu-report.hyperwave.uk/schooldata/100000

Response Format

{
  "Address3": "",
  "County (name)": "",
  "EstablishmentName": "The Aldgate School",
  "EstablishmentNumber": "3614",
  "EstablishmentStatus (name)": "Open",
  "EstablishmentTypeGroup (name)": "Local authority maintained schools",
  "Gender (name)": "Mixed",
  "HeadFirstName": "Alexandra",
  "HeadLastName": "Allan",
  "HeadPreferredJobTitle": "Headteacher",
  "HeadTitle (name)": "Miss",
  "LA (code)": "201",
  "LA (name)": "City of London",
  "Locality": "Duke's Place",
  "MainEmail": "[email protected]",
  "OpenDate": "",
  "PhaseOfEducation (name)": "Primary",
  "Postcode": "EC3A 5DE",
  "ReasonEstablishmentOpened (name)": "Not applicable",
  "Region": "London",
  "SchoolWebsite": "www.thealdgateschool.org",
  "StatutoryHighAge": "11",
  "StatutoryLowAge": "3",
  "Street": "St James's Passage",
  "TelephoneNum": "02072831147",
  "Town": "London",
  "TypeOfEstablishment (name)": "Voluntary aided school",
  "URN": "100000"
}

Response Fields

  • Address3 - Additional address line
  • County (name) - County name
  • EstablishmentName - Name of the school
  • EstablishmentNumber - Unique establishment number
  • EstablishmentStatus (name) - Status of the establishment
  • EstablishmentTypeGroup (name) - Type group of establishment
  • Gender (name) - Gender composition
  • HeadFirstName - First name of headteacher
  • HeadLastName - Last name of headteacher
  • HeadPreferredJobTitle - Preferred job title of head
  • HeadTitle (name) - Title of headteacher
  • LA (code) - Local Authority code
  • LA (name) - Local Authority name
  • Locality - Locality of the school
  • MainEmail - Main email address
  • OpenDate - Date the school opened
  • PhaseOfEducation (name) - Phase of education
  • Postcode - School postcode
  • ReasonEstablishmentOpened (name) - Reason for opening
  • Region - Region of the school
  • SchoolWebsite - School website URL
  • StatutoryHighAge - Highest age of statutory education
  • StatutoryLowAge - Lowest age of statutory education
  • Street - Street address
  • TelephoneNum - Telephone number
  • Town - Town name
  • TypeOfEstablishment (name) - Type of establishment
  • URN - Unique Reference Number