{ "openapi": "3.0.1", "info": { "title": "Ofsted Inspections", "description": "Ofsted inspection ratings and reports for every school, nursery, childminder and children's social care provider in England. Search by name, URN, postcode radius, local authority, region, provider type or rating and get the graded judgements, the inspection history and the report PDF links.", "version": "0.1", "x-build-id": "DKQYoq5wbOy5dsa4A" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spookyweb~uk-ofsted-inspections/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spookyweb-uk-ofsted-inspections", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/spookyweb~uk-ofsted-inspections/runs": { "post": { "operationId": "runs-sync-spookyweb-uk-ofsted-inspections", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/spookyweb~uk-ofsted-inspections/run-sync": { "post": { "operationId": "run-sync-spookyweb-uk-ofsted-inspections", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "query": { "title": "Name, URN or keyword", "type": "string", "description": "Free text matched against the provider name and the URN. A URN on its own returns that one provider, for example 116780. Leave it empty to search only by the filters below." }, "location": { "title": "Postcode, outward code or town", "type": "string", "description": "Search around a point, for example BS1 4DJ, BS1 or Bristol. This is turned into a latitude and longitude before it is sent, because Ofsted accepts a place name in its own location box and then ignores it." }, "radiusMiles": { "title": "Radius in miles", "minimum": 1, "maximum": 25, "type": "integer", "description": "How far around the location to search, in miles. Ofsted defaults its own form to 3 miles and offers up to 10, but the register accepts a wider radius, so anything up to 25 works. Ignored when no location is given.", "default": 3 }, "providerType": { "title": "Provider type", "enum": [ "", "all-education", "primary", "secondary", "further-education", "multi-academy-trust", "initial-teacher-training", "all-childcare", "childminder", "nanny", "day-nursery-and-pre-school", "nursery-school", "all-childrens-social-care", "fostering", "adoption", "residential-and-boarding", "childrens-home", "supported-accommodation", "local-authority-childrens-services", "childrens-centre", "childminder-agency" ], "type": "string", "description": "Restrict the search to one kind of provider. Primary and secondary are the phases Ofsted registers a school under, not the category it prints on the card, so a secondary search can return a special school or an independent school of secondary age, and a provider registered across both phases appears under both.", "default": "" }, "schoolCategory": { "title": "School category", "enum": [ "", "maintained", "academy", "independent", "special", "boarding", "mod", "online" ], "type": "string", "description": "Narrow a primary or secondary search to how the school is run, for example academies only or maintained schools only. It is ignored, with a warning in the log, for any other provider type because Ofsted numbers these ids per parent category.", "default": "" }, "rating": { "title": "Overall rating", "enum": [ "", "outstanding", "good", "outstanding-or-good", "requires-improvement", "inadequate", "below-good" ], "type": "string", "description": "Only return providers whose latest published overall grade is this. State funded schools inspected from September 2024 no longer receive an overall grade, so a rating filter will not reach those inspections.", "default": "" }, "localAuthority": { "title": "Local authorities", "type": "array", "description": "Restrict the search to one or more of the 153 English local authorities. This is the cleanest way to pull a whole council area in one run, for example every primary school in Leeds.", "items": { "type": "string", "enum": [ "Barking and Dagenham", "Barnet", "Barnsley", "Bath and North East Somerset", "Bedford", "Bexley", "Birmingham", "Blackburn with Darwen", "Blackpool", "Bolton", "Bournemouth, Christchurch and Poole", "Bracknell Forest", "Bradford", "Brent", "Brighton and Hove", "Bristol", "Bromley", "Buckinghamshire", "Bury", "Calderdale", "Cambridgeshire", "Camden", "Central Bedfordshire", "Cheshire East", "Cheshire West and Chester", "City of London", "Cornwall", "Coventry", "Croydon", "Cumberland", "Darlington", "Derby", "Derbyshire", "Devon", "Doncaster", "Dorset", "Dudley", "Durham", "Ealing", "East Riding of Yorkshire", "East Sussex", "Enfield", "Essex", "Gateshead", "Gloucestershire", "Greenwich", "Hackney", "Halton", "Hammersmith and Fulham", "Hampshire", "Haringey", "Harrow", "Hartlepool", "Havering", "Herefordshire", "Hertfordshire", "Hillingdon", "Hounslow", "Isle of Wight", "Isles of Scilly", "Islington", "Kensington and Chelsea", "Kent", "Kingston upon Hull", "Kingston upon Thames", "Kirklees", "Knowsley", "Lambeth", "Lancashire", "Leeds", "Leicester", "Leicestershire", "Lewisham", "Lincolnshire", "Liverpool", "Luton", "Manchester", "Medway", "Merton", "Middlesbrough", "Milton Keynes", "Newcastle upon Tyne", "Newham", "Norfolk", "North East Lincolnshire", "North Lincolnshire", "North Northamptonshire", "North Somerset", "North Tyneside", "North Yorkshire", "Northumberland", "Nottingham", "Nottinghamshire", "Oldham", "Oxfordshire", "Peterborough", "Plymouth", "Portsmouth", "Reading", "Redbridge", "Redcar and Cleveland", "Richmond upon Thames", "Rochdale", "Rotherham", "Rutland", "Salford", "Sandwell", "Sefton", "Sheffield", "Shropshire", "Slough", "Solihull", "Somerset", "South Gloucestershire", "South Tyneside", "Southampton", "Southend on Sea", "Southwark", "St Helens", "Staffordshire", "Stockport", "Stockton-on-Tees", "Stoke-on-Trent", "Suffolk", "Sunderland", "Surrey", "Sutton", "Swindon", "Tameside", "Telford and Wrekin", "Thurrock", "Torbay", "Tower Hamlets", "Trafford", "Wakefield", "Walsall", "Waltham Forest", "Wandsworth", "Warrington", "Warwickshire", "West Berkshire", "West Northamptonshire", "West Sussex", "Westminster", "Westmorland and Furness", "Wigan", "Wiltshire", "Windsor and Maidenhead", "Wirral", "Wokingham", "Wolverhampton", "Worcestershire", "York" ], "enumTitles": [ "Barking and Dagenham", "Barnet", "Barnsley", "Bath and North East Somerset", "Bedford", "Bexley", "Birmingham", "Blackburn with Darwen", "Blackpool", "Bolton", "Bournemouth, Christchurch and Poole", "Bracknell Forest", "Bradford", "Brent", "Brighton and Hove", "Bristol", "Bromley", "Buckinghamshire", "Bury", "Calderdale", "Cambridgeshire", "Camden", "Central Bedfordshire", "Cheshire East", "Cheshire West and Chester", "City of London", "Cornwall", "Coventry", "Croydon", "Cumberland", "Darlington", "Derby", "Derbyshire", "Devon", "Doncaster", "Dorset", "Dudley", "Durham", "Ealing", "East Riding of Yorkshire", "East Sussex", "Enfield", "Essex", "Gateshead", "Gloucestershire", "Greenwich", "Hackney", "Halton", "Hammersmith and Fulham", "Hampshire", "Haringey", "Harrow", "Hartlepool", "Havering", "Herefordshire", "Hertfordshire", "Hillingdon", "Hounslow", "Isle of Wight", "Isles of Scilly", "Islington", "Kensington and Chelsea", "Kent", "Kingston upon Hull", "Kingston upon Thames", "Kirklees", "Knowsley", "Lambeth", "Lancashire", "Leeds", "Leicester", "Leicestershire", "Lewisham", "Lincolnshire", "Liverpool", "Luton", "Manchester", "Medway", "Merton", "Middlesbrough", "Milton Keynes", "Newcastle upon Tyne", "Newham", "Norfolk", "North East Lincolnshire", "North Lincolnshire", "North Northamptonshire", "North Somerset", "North Tyneside", "North Yorkshire", "Northumberland", "Nottingham", "Nottinghamshire", "Oldham", "Oxfordshire", "Peterborough", "Plymouth", "Portsmouth", "Reading", "Redbridge", "Redcar and Cleveland", "Richmond upon Thames", "Rochdale", "Rotherham", "Rutland", "Salford", "Sandwell", "Sefton", "Sheffield", "Shropshire", "Slough", "Solihull", "Somerset", "South Gloucestershire", "South Tyneside", "Southampton", "Southend on Sea", "Southwark", "St Helens", "Staffordshire", "Stockport", "Stockton-on-Tees", "Stoke-on-Trent", "Suffolk", "Sunderland", "Surrey", "Sutton", "Swindon", "Tameside", "Telford and Wrekin", "Thurrock", "Torbay", "Tower Hamlets", "Trafford", "Wakefield", "Walsall", "Waltham Forest", "Wandsworth", "Warrington", "Warwickshire", "West Berkshire", "West Northamptonshire", "West Sussex", "Westminster", "Westmorland and Furness", "Wigan", "Wiltshire", "Windsor and Maidenhead", "Wirral", "Wokingham", "Wolverhampton", "Worcestershire", "York" ] }, "default": [] }, "region": { "title": "Regions", "type": "array", "description": "Restrict the search to one or more of the nine English regions. Useful when a council list would be long, for example every inadequate independent school in London.", "items": { "type": "string", "enum": [ "North East", "North West", "Yorkshire and The Humber", "East Midlands", "West Midlands", "East of England", "London", "South East", "South West" ], "enumTitles": [ "North East", "North West", "Yorkshire and The Humber", "East Midlands", "West Midlands", "East of England", "London", "South East", "South West" ] }, "default": [] }, "status": { "title": "Provider status", "enum": [ "open", "closed", "proposed-to-open", "any" ], "type": "string", "description": "Open providers are the default. Closed keeps providers Ofsted has recorded as closed, which is how a school that changed name or converted to an academy is traced back.", "default": "open" }, "reportPublishedFrom": { "title": "Report published from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only return providers whose latest report was published on or after this date, written as YYYY-MM-DD. Pair it with the sort order to watch a council area for newly published inspections." }, "reportPublishedTo": { "title": "Report published to", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only return providers whose latest report was published on or before this date, written as YYYY-MM-DD. Use it with the field above to take one month of publications at a time." }, "sortBy": { "title": "Sort order", "enum": [ "name-a-z", "latest-report-first", "relevance" ], "type": "string", "description": "How Ofsted should order the register before it is paged. Latest report first is the order to use when you only want what has changed since the last run.", "default": "name-a-z" }, "includeDetails": { "title": "Read each provider page", "type": "boolean", "description": "Open every matching provider page for the graded judgements, the full inspection history, the report PDF links, pupil numbers, age range and contact details. Turn it off for a fast name, address and latest rating listing.", "default": true }, "excludeIndividualProviders": { "title": "Exclude childminders and other sole traders", "type": "boolean", "description": "Drop childminders, home childcarers and nannies from the results. Ofsted publishes these on a statutory register and most of them are sole traders whose registered name is a person’s name, so turn this on when you only want institutions.", "default": false }, "maxResults": { "title": "Maximum providers", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on how many provider records the run saves. Each saved provider is one billable record, so this is the cost cap for the run as well as the size cap.", "default": 50 }, "detailConcurrency": { "title": "Provider pages at once", "minimum": 1, "maximum": 4, "type": "integer", "description": "How many provider pages to read in parallel. Kept low on purpose so the register is not hammered. Raise it only if a large run is genuinely too slow.", "default": 2 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }