{
  "openapi": "3.0.1",
  "info": {
    "title": "Ofsted Childcare Provider Scraper",
    "description": "Scrape Ofsted's official register of English day nurseries, pre-schools and out-of-school childcare providers from GOV.UK open data. Search by region, local authority, provider type and Ofsted rating, look up by URN, or list every setting run by a nursery operator/group.",
    "version": "1.0",
    "x-build-id": "Zy8Jv2ahqoaDYGeXX"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/crawlerbros~ofsted-childcare-provider-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-crawlerbros-ofsted-childcare-provider-scraper",
        "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/crawlerbros~ofsted-childcare-provider-scraper/runs": {
      "post": {
        "operationId": "runs-sync-crawlerbros-ofsted-childcare-provider-scraper",
        "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/crawlerbros~ofsted-childcare-provider-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-crawlerbros-ofsted-childcare-provider-scraper",
        "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",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "byUrn",
              "byOperator"
            ],
            "type": "string",
            "description": "What to fetch.",
            "default": "search"
          },
          "region": {
            "title": "Region (mode=search)",
            "enum": [
              "",
              "East Midlands",
              "East of England",
              "London",
              "North East",
              "North West",
              "Not Recorded",
              "South East",
              "South West",
              "West Midlands",
              "Yorkshire and The Humber"
            ],
            "type": "string",
            "description": "Restrict to an English region. Leave blank to search all regions.",
            "default": ""
          },
          "localAuthority": {
            "title": "Local authority (mode=search)",
            "enum": [
              "",
              "Barking and Dagenham",
              "Barnet",
              "Barnsley",
              "Bath and North East Somerset",
              "Bedford",
              "Bexley",
              "Birmingham",
              "Blackburn with Darwen",
              "Blackpool",
              "Bolton",
              "Bournemouth, Christchurch & 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",
              "Not Recorded",
              "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"
            ],
            "type": "string",
            "description": "Restrict to a specific local authority area. Leave blank to search the whole region/country.",
            "default": ""
          },
          "providerSubtype": {
            "title": "Provider subtype (mode=search)",
            "enum": [
              "",
              "Full day care",
              "Sessional day care",
              "Out-of-school day care"
            ],
            "type": "string",
            "description": "Restrict to a specific type of setting.",
            "default": ""
          },
          "minimumRating": {
            "title": "Minimum Ofsted rating (mode=search)",
            "enum": [
              "any",
              "requiresImprovementOrBetter",
              "goodOrBetter",
              "outstandingOnly"
            ],
            "type": "string",
            "description": "Filter by most recent overall effectiveness grade.",
            "default": "any"
          },
          "registerCombination": {
            "title": "Register combination (mode=search)",
            "enum": [
              "",
              "ALL",
              "EYR only",
              "VCR only",
              "CCR only",
              "EYR-CCR",
              "EYR-VCR",
              "CCR-VCR"
            ],
            "type": "string",
            "description": "Restrict to providers holding this exact combination of Ofsted registers (Early Years Register / Compulsory Childcare Register / Voluntary Childcare Register).",
            "default": ""
          },
          "deprivationBand": {
            "title": "Deprivation band (mode=search)",
            "enum": [
              "",
              "Most deprived",
              "Deprived",
              "Average",
              "Less deprived",
              "Least deprived",
              "Unknown"
            ],
            "type": "string",
            "description": "Restrict to providers in areas of a specific Income Deprivation Affecting Children Index (IDACI) band, based on the provider's postcode.",
            "default": ""
          },
          "nameContains": {
            "title": "Provider name contains (mode=search)",
            "type": "string",
            "description": "Case-insensitive substring match against the provider name."
          },
          "minPlaces": {
            "title": "Min registered places",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "Drop providers registered for fewer childcare places than this."
          },
          "maxPlaces": {
            "title": "Max registered places",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "Drop providers registered for more childcare places than this."
          },
          "providerUrns": {
            "title": "Provider URNs (mode=byUrn)",
            "type": "array",
            "description": "Ofsted Unique Reference Numbers, e.g. `EY275703`.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "operatorName": {
            "title": "Operator/group name (mode=byOperator)",
            "type": "string",
            "description": "Case-insensitive substring match against the registered person/company name, e.g. `Busy Bees`."
          },
          "operatorUrn": {
            "title": "Operator Registered Person URN (mode=byOperator)",
            "type": "string",
            "description": "Exact match against the registered person's Ofsted URN (found on any provider record's `registeredPersonUrn` field). Use instead of, or together with, operatorName."
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Hard cap on emitted records.",
            "default": 100
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}