# NHS UK $0.8💰 URL | Keyword | Deep Search Scraper (`abotapi/jobs-nhs-uk-scraper`) Actor
From $0.8/1k. Scrape nhs.uk Jobs listings into a flat dataset. Extract 50+ fields, including pay band, salary, full description, essential and desirable criteria, PDFs, sponsorship, DBS, employer details, contacts, and apply URL. Search by filters or use any URL.
- **URL**: https://apify.com/abotapi/jobs-nhs-uk-scraper.md
- **Developed by:** [AbotAPI](https://apify.com/abotapi) (community)
- **Categories:** Jobs, Automation, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks
- **User rating**: No ratings yet
## Pricing
from $0.08 / 1,000 results
This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.
Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event
## What's an Apify Actor?
Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".
## How to integrate an Actor?
If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.
In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):
```bash
npm install apify-client
```
In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):
```bash
pip install apify-client
```
In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):
````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash
In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).
If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).
For usage examples, see the [API](#api) section below.
For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).
# README
## NHS Jobs UK Scraper
Scrape every public job advert on jobs.nhs.uk into a clean, flat dataset. Handles 50+ fields per listing including pay band, salary range parsed into numbers, full job description (HTML and plain text), person specification with **essential AND desirable criteria split out** (the official NHS Jobs structure most other scrapers flatten away), supporting PDF download IDs, sponsorship + UK registration + DBS flags, employer address, contact details, and the direct apply URL. Search by keyword, location, distance, pay band, staff group, contract type, working pattern, salary band, OR paste any jobs.nhs.uk URL refined in your browser.
### Why This Scraper?
- **50+ fields per record**, including fields most NHS Jobs scrapers drop: desirable person-spec criteria, supporting PDF document IDs, sponsorship eligibility, UK registration requirement, DBS check requirement, salary parsed into `salaryMin` / `salaryMax` / `salaryPeriod`, full address split into postcode / town / county / lines.
- **Two modes**: search builder (keyword + location + 7 facet filters) OR paste any jobs.nhs.uk URL.
- **Concurrent enrichment**: 6 detail-page workers run in parallel and push records as soon as each one is parsed. A 50-card page completes in around 10 seconds, and a mid-run abort still flushes everything that finished.
- **Forward pagination**: walks `?page=N` from any starting URL. URL mode honors the page in the pasted URL.
- **Robust error reporting**: when a run returns zero results, an `error` record explains the proxy upgrade path so users see it in the dataset preview, not just the run log.
- **Cost discipline**: efficient fetch path keeps proxy bandwidth around £0.0001 per page, so a 1000-listing run typically lands well under £2 in compute + proxy.
### Data You Get
> Sample shape, values are illustrative placeholders, not from a live listing.
| Field | Example |
|---|---|
| `id` | `C0000-00-0000` |
| `url` | `https://www.jobs.nhs.uk/candidate/jobadvert/C0000-00-0000` |
| `referenceNumber` | `000-X000-XXX` |
| `title` | `Sample Job Title` |
| `employer` | `Sample NHS Foundation Trust` |
| `employerWebsite` | `https://example.org/working-with-us` |
| `employerLogoDataUri` | `data:image/png;base64,iVBOR...` |
| `location` | `London SW1A 1AA` |
| `postcode` | `SW1A 1AA` |
| `addressLine1` | `Sample Hospital` |
| `addressTown` | `London` |
| `addressLines` | `["Sample Hospital", "London", "SW1A 1AA"]` |
| `salary` | `£00,000 to £00,000 a year` |
| `salaryMin` | `00000` |
| `salaryMax` | `00000` |
| `salaryPeriod` | `per annum` |
| `salaryQualifier` | `inclusive of HCAS` |
| `payScheme` | `Agenda for change` |
| `grade` | `Band 0` |
| `contractType` | `Permanent` |
| `contractDuration` | `12 months` |
| `workingPattern` | `Full-time` |
| `datePosted` | `01 January 2026` |
| `datePostedIso` | `2026-01-01` |
| `closingDate` | `15 January 2026` |
| `closingDateIso` | `2026-01-15` |
| `applyUrl` | `https://www.jobs.nhs.uk/candidate/jobadvert/C0000-00-0000/ats-direct-apply` |
| `contactName` | `Jane Doe` |
| `contactJobTitle` | `Recruitment Lead` |
| `contactEmail` | `recruitment@example.org` |
| `contactPhone` | `+44 0000 000000` |
| `jobOverviewText` | `Sample short job overview text appears here.` |
| `mainDutiesText` | `Sample main duties text appears here.` |
| `aboutOrganisationText` | `Sample about-us text appears here.` |
| `jobDescriptionText` | `Sample full job description text appears here.` |
| `personSpecification[0]` | `{"category": "Qualifications", "essentials": ["Sample essential criterion"], "desirables": ["Sample desirable criterion"]}` |
| `supportingDocuments[0]` | `{"name": "Job Description.pdf", "sizeText": "PDF, 000 KB", "documentId": "0000000"}` |
| `sponsorshipAvailable` | `true` |
| `ukRegistrationRequired` | `true` |
| `dbsCheckRequired` | `true` |
| `privacyPolicyUrl` | `https://example.org/privacy` |
| `basicInfo` | `{"id": "...", "title": "...", ...}` (drop-in compat with rival schemas) |
| `scrapedAt` | `2026-01-01T00:00:00.000Z` |
### How to Use
**Search by keyword + location:**
```json
{
"mode": "search",
"keywords": ["nurse"],
"location": "Manchester",
"distance": "10",
"maxPages": 2,
"fetchDetails": true
}
````
**Search by pay band + contract type:**
```json
{
"mode": "search",
"keywords": ["doctor"],
"location": "London",
"distance": "20",
"payBands": ["CONSULTANT", "SPECIALTY_DOCTOR"],
"contractTypes": ["Permanent", "Fixed-Term"],
"workingPatterns": ["full-time"],
"maxPages": 3,
"maxListings": 100
}
```
**Browse a whole staff group across the UK:**
```json
{
"mode": "search",
"keywords": [],
"location": "",
"distance": "",
"staffGroups": ["NURSING_AND_MIDWIFERY_REGD"],
"sortBy": "publicationDateDesc",
"maxPages": 5
}
```
**Paste any jobs.nhs.uk URL:**
```json
{
"mode": "url",
"urls": [
"https://www.jobs.nhs.uk/candidate/search/results?keyword=physiotherapist&location=Birmingham&distance=20",
"https://www.jobs.nhs.uk/candidate/jobadvert/C0000-00-0000"
],
"maxPages": 2,
"fetchDetails": true
}
```
### Input Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| `mode` | enum | `search` | `search` or `url`. The other mode's fields are ignored. |
| `keywords` | array of strings | `["doctor"]` | Free-text job-title or skill keywords. One scrape per keyword. Empty = browse without a keyword filter. |
| `location` | string | `London` | Town, city, county, or postcode. Empty = nationwide. |
| `distance` | enum | `10` | Search radius in miles (5/10/20/30/50/100) or empty for all UK. |
| `payBands` | array of enum | `[]` | Multi-select. BAND\_2..BAND\_9 (Agenda for Change), CONSULTANT, SPECIALTY\_DOCTOR, etc. |
| `staffGroups` | array of enum | `[]` | Multi-select. MEDICAL\_AND\_DENTAL, NURSING\_AND\_MIDWIFERY\_REGD, ALLIED\_HEALTH\_PROF, etc. |
| `contractTypes` | array of enum | `[]` | Multi-select. Permanent / Fixed-Term / Locum / Apprenticeship / Bank / Voluntary / etc. |
| `workingPatterns` | array of enum | `[]` | Multi-select. full-time / part-time / job-share / flexible-working / remote-working / etc. |
| `payRanges` | array of enum | `[]` | Salary bands in thousands GBP (0-10, 10-20, ..., 100). |
| `employerName` | string | `null` | Filter by NHS Trust name (partial match). |
| `covidJobsOnly` | boolean | `false` | Limit to roles tagged COVID-related. |
| `sortBy` | enum | `""` (Best Match) | publicationDateDesc / closingDate / salaryDesc / salaryAsc. |
| `urls` | array of strings | one example URL | URL mode only. Paste any jobs.nhs.uk search-results or jobadvert URL. |
| `maxPages` | integer | `2` | Hard cap on SERP pages walked per keyword (1..200). 50 listings per page. |
| `maxListings` | integer | `0` | Total listings cap across all searches. 0 = no cap. |
| `fetchDetails` | boolean | `true` | Fetch each advert's detail page for the full 50+ fields. OFF returns SERP-only fields. |
| `proxy` | object | UK residential | Proxy config. Default `groups: ["RESIDENTIAL"], country: "GB"`. |
### Output Example
> Sample shape, values are illustrative placeholders, not from a live listing.
```json
{
"id": "C0000-00-0000",
"url": "https://www.jobs.nhs.uk/candidate/jobadvert/C0000-00-0000",
"referenceNumber": "000-X000-XXX",
"title": "Sample Job Title",
"employer": "Sample NHS Foundation Trust",
"employerWebsite": "https://example.org/working-with-us",
"employerLogoDataUri": "data:image/png;base64,...",
"location": "London SW1A 1AA",
"postcode": "SW1A 1AA",
"addressLine1": "Sample Hospital",
"addressLine2": null,
"addressTown": "London",
"addressCounty": null,
"addressLines": ["Sample Hospital", "London", "SW1A 1AA"],
"salary": "£00,000 to £00,000 a year",
"salaryQualifier": "inclusive of HCAS",
"salaryMin": 00000,
"salaryMax": 00000,
"salaryPeriod": "per annum",
"payScheme": "Agenda for change",
"grade": "Band 0",
"contractType": "Permanent",
"contractDuration": "12 months",
"workingPattern": "Full-time",
"datePosted": "01 January 2026",
"datePostedIso": "2026-01-01",
"closingDate": "15 January 2026",
"closingDateIso": "2026-01-15",
"interviewDate": null,
"applyUrl": "https://www.jobs.nhs.uk/candidate/jobadvert/C0000-00-0000/ats-direct-apply",
"contactName": "Jane Doe",
"contactJobTitle": "Recruitment Lead",
"contactEmail": "recruitment@example.org",
"contactPhone": "+44 0000 000000",
"contactDetails": {
"jobTitle": "Recruitment Lead",
"name": "Jane Doe",
"email": "recruitment@example.org",
"phone": "+44 0000 000000"
},
"employerDetails": {
"name": "Sample NHS Foundation Trust",
"website": "https://example.org/working-with-us",
"address": ["Sample Hospital", "London", "SW1A 1AA"],
"postcode": "SW1A 1AA"
},
"jobOverviewHtml": "Sample short job overview HTML appears here.
",
"jobOverviewText": "Sample short job overview text appears here.",
"mainDutiesHtml": "Sample main duties HTML appears here.
",
"mainDutiesText": "Sample main duties text appears here.",
"aboutOrganisationHtml": "Sample about-us HTML appears here.
",
"aboutOrganisationText": "Sample about-us text appears here.",
"jobDescriptionHtml": "Sample full job description HTML appears here.
",
"jobDescriptionText": "Sample full job description text appears here.",
"personSpecification": [
{
"category": "Qualifications",
"essentials": ["Sample essential criterion"],
"desirables": ["Sample desirable criterion"]
},
{
"category": "Experience",
"essentials": ["Sample essential criterion"],
"desirables": []
}
],
"supportingDocuments": [
{ "name": "Job Description.pdf", "sizeText": "PDF, 000 KB", "documentId": "0000000", "downloadFormUrl": "https://www.jobs.nhs.uk/candidate/search/save-job" }
],
"privacyPolicyUrl": "https://example.org/privacy",
"sponsorshipAvailable": true,
"ukRegistrationRequired": true,
"dbsCheckRequired": true,
"saveJobUrl": "https://www.jobs.nhs.uk/candidate/search/save-job/C0000-00-0000",
"basicInfo": {
"id": "C0000-00-0000",
"title": "Sample Job Title",
"url": "https://www.jobs.nhs.uk/candidate/jobadvert/C0000-00-0000",
"employer": "Sample NHS Foundation Trust",
"location": "London SW1A 1AA",
"salary": "£00,000 to £00,000 a year",
"datePosted": "01 January 2026",
"closingDate": "15 January 2026",
"contractType": "Permanent",
"workingPattern": "Full-time"
},
"scrapedAt": "2026-01-01T00:00:00.000Z"
}
```
### Plan Requirement
The upstream edge filter on jobs.nhs.uk rejects datacenter IPs. UK residential routing is required. The actor's default proxy config is `groups: ["RESIDENTIAL"], country: "GB"`, which covers paid Apify plans (Starter and above include residential).
If you are on the Apify Free plan, residential is not included. Two options:
1. Upgrade your Apify plan to Starter or above.
2. Uncheck "Use Apify proxy" in the proxy field and paste your own UK residential proxy URLs (Bright Data, Oxylabs, SmartProxy, IPRoyal, etc.).
When a run returns zero results due to proxy issues, the actor pushes a single `{ error: true, code: "ZERO_RESULTS", message: "..." }` record to the dataset so you see the upgrade hint in the dataset preview as well as the run log.
# Actor input Schema
## `mode` (type: `string`):
Search mode = pick keyword + location + filters below. URL mode = paste any jobs.nhs.uk URL refined in a browser (recommended for filter combinations not exposed below).
## `keywords` (type: `array`):
Free-text job-title or skill keywords (e.g. "doctor", "nurse", "radiographer"). One scrape per keyword. Leave empty to browse all jobs filtered only by location + facets.
## `location` (type: `string`):
Town, city, county, or postcode (e.g. "London", "SW1A 1AA", "Manchester"). Leave empty to search nationwide.
## `distance` (type: `string`):
Search radius around the location in miles. Empty = all of UK.
## `payBands` (type: `array`):
Filter by pay band. Multi-select. BAND\_2 to BAND\_9 are Agenda for Change bands; SPECIALTY\_DOCTOR / FOUNDATION\_DOCTOR / CONSULTANT / SPECIALTY\_REGISTRAR / DOCTOR\_OTHER / SPECIALIST / VERY\_SENIOR\_MANAGER are medical-and-dental grades.
## `staffGroups` (type: `array`):
Filter by NHS staff group. Multi-select.
## `contractTypes` (type: `array`):
Filter by contract type. Multi-select.
## `workingPatterns` (type: `array`):
Filter by working pattern. Multi-select.
## `payRanges` (type: `array`):
Filter by salary range in thousands of GBP. Multi-select.
## `employerName` (type: `string`):
Filter by NHS Trust or employer name (e.g. "Royal Marsden", "Guy's and St Thomas"). Partial match.
## `covidJobsOnly` (type: `boolean`):
Limit to roles tagged as COVID-related.
## `sortBy` (type: `string`):
How jobs.nhs.uk orders the SERP.
## `urls` (type: `array`):
One or more jobs.nhs.uk URLs. Examples: https://www.jobs.nhs.uk/candidate/search/results?keyword=nurse\&location=Manchester\&distance=10 or https://www.jobs.nhs.uk/candidate/jobadvert/C9282-25-0864 (single advert). Multi-URL supported; each pages forward independently. Filter fields above are ignored in URL mode.
## `maxPages` (type: `integer`):
Hard cap on how many SERP pages to walk per keyword × location combination (or per pasted URL). Each page returns up to 50 listings.
## `maxListings` (type: `integer`):
Stop after this many listings across all searches. 0 = no cap.
## `fetchDetails` (type: `boolean`):
When ON, also fetch each advert's detail page for full job summary, main duties, about us, job description (HTML + text), person specification (essential + desirable criteria split out), employer address + website, contact email/phone, supporting PDF download IDs, sponsorship + UK registration + DBS flags, and apply URL. SERP cards already carry id, title, employer, location, salary, dates so simple feeds work fine with this OFF. Default ON.
## `proxy` (type: `object`):
jobs.nhs.uk needs UK residential routing. Datacenter IPs are rejected by the upstream edge filter. Default groups: \["RESIDENTIAL"], country: "GB". Free-tier Apify accounts do not include residential, paste your own UK proxy URLs in the proxyUrls field if you are on Free.
## Actor input object example
```json
{
"mode": "search",
"keywords": [
"doctor"
],
"location": "London",
"distance": "10",
"covidJobsOnly": false,
"sortBy": "",
"urls": [
"https://www.jobs.nhs.uk/candidate/search/results?keyword=nurse&location=Manchester&distance=10"
],
"maxPages": 2,
"maxListings": 0,
"fetchDetails": true,
"proxy": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
],
"apifyProxyCountry": "GB"
}
}
```
# Actor output Schema
## `overview` (type: `string`):
No description
# API
You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.
## JavaScript example
```javascript
import { ApifyClient } from 'apify-client';
// Initialize the ApifyClient with your Apify API token
// Replace the '' with your token
const client = new ApifyClient({
token: '',
});
// Prepare Actor input
const input = {
"keywords": [
"doctor"
],
"location": "London",
"urls": [
"https://www.jobs.nhs.uk/candidate/search/results?keyword=nurse&location=Manchester&distance=10"
],
"proxy": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
],
"apifyProxyCountry": "GB"
}
};
// Run the Actor and wait for it to finish
const run = await client.actor("abotapi/jobs-nhs-uk-scraper").call(input);
// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
console.dir(item);
});
// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs
```
## Python example
```python
from apify_client import ApifyClient
# Initialize the ApifyClient with your Apify API token
# Replace '' with your token.
client = ApifyClient("")
# Prepare the Actor input
run_input = {
"keywords": ["doctor"],
"location": "London",
"urls": ["https://www.jobs.nhs.uk/candidate/search/results?keyword=nurse&location=Manchester&distance=10"],
"proxy": {
"useApifyProxy": True,
"apifyProxyGroups": ["RESIDENTIAL"],
"apifyProxyCountry": "GB",
},
}
# Run the Actor and wait for it to finish
run = client.actor("abotapi/jobs-nhs-uk-scraper").call(run_input=run_input)
# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
print(item)
# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start
```
## CLI example
```bash
echo '{
"keywords": [
"doctor"
],
"location": "London",
"urls": [
"https://www.jobs.nhs.uk/candidate/search/results?keyword=nurse&location=Manchester&distance=10"
],
"proxy": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
],
"apifyProxyCountry": "GB"
}
}' |
apify call abotapi/jobs-nhs-uk-scraper --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.apify.com/?tools=abotapi/jobs-nhs-uk-scraper",
"--header",
"Authorization: Bearer "
]
}
}
}
```
## OpenAPI specification
```json
{
"openapi": "3.0.1",
"info": {
"title": "NHS UK $0.8💰 URL | Keyword | Deep Search Scraper",
"description": "From $0.8/1k. Scrape nhs.uk Jobs listings into a flat dataset. Extract 50+ fields, including pay band, salary, full description, essential and desirable criteria, PDFs, sponsorship, DBS, employer details, contacts, and apply URL. Search by filters or use any URL.",
"version": "1.6",
"x-build-id": "ZF3SVI2IZUBA8irip"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/abotapi~jobs-nhs-uk-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-abotapi-jobs-nhs-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/abotapi~jobs-nhs-uk-scraper/runs": {
"post": {
"operationId": "runs-sync-abotapi-jobs-nhs-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/abotapi~jobs-nhs-uk-scraper/run-sync": {
"post": {
"operationId": "run-sync-abotapi-jobs-nhs-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",
"required": [
"mode"
],
"properties": {
"mode": {
"title": "1. Search mode",
"enum": [
"search",
"url"
],
"type": "string",
"description": "Search mode = pick keyword + location + filters below. URL mode = paste any jobs.nhs.uk URL refined in a browser (recommended for filter combinations not exposed below).",
"default": "search"
},
"keywords": {
"title": "Keywords (optional)",
"type": "array",
"description": "Free-text job-title or skill keywords (e.g. \"doctor\", \"nurse\", \"radiographer\"). One scrape per keyword. Leave empty to browse all jobs filtered only by location + facets.",
"items": {
"type": "string"
}
},
"location": {
"title": "Location (optional)",
"type": "string",
"description": "Town, city, county, or postcode (e.g. \"London\", \"SW1A 1AA\", \"Manchester\"). Leave empty to search nationwide."
},
"distance": {
"title": "Distance (miles)",
"enum": [
"",
"5",
"10",
"20",
"30",
"50",
"100"
],
"type": "string",
"description": "Search radius around the location in miles. Empty = all of UK.",
"default": "10"
},
"payBands": {
"title": "Pay bands (Agenda for Change + Doctor grades)",
"type": "array",
"description": "Filter by pay band. Multi-select. BAND_2 to BAND_9 are Agenda for Change bands; SPECIALTY_DOCTOR / FOUNDATION_DOCTOR / CONSULTANT / SPECIALTY_REGISTRAR / DOCTOR_OTHER / SPECIALIST / VERY_SENIOR_MANAGER are medical-and-dental grades.",
"items": {
"type": "string",
"enum": [
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8A",
"BAND_8B",
"BAND_8C",
"BAND_8D",
"BAND_9",
"SPECIALTY_DOCTOR",
"FOUNDATION_DOCTOR",
"CONSULTANT",
"SPECIALTY_REGISTRAR",
"DOCTOR_OTHER",
"SPECIALIST",
"VERY_SENIOR_MANAGER"
],
"enumTitles": [
"Band 2",
"Band 3",
"Band 4",
"Band 5",
"Band 6",
"Band 7",
"Band 8a",
"Band 8b",
"Band 8c",
"Band 8d",
"Band 9",
"Specialty Doctor",
"Foundation Doctor",
"Consultant",
"Specialty Registrar",
"Doctor (other)",
"Specialist",
"Very Senior Manager"
]
}
},
"staffGroups": {
"title": "Staff group",
"type": "array",
"description": "Filter by NHS staff group. Multi-select.",
"items": {
"type": "string",
"enum": [
"MEDICAL_AND_DENTAL",
"NURSING_AND_MIDWIFERY_REGD",
"ALLIED_HEALTH_PROF",
"HEALTHCARE_SCIENTISTS",
"ADMINISTRATIVE_AND_CLERICAL",
"ESTATES_AND_ANCILLARY",
"CLINICAL_SERVICES",
"PROF_SCIENTIFIC_AND_TECHNICAL",
"STUDENTS"
],
"enumTitles": [
"Medical and Dental",
"Nursing and Midwifery (registered)",
"Allied Health Professionals",
"Healthcare Scientists",
"Administrative and Clerical",
"Estates and Ancillary",
"Additional Clinical Services",
"Professional, Scientific and Technical",
"Students"
]
}
},
"contractTypes": {
"title": "Contract type",
"type": "array",
"description": "Filter by contract type. Multi-select.",
"items": {
"type": "string",
"enum": [
"Permanent",
"Fixed-Term",
"Apprenticeship",
"Voluntary",
"Locum",
"Training",
"Secondment",
"Honorary",
"Bank",
"NHS Reservist"
],
"enumTitles": [
"Permanent",
"Fixed-term",
"Apprenticeship",
"Voluntary",
"Locum",
"Training",
"Secondment",
"Honorary",
"Bank",
"NHS Reservist"
]
}
},
"workingPatterns": {
"title": "Working pattern",
"type": "array",
"description": "Filter by working pattern. Multi-select.",
"items": {
"type": "string",
"enum": [
"full-time",
"part-time",
"job-share",
"flexible-working",
"remote-working",
"compressed-hours",
"term-time-hours",
"annualised-hours"
],
"enumTitles": [
"Full-time",
"Part-time",
"Job share",
"Flexible working",
"Remote working",
"Compressed hours",
"Term-time hours",
"Annualised hours"
]
}
},
"payRanges": {
"title": "Pay range (k GBP per year)",
"type": "array",
"description": "Filter by salary range in thousands of GBP. Multi-select.",
"items": {
"type": "string",
"enum": [
"0-10",
"10-20",
"20-30",
"30-40",
"40-50",
"50-60",
"60-70",
"70-80",
"80-90",
"90-100",
"100"
],
"enumTitles": [
"Up to £10k",
"£10k - £20k",
"£20k - £30k",
"£30k - £40k",
"£40k - £50k",
"£50k - £60k",
"£60k - £70k",
"£70k - £80k",
"£80k - £90k",
"£90k - £100k",
"£100k+"
]
}
},
"employerName": {
"title": "Employer name (optional)",
"type": "string",
"description": "Filter by NHS Trust or employer name (e.g. \"Royal Marsden\", \"Guy's and St Thomas\"). Partial match."
},
"covidJobsOnly": {
"title": "COVID-related roles only",
"type": "boolean",
"description": "Limit to roles tagged as COVID-related.",
"default": false
},
"sortBy": {
"title": "Sort by",
"enum": [
"",
"publicationDateDesc",
"closingDate",
"salaryDesc",
"salaryAsc"
],
"type": "string",
"description": "How jobs.nhs.uk orders the SERP.",
"default": ""
},
"urls": {
"title": "Search URLs (URL mode)",
"type": "array",
"description": "One or more jobs.nhs.uk URLs. Examples: https://www.jobs.nhs.uk/candidate/search/results?keyword=nurse&location=Manchester&distance=10 or https://www.jobs.nhs.uk/candidate/jobadvert/C9282-25-0864 (single advert). Multi-URL supported; each pages forward independently. Filter fields above are ignored in URL mode.",
"items": {
"type": "string"
}
},
"maxPages": {
"title": "Max pages per search",
"minimum": 1,
"maximum": 200,
"type": "integer",
"description": "Hard cap on how many SERP pages to walk per keyword × location combination (or per pasted URL). Each page returns up to 50 listings.",
"default": 2
},
"maxListings": {
"title": "Max listings (total)",
"minimum": 0,
"type": "integer",
"description": "Stop after this many listings across all searches. 0 = no cap.",
"default": 0
},
"fetchDetails": {
"title": "Fetch detail pages (richer data)",
"type": "boolean",
"description": "When ON, also fetch each advert's detail page for full job summary, main duties, about us, job description (HTML + text), person specification (essential + desirable criteria split out), employer address + website, contact email/phone, supporting PDF download IDs, sponsorship + UK registration + DBS flags, and apply URL. SERP cards already carry id, title, employer, location, salary, dates so simple feeds work fine with this OFF. Default ON.",
"default": true
},
"proxy": {
"title": "Proxy configuration",
"type": "object",
"description": "jobs.nhs.uk needs UK residential routing. Datacenter IPs are rejected by the upstream edge filter. Default groups: [\"RESIDENTIAL\"], country: \"GB\". Free-tier Apify accounts do not include residential, paste your own UK proxy URLs in the proxyUrls field if you are on Free."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}
```