{ "openapi": "3.0.1", "info": { "title": "UK Visa Sponsor Register - Skilled Worker Licensed Sponsors", "description": "Search the UK Home Office register of licensed visa sponsors (Skilled Worker and other Worker and Temporary Worker routes), read fresh from GOV.UK each run: organisation, town, county, type & rating, route. Filter by name, town, route or rating. Rows naming individuals are left out. Unofficial.", "version": "0.1", "x-build-id": "RWuYxDd0K7kepkxZK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jpopendata~uk-visa-sponsor-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jpopendata-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/jpopendata~uk-visa-sponsor-register/runs": { "post": { "operationId": "runs-sync-jpopendata-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/jpopendata~uk-visa-sponsor-register/run-sync": { "post": { "operationId": "run-sync-jpopendata-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": { "organisationNames": { "title": "Organisation name contains", "type": "array", "description": "Optional. Part of the organisation name, e.g. \"tesco\", \"university of\", \"nhs foundation trust\" (any case; accents, punctuation and \"&\"/\"and\" ignored). A sponsor matches if its name contains ANY entry.", "default": [], "items": { "type": "string" } }, "towns": { "title": "Towns / cities or counties", "type": "array", "description": "Optional. Town/city or county as written in the register, e.g. \"London\", \"Manchester\", \"Kent\" (whole words: \"London\" also matches \"Greater London\" but not \"Londonderry\"). Matches the Town/City or the County column. Many rows have no county.", "default": [], "items": { "type": "string" } }, "routes": { "title": "Visa routes", "type": "array", "description": "Optional. Route words, e.g. \"Skilled Worker\", \"Global Business Mobility\" (or \"GBM\"), \"Senior or Specialist Worker\", \"Creative Worker\", \"Charity Worker\", \"Religious Worker\", \"Minister of Religion\", \"International Sportsperson\", \"Scale-up\", \"Seasonal Worker\", \"Government Authorised Exchange\", \"International Agreement\", \"Graduate Trainee\", \"UK Expansion Worker\". Health and Care Worker visas are part of Skilled Worker.", "default": [], "items": { "type": "string" } }, "ratings": { "title": "Ratings", "type": "array", "description": "Optional. \"A\" (A rating, including A (Premium) and A (SME+)), \"B\" (B rating: the sponsor must follow an action plan), \"Premium\", \"SME+\", \"Provisional\" (UK Expansion Worker: Provisional). Empty = every rating.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many sponsors (1..1,000,000). The whole register is about 130,000 rows after rows naming individuals are left out, so 1,000,000 returns everything that matches. A search that reaches this number early finishes in seconds.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed: GOV.UK serves the register to Apify datacenter IPs directly. Leave off unless you have a reason to route the download through a proxy (one sticky session per run, no rotation).", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }