{ "openapi": "3.0.1", "info": { "title": "UK Visa Sponsor Register: Skilled Worker Sponsors + Changes", "description": "Home Office register of licensed sponsors (Skilled Worker and all worker routes) as JSON: organisation, town, A/B rating, routes. Daily feed of added, removed and downgraded sponsors. $2 per 1,000. No personal data.", "version": "0.1", "x-build-id": "s2bnHsHX19wM9IUny" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wrtcom~uk-visa-sponsors/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wrtcom-uk-visa-sponsors", "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/wrtcom~uk-visa-sponsors/runs": { "post": { "operationId": "runs-sync-wrtcom-uk-visa-sponsors", "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/wrtcom~uk-visa-sponsors/run-sync": { "post": { "operationId": "run-sync-wrtcom-uk-visa-sponsors", "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": { "mode": { "title": "Mode", "enum": [ "snapshot", "changes" ], "type": "string", "description": "'snapshot' = one record per licensed sponsor (organisation + town). 'changes' = sponsors added, removed or changed (A/B rating, routes) since your previous 'changes' run. The FIRST 'changes' run only saves today's register as the baseline and returns no records; schedule it daily (the register is updated on working days).", "default": "snapshot" }, "keywords": { "title": "Organisation name keywords", "type": "array", "description": "Keep only sponsors whose name contains any of these words (case-insensitive), e.g. 'care', 'NHS', 'software'. Empty = all.", "items": { "type": "string" } }, "towns": { "title": "Towns / cities", "type": "array", "description": "Exact town or city as written in the register, case-insensitive, e.g. 'London', 'Manchester'. Empty = all.", "items": { "type": "string" } }, "counties": { "title": "Counties", "type": "array", "description": "Exact county as written in the register, case-insensitive, e.g. 'Greater London', 'West Yorkshire'. Most rows have no county. Empty = all.", "items": { "type": "string" } }, "routes": { "title": "Visa routes", "type": "array", "description": "Keep sponsors licensed for a route containing any of these words, e.g. 'Skilled Worker', 'Creative', 'Global Business Mobility', 'Charity'. Empty = all.", "items": { "type": "string" } }, "ratings": { "title": "Ratings", "type": "array", "description": "Keep sponsors with any of these ratings: 'A', 'B' (downgraded), 'A (Premium)', 'A (SME+)', 'UK Expansion Worker: Provisional'. Empty = all.", "items": { "type": "string" } }, "changeTypes": { "title": "Change types (changes mode)", "type": "array", "description": "Changes mode only: which changes to return. Empty = all.", "items": { "type": "string", "enum": [ "added", "removed", "changed" ], "enumTitles": [ "Added (new licence)", "Removed (licence revoked, surrendered or expired)", "Changed (rating or routes)" ] } }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Stop after this many results (you pay per result). The form starts at 50 for a quick test; default without a value is 1000. The full register is about 105,000 sponsors.", "default": 1000 }, "onlyNew": { "title": "Only new since last run", "type": "boolean", "description": "Skip records already returned by earlier runs on your account (snapshot mode: = sponsors you have not received yet).", "default": 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 } } } } } } } } } }