{
  "openapi": "3.0.1",
  "info": {
    "title": "NHS Jobs Scraper — New Vacancy Alerts",
    "description": "Search NHS Jobs — the official NHS recruitment board for England and Wales — by keyword, trust, location, Agenda for Change band and contract. Structured posting records plus only-new alerts on any saved search. $0.005 per posting, no start fee.",
    "version": "0.0",
    "x-build-id": "YyyFd3J0WJsL3Tirx"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/magnova~nhs-jobs-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-magnova-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/magnova~nhs-jobs-scraper/runs": {
      "post": {
        "operationId": "runs-sync-magnova-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/magnova~nhs-jobs-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-magnova-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": "Keywords",
            "type": "string",
            "description": "What to search for on NHS Jobs — a role, skill or phrase (e.g. \"nurse\", \"physiotherapist\", \"medical secretary\"). Matched the way the board itself matches keywords. Leave empty to search by location, employer or filters alone."
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "A town, city or postcode area (e.g. \"London\", \"Manchester\", \"LS1\"). The board searches around it; use \"Distance\" to set the radius. Leave empty for the whole of England and Wales."
          },
          "distanceMiles": {
            "title": "Distance (miles, around the location)",
            "enum": [
              "5",
              "10",
              "20",
              "30",
              "50",
              "100"
            ],
            "type": "string",
            "description": "How far around the location to search, using the board's own distance steps. Only applies when a location is given; without one it is ignored. Leave unset to use the board's own default radius."
          },
          "employer": {
            "title": "Employer / trust (optional)",
            "type": "string",
            "description": "Filter to one employer — an NHS trust or other NHS employer name as the board knows it (e.g. \"Whittington\", \"Imperial College Healthcare\"). Leave empty for all employers."
          },
          "payBands": {
            "title": "Pay bands / grades (optional — empty = all)",
            "type": "array",
            "description": "Filter by the board's own pay band / grade codes: BAND_2, BAND_3, BAND_4, BAND_5, BAND_6, BAND_7, BAND_8A, BAND_8B, BAND_8C, BAND_8D, BAND_9, CONSULTANT, DOCTOR_OTHER, FOUNDATION_DOCTOR, SPECIALIST, SPECIALTY_DOCTOR, SPECIALTY_REGISTRAR, VERY_SENIOR_MANAGER. Several codes are combined with OR. Leave empty for all bands and grades.",
            "items": {
              "type": "string"
            }
          },
          "contractTypes": {
            "title": "Contract types (optional — empty = all)",
            "type": "array",
            "description": "Filter by contract type, using the board's own values: Apprenticeship, Bank, Fixed-Term, Honorary, Locum, NHS Reservist, Permanent, Secondment, Training, Voluntary. Several values are combined with OR. Leave empty for all contract types.",
            "items": {
              "type": "string"
            }
          },
          "workingPatterns": {
            "title": "Working patterns (optional — empty = all)",
            "type": "array",
            "description": "Filter by working pattern, using the board's own values: full-time, part-time, job-share, flexible-working, remote-working, term-time-hours, compressed-hours, annualised-hours. Several values are combined with OR. Leave empty for all patterns.",
            "items": {
              "type": "string"
            }
          },
          "staffGroups": {
            "title": "Staff groups (optional — empty = all)",
            "type": "array",
            "description": "Filter by NHS staff group code: NURSING_AND_MIDWIFERY_REGD, MEDICAL_AND_DENTAL, ALLIED_HEALTH_PROF, HEALTHCARE_SCIENTISTS, CLINICAL_SERVICES, ADMINISTRATIVE_AND_CLERICAL, ESTATES_AND_ANCILLARY, PROF_SCIENTIFIC_AND_TECHNICAL, STUDENTS. Several codes are combined with OR. Leave empty for all staff groups.",
            "items": {
              "type": "string"
            }
          },
          "publishedSince": {
            "title": "Posted on/after (stateless cursor)",
            "type": "string",
            "description": "Optional stateless cursor for workflow tools (Make, Zapier, your own scheduler) that hold state themselves: only postings whose NHS Jobs \"Date posted\" is this ISO date or later are delivered — for example \"2026-11-01\" or \"2026-11-01T00:00:00Z\". The check runs on each advert's own posted date, boundary-inclusive and exact. Leave empty for no cursor."
          },
          "monitorOnlyNew": {
            "title": "Start monitoring silently (skip the first baseline)",
            "type": "boolean",
            "description": "Off (default): the first run delivers the search's current postings as a baseline batch (charged), later runs deliver only new ones. On: the first run silently remembers the current postings without delivering or charging anything, and only postings published afterwards are ever delivered. Only applies when a monitor store is selected; without a store every run is a baseline run."
          },
          "monitorStore": {
            "title": "Monitor state store (for only-new delivery)",
            "type": "string",
            "description": "A key-value store this Actor may read and write to remember which postings it has already seen — this is what makes only-new delivery work across runs. Use one store per saved search. Pick any store you own; the Actor keeps one small state record in it. Without a store, every run delivers the search's postings as a baseline and remembers nothing. If the store is missing or cannot be opened, the run continues in baseline mode and the SUMMARY record says so — it never crashes. The Actor remembers every posting it processed (including ones outside the cursor window), so widening the window later does not re-deliver old postings."
          },
          "maxResults": {
            "title": "Maximum postings per run",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Hard cap on postings delivered (and charged) in one run. Results come back newest first (the board's Date posted order), so a capped run delivers the most recent matches. Postings a capped run could not deliver stay unseen in monitoring mode and are delivered by the next run if they still match."
          },
          "maxTotalChargeUsd": {
            "title": "Maximum total charge per run (USD)",
            "minimum": 0.01,
            "type": "number",
            "description": "Optional hard stop for this run's charges: delivery stops as soon as the charged postings reach this amount (checked conservatively at the highest per-posting price, so the run may stop slightly early on discounted tiers), and the SUMMARY record reports stoppedByMaxCharge. Undelivered new postings stay unseen, so the next run delivers them. Leave empty for no cap. The run-level maximum charge in the run options is also honoured exactly."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}