{
  "openapi": "3.0.1",
  "info": {
    "title": "GOV.UK Jobs Scraper",
    "description": "Scrape UK government job listings from Work Hub (jobs.service.gov.uk, formerly Find a Job): salary, employer, location, contract type, dates and full descriptions. Free trial, no per-result fee. Powered by Scrape.do.",
    "version": "0.0",
    "x-build-id": "jAB4zQtCvBU4dOy0g"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapedo~gov-uk-jobs-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapedo-gov-uk-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/scrapedo~gov-uk-jobs-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapedo-gov-uk-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/scrapedo~gov-uk-jobs-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapedo-gov-uk-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": {
          "scrapeDoToken": {
            "title": "Scrape.do API token",
            "type": "string",
            "description": "Optional. Without a token you get a free trial of up to 50 jobs per run. Add your own Scrape.do token for unlimited jobs; requests then use your Scrape.do credits (about 1 credit per 30 jobs). Get a free token at https://scrape.do/?utm_source=apify&utm_medium=actor&utm_campaign=gov-uk-jobs-scraper"
          },
          "startUrls": {
            "title": "Job board URLs",
            "type": "array",
            "description": "Optional. Search result pages from https://www.jobs.service.gov.uk/jobs/search (with your filters applied) and/or single job pages. Old findajob.dwp.gov.uk search links are converted automatically. When you add URLs, the search filters below are ignored.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "keywords": {
            "title": "Keywords",
            "type": "string",
            "description": "Job title or skill to search for, for example data analyst. Leave empty to search all jobs."
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "Town, city or postcode, for example London or SW1A 1AA. Leave empty to search the whole UK."
          },
          "distanceMiles": {
            "title": "Distance from location",
            "enum": [
              "1",
              "3",
              "5",
              "10",
              "20",
              "40",
              "1000"
            ],
            "type": "string",
            "description": "How far around the location to search. Only used when a location is set."
          },
          "mustIncludeWords": {
            "title": "Must include words",
            "type": "string",
            "description": "Only jobs that contain all of these words, for example python sql."
          },
          "excludeWords": {
            "title": "Exclude words",
            "type": "string",
            "description": "Skip jobs that contain these words, for example agency."
          },
          "workingPattern": {
            "title": "Working pattern",
            "type": "array",
            "description": "Where the work is done. Pick several to match any of them. Leave empty for any.",
            "items": {
              "type": "string",
              "enum": [
                "REMOTE",
                "ONSITE",
                "HYBRID",
                "FIELD_BASED"
              ],
              "enumTitles": [
                "Remote",
                "On-site",
                "Hybrid",
                "Field-based"
              ]
            }
          },
          "contractType": {
            "title": "Contract type",
            "type": "array",
            "description": "Type of contract. Pick several to match any of them. Leave empty for any.",
            "items": {
              "type": "string",
              "enum": [
                "PERMANENT",
                "TEMPORARY",
                "CONTRACT",
                "APPRENTICESHIP"
              ],
              "enumTitles": [
                "Permanent",
                "Temporary",
                "Contract",
                "Apprenticeship"
              ]
            }
          },
          "hours": {
            "title": "Hours",
            "type": "array",
            "description": "Full-time or part-time. Leave empty for any.",
            "items": {
              "type": "string",
              "enum": [
                "FULL_TIME",
                "PART_TIME"
              ],
              "enumTitles": [
                "Full-time",
                "Part-time"
              ]
            }
          },
          "salaryBand": {
            "title": "Salary range",
            "type": "array",
            "description": "Yearly salary range. Pick several to match any of them. Leave empty for any.",
            "items": {
              "type": "string",
              "enum": [
                "0-10000",
                "10000-30000",
                "30000-60000",
                "60000-80000",
                "80000-100000",
                "100000-999999"
              ],
              "enumTitles": [
                "Up to £10,000",
                "£10,000 - £30,000",
                "£30,000 - £60,000",
                "£60,000 - £80,000",
                "£80,000 - £100,000",
                "Over £100,000"
              ]
            }
          },
          "postedWithin": {
            "title": "Posted within",
            "enum": [
              "1",
              "3",
              "7",
              "14"
            ],
            "type": "string",
            "description": "Only jobs added recently. Leave empty for any date."
          },
          "disabilityConfidentOnly": {
            "title": "Disability Confident employers only",
            "type": "boolean",
            "description": "Only show jobs from employers in the Disability Confident scheme.",
            "default": false
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "RELEVANCE",
              "DATE",
              "SALARY_DESC",
              "SALARY_ASC"
            ],
            "type": "string",
            "description": "Order of the results.",
            "default": "RELEVANCE"
          },
          "maxItems": {
            "title": "Maximum jobs",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many jobs. Use 0 for no limit. Free trial runs are capped at 50.",
            "default": 100
          },
          "includeDetails": {
            "title": "Include full job details",
            "type": "boolean",
            "description": "Open every job page to also get the full description, posting date, closing date and apply link. Costs 1 extra Scrape.do credit per job and needs your own Scrape.do token.",
            "default": false
          },
          "useResidentialProxy": {
            "title": "Use residential proxies",
            "type": "boolean",
            "description": "Routes requests through Scrape.do residential and mobile proxies (more Scrape.do credits per request). Normally not needed. Only with your own Scrape.do token.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Parallel requests",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many pages to fetch at the same time (1-50). Keep it within your Scrape.do plan's concurrency limit. Free trial runs always use 3.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}