{ "openapi": "3.0.1", "info": { "title": "NHS Jobs Scraper", "description": "Job adverts from NHS Jobs (jobs.nhs.uk), the UK's public health job board: title, employer, postcode, salary with period, posted and closing dates, contract, working pattern - optionally the full advert with duties, person spec and contact. Filter by keyword, place, band, contract, staff group.", "version": "0.1", "x-build-id": "ITEdqmi70yjhk6hQo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapyx~nhs-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapyx-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/scrapyx~nhs-jobs-scraper/runs": { "post": { "operationId": "runs-sync-scrapyx-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/scrapyx~nhs-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-scrapyx-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Job title or keyword - 'nurse', 'pharmacist', 'data analyst'. Each term is its own target (combined with each location). Empty = every live advert (~12,800).", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "A town, city or postcode - 'Manchester', 'Leeds', 'SW1A 1AA'. Combined with each search term. A place the site cannot resolve ends that target with location_not_recognised. 'London' resolves to a region and ignores distanceMiles.", "items": { "type": "string" } }, "distanceMiles": { "title": "Distance (miles)", "minimum": 5, "maximum": 100, "type": "integer", "description": "Radius around each location: 5, 10, 20, 30, 50 or 100 (the values the site offers; anything else is refused). Needs at least one location." }, "contractTypes": { "title": "Contract types", "type": "array", "description": "Any of: Permanent, Fixed-Term, Apprenticeship, Voluntary, Locum, Training, Secondment, Honorary, Bank, NHS Reservist. Empty = any.", "items": { "type": "string" } }, "workingPatterns": { "title": "Working patterns", "type": "array", "description": "Any of: full-time, part-time, job-share, flexible-working, remote-working, compressed-hours, term-time-hours, annualised-hours. Empty = any.", "items": { "type": "string" } }, "payBands": { "title": "Pay bands", "type": "array", "description": "Agenda for Change bands and medical grades: BAND_2 ... BAND_9, BAND_8A-8D, SPECIALTY_DOCTOR, CONSULTANT, SALARIED_GP, DOCTOR_IN_TRAINING, OTHER. Empty = any.", "items": { "type": "string" } }, "staffGroups": { "title": "Staff groups", "type": "array", "description": "Any of: NURSING_AND_MIDWIFERY, MEDICAL_AND_DENTAL, ALLIED_HEALTH_PROF, ADMINISTRATIVE_AND_CLERICAL, CLINICAL_SERVICES, PROF_SCIENTIFIC_AND_TECHNICAL, HEALTHCARE_SCIENTISTS, ESTATES_AND_ANCILLARY, STUDENTS. Empty = any.", "items": { "type": "string" } }, "salaryFrom": { "title": "Min salary (GBP)", "minimum": 0, "type": "integer", "description": "Lowest annual salary. The site applies its own conversion for hourly and daily rates." }, "salaryTo": { "title": "Max salary (GBP)", "minimum": 0, "type": "integer", "description": "Highest annual salary." }, "employer": { "title": "Employer", "type": "string", "description": "Employer name, partial match - 'Barts Health', 'Guy's and St Thomas'." }, "sortBy": { "title": "Sort", "enum": [ "bestMatch", "newest", "closingDate", "salaryAsc", "salaryDesc" ], "type": "string", "description": "Listing order. Only these values are accepted; the site answers anything else with an HTTP 500.", "default": "bestMatch" }, "includeDetails": { "title": "Fetch each advert page", "type": "boolean", "description": "Off by default. On: one extra request per job for the summary, main duties, full description, person specification (essential/desirable by category), pay scheme, employer address and website, contact name/phone/email, DBS requirement.", "default": false }, "maxItems": { "title": "Max jobs", "minimum": 1, "maximum": 15000, "type": "integer", "description": "Overall cap on JOB rows across every target. 10 jobs per page; every page of every search is reachable.", "default": 100 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 6, "type": "integer", "description": "Parallel requests across targets and advert pages.", "default": 2 }, "minRequestInterval": { "title": "Min seconds between requests", "minimum": 0, "maximum": 30, "type": "integer", "description": "Politeness delay between request starts. This is a public service; 0.5 s is the default because it should be, not because the site pushed back.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. No anti-bot layer was observed. Enable Apify's free datacenter proxy only if a cloud run reports fetch_failed.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }