{ "openapi": "3.0.1", "info": { "title": "NHS Jobs Scraper", "description": "Scrape live UK healthcare jobs from every NHS trust via the official NHS Jobs public XML API. No API key needed. Returns job title, trust, location, pay band (min/max GBP), contract type, hours, closing date, and full description (text, HTML, Markdown). Pay-per-result.", "version": "1.3", "x-build-id": "JjGMRxOcn4pMr6CPC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/santamaria-automations~nhs-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-santamaria-automations-nhs-jobs-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~nhs-jobs-scraper/runs": { "post": { "operationId": "runs-sync-santamaria-automations-nhs-jobs-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~nhs-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-santamaria-automations-nhs-jobs-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": { "keywords": { "title": "Search Keywords", "type": "array", "description": "One or more NHS role keywords (e.g. 'nurse', 'doctor', 'radiographer', 'admin'). Each runs as a separate search. Results are deduplicated across queries.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "UK city, town, or postcode to filter by (e.g. 'London', 'Manchester', 'SW1A 1AA'). Optional." }, "distanceMiles": { "title": "Distance (miles)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Radius in miles around the location. Only meaningful when 'Location' is set." }, "payMin": { "title": "Minimum Annual Pay (GBP)", "minimum": 0, "type": "integer", "description": "Filter to jobs paying at least this many GBP per year. Optional." }, "payMax": { "title": "Maximum Annual Pay (GBP)", "minimum": 0, "type": "integer", "description": "Filter to jobs paying at most this many GBP per year. Optional." }, "sortBy": { "title": "Sort Order", "enum": [ "newest", "relevance" ], "type": "string", "description": "Order of results. 'newest' returns the most recently published vacancies first, and drops rows whose title or summary does not mention your keyword (the NHS API widens keyword matching when sorting by date), so the pages are walked until your result cap is reached. 'relevance' uses the platform's default relevance ranking.", "default": "newest" }, "postedWithinDays": { "title": "Posted Within Days", "minimum": 0, "type": "number", "description": "Only return jobs published within the last N days (decimals allowed, e.g. 0.5 for 12 hours). Leave empty for no limit. With 'newest' sort, paging stops at the first older job." }, "titleFilter": { "title": "Filter by Job Title", "type": "string", "description": "Comma-separated list of terms to match against job titles (case-insensitive OR-match). Only jobs whose title contains one of the terms are emitted. Non-matching rows are dropped before the detail-fetch event, so you don't pay for filtered-out jobs. Leave empty to disable.", "default": "" }, "maxResults": { "title": "Max Total Results", "minimum": 1, "type": "integer", "description": "Total cap across all keywords.", "default": 100 }, "maxResultsPerQuery": { "title": "Max Results per Keyword", "minimum": 1, "type": "integer", "description": "Maximum results per keyword.", "default": 250 }, "includeJobDetails": { "title": "Include full job descriptions", "type": "boolean", "description": "When enabled, each vacancy's detail page is fetched and the full description is added to the record. Adds one extra HTTP request per job.", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of concurrent detail-page requests.", "default": 5 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }