{ "openapi": "3.0.1", "info": { "title": "NHS Job Extractor", "description": "NHS Jobs Scraper that pulls vacancy listings from jobs.nhs.uk by keyword, location, and filter, so recruiters and analysts get clean structured job data without manual searching.", "version": "0.0", "x-build-id": "I5ZcpbByQ2B6ugfiC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kawsar~nhs-job-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kawsar-nhs-job-extractor", "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/kawsar~nhs-job-extractor/runs": { "post": { "operationId": "runs-sync-kawsar-nhs-job-extractor", "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/kawsar~nhs-job-extractor/run-sync": { "post": { "operationId": "run-sync-kawsar-nhs-job-extractor", "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": [ "keywords" ], "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "One keyword per line. Each keyword is paired with the corresponding location on the same line number. For example: nurse on line 1 pairs with London on line 1.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "One location per line, paired with the keyword on the same line number. Leave blank to search all UK locations for every keyword.", "items": { "type": "string" } }, "distance": { "title": "Distance (miles)", "minimum": 5, "maximum": 100, "type": "integer", "description": "Search radius in miles from each location. Accepted values: 5, 10, 20, 30, 50, 100. Applies to all keyword+location pairs.", "default": 10 }, "employer": { "title": "Employer", "type": "string", "description": "Filter results to a specific employer or NHS Trust name.", "default": "" }, "contractType": { "title": "Contract type", "enum": [ "", "Permanent", "Fixed-Term", "Apprenticeship", "Voluntary", "Locum", "Training", "Secondment", "Honorary", "Bank" ], "type": "string", "description": "Filter by contract type. Leave blank to include all types.", "default": "" }, "workingPattern": { "title": "Working pattern", "enum": [ "", "full-time", "part-time", "job-share", "flexible-working", "remote-working", "compressed-hours", "term-time-hours", "annualised-hours" ], "type": "string", "description": "Filter by working pattern. Leave blank to include all patterns.", "default": "" }, "salaryFrom": { "title": "Minimum salary", "minimum": 0, "type": "integer", "description": "Minimum annual salary filter. Use 0 for no lower limit.", "default": 0 }, "salaryTo": { "title": "Maximum salary", "minimum": 0, "type": "integer", "description": "Maximum annual salary filter. Use 0 for no upper limit.", "default": 0 }, "startPage": { "title": "Start page", "minimum": 1, "type": "integer", "description": "Page number to begin scraping from. Applies to every keyword+location pair. Use this to resume an interrupted run.", "default": 1 }, "maxItems": { "title": "Max items per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of jobs to collect per keyword+location pair. If you have 3 keywords and set this to 100, the actor collects up to 300 jobs total.", "default": 100 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Per-request timeout in seconds.", "default": 30 } } }, "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 } } } } } } } } } }