{ "openapi": "3.0.1", "info": { "title": "UK Visa Sponsor List: Skilled Worker Sponsor Register Scraper", "description": "Search the official UK visa sponsor list (Home Office register of licensed sponsors): Skilled Worker, Global Business Mobility, Creative Worker and more. Track new, removed and downgraded sponsors daily; optional Companies House data.", "version": "0.1", "x-build-id": "OsHPZv6CT83fihMKV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datatoolsuk~uk-visa-sponsor-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datatoolsuk-uk-visa-sponsor-register", "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/datatoolsuk~uk-visa-sponsor-register/runs": { "post": { "operationId": "runs-sync-datatoolsuk-uk-visa-sponsor-register", "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/datatoolsuk~uk-visa-sponsor-register/run-sync": { "post": { "operationId": "run-sync-datatoolsuk-uk-visa-sponsor-register", "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": { "organisationName": { "title": "Organisation name contains", "type": "string", "description": "Case-insensitive search in the organisation name, e.g. 'NHS' or 'games'. Leave empty for all sponsors." }, "town": { "title": "Town / city contains", "type": "string", "description": "e.g. London, Manchester." }, "county": { "title": "County contains", "type": "string", "description": "e.g. Greater Manchester. Many rows have no county, so prefer Town." }, "routes": { "title": "Routes", "type": "array", "description": "Any of: Skilled Worker, Global Business Mobility: Senior or Specialist Worker, Creative Worker, Charity Worker, International Sportsperson, Religious Worker, Scale-up, Seasonal Worker, Government Authorised Exchange... (partial match).", "items": { "type": "string" } }, "ratings": { "title": "Ratings", "type": "array", "description": "e.g. 'A rating', 'B rating', 'Premium', 'SME+', 'Provisional' (partial match).", "items": { "type": "string" } }, "sponsorTypes": { "title": "Sponsor type", "type": "array", "description": "Worker or Temporary Worker licence.", "items": { "type": "string", "enum": [ "Worker", "Temporary Worker" ] } }, "changesOnly": { "title": "Changes only (since last snapshot)", "type": "boolean", "description": "Output only sponsors added, removed or with a rating change since the previous saved snapshot (stored in the named key-value store 'uk-visa-sponsors-state'). The first run saves a baseline. Schedule daily.", "default": false }, "compareToSnapshotDate": { "title": "Compare to snapshot date (optional)", "type": "string", "description": "YYYY-MM-DD of an earlier saved snapshot to diff against instead of the latest one (last 10 kept)." }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "0 = no limit (the full register is ~140,000 rows).", "default": 1000 }, "companiesHouseApiKey": { "title": "Companies House API key (optional, enrichment)", "type": "string", "description": "Free key from developer.company-information.service.gov.uk. Adds company number, status, type, registered postcode and incorporation date." }, "maxEnrich": { "title": "Max rows to enrich", "minimum": 0, "type": "integer", "description": "Companies House allows 600 requests per 5 minutes.", "default": 200 } } }, "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 } } } } } } } } } }