{ "openapi": "3.0.1", "info": { "title": "Teaching Vacancies GOV UK Scraper (DfE)", "description": "Extract UK teaching jobs from teaching-vacancies.service.gov.uk, the official DfE board for state schools and academies. Returns title, school, trust, local authority, phase, key stage, subject, salary scale, ECT suitability, closing date and apply URL. Pay-per-result.", "version": "1.5", "x-build-id": "k3AgLeCIKlR8jfKPj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/santamaria-automations~teaching-vacancies-uk-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-santamaria-automations-teaching-vacancies-uk-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/santamaria-automations~teaching-vacancies-uk-scraper/runs": { "post": { "operationId": "runs-sync-santamaria-automations-teaching-vacancies-uk-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/santamaria-automations~teaching-vacancies-uk-scraper/run-sync": { "post": { "operationId": "run-sync-santamaria-automations-teaching-vacancies-uk-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", "properties": { "searchQueries": { "title": "Search Keywords", "type": "array", "description": "One or more keywords, e.g. 'primary teacher', 'maths', 'SENCO', 'headteacher'. Each runs as a separate search. Results are deduplicated.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Location or postcode filter, e.g. 'London', 'Manchester', 'SW1A 1AA'. Applied to all search queries." }, "searchUrls": { "title": "Search URLs (optional)", "type": "array", "description": "Paste one or more teaching-vacancies.service.gov.uk search URLs. Go to the site, apply any filters (phase, subject, location, ECT status), and copy the browser URL. All filters are preserved. Mutually exclusive with searchQueries.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (optional)", "type": "array", "description": "Alias of searchUrls — direct SERP URLs to crawl instead of building from keywords. Mutually exclusive with searchQueries.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includeJobDetails": { "title": "Include full job details", "type": "boolean", "description": "Fetch each job's detail page for the full description, structured salary, employment type, closing date, and any additional PDP-only fields. Otherwise only SERP-visible fields are returned.", "default": false }, "includeCompanyDetails": { "title": "Include employer / company page details", "type": "boolean", "description": "Also fetch each unique employer's company profile page for the About-us text, phone, address, website, and a list of the employer's other currently-open roles. Deduplicated per employer within a run. Adds one HTTP hop per unique employer.", "default": false }, "phase": { "title": "Education Phase", "enum": [ "", "nursery", "primary", "middle", "secondary", "sixteen_plus", "through", "special" ], "type": "string", "description": "Filter by phase. Applied to keyword searches only.", "default": "" }, "ectSuitable": { "title": "ECT Suitable Only", "type": "boolean", "description": "Only include jobs marked as suitable for Early Career Teachers.", "default": false }, "maxResults": { "title": "Max Total Results", "minimum": 1, "type": "integer", "description": "Total cap across all queries and search URLs.", "default": 5 }, "maxResultsPerQuery": { "title": "Max Results per Query", "minimum": 1, "type": "integer", "description": "Maximum results per search URL or keyword.", "default": 5 }, "mode": { "title": "Scraping Mode", "enum": [ "fast", "full" ], "type": "string", "description": "Fast mode returns the SERP fields only. Full mode also fetches each vacancy page for full description, salary scale, key stage, subject, dates and apply URL.", "default": "full" }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum concurrent detail-page requests in full mode.", "default": 6 } } }, "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 } } } } } } } } } }