{ "openapi": "3.0.1", "info": { "title": "UK Visa Sponsor Register Search (Unofficial)", "description": "Search the UK Home Office register of licensed sponsors (workers) by organisation name, town, route or rating. One row per licence route with type and rating. Unofficial tool using open government data, not affiliated with the Home Office.", "version": "0.0", "x-build-id": "BdZSe6Ia9kJggAprm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/conserving_celerytop~uk-visa-sponsor-register-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-conserving_celerytop-uk-visa-sponsor-register-api", "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/conserving_celerytop~uk-visa-sponsor-register-api/runs": { "post": { "operationId": "runs-sync-conserving_celerytop-uk-visa-sponsor-register-api", "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/conserving_celerytop~uk-visa-sponsor-register-api/run-sync": { "post": { "operationId": "run-sync-conserving_celerytop-uk-visa-sponsor-register-api", "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 names", "maxItems": 100, "type": "array", "description": "Enter one organisation name per line. A row matches when it contains all the words of a name, for example Tesco finds Tesco Stores Limited. Leave empty to list sponsors by the filters below.", "items": { "type": "string" } }, "nameMatch": { "title": "Name matching", "enum": [ "contains", "exact" ], "type": "string", "description": "Choose how each organisation name is compared. Exact matches the full name after removing case, punctuation and endings such as Ltd, Limited, PLC and LLP.", "default": "contains" }, "towns": { "title": "Towns or cities", "maxItems": 100, "type": "array", "description": "Enter one town or city per line, as written in the register, for example London or Manchester. Case does not matter. Leave empty to include every town.", "items": { "type": "string" } }, "routes": { "title": "Routes", "maxItems": 100, "type": "array", "description": "Enter one route per line, for example Skilled Worker, Charity Worker or Global Business Mobility. A row matches when its route contains the words you type. Leave empty to include every route.", "items": { "type": "string" } }, "rating": { "title": "Sponsor rating", "enum": [ "any", "A", "B", "A (Premium)", "A (SME+)", "UK Expansion Worker: Provisional" ], "type": "string", "description": "Return only sponsors with this rating. The rating is taken from the Type and Rating column of the register.", "default": "any" }, "licenceType": { "title": "Licence type", "enum": [ "any", "Worker", "Temporary Worker" ], "type": "string", "description": "Return only sponsors licensed for this type of worker. Worker covers long-term routes such as Skilled Worker; Temporary Worker covers short-term routes.", "default": "any" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 150000, "type": "integer", "description": "Return at most this many rows in total across all names and filters. The full register has about 143,000 rows. Each row returned is one charged result.", "default": 100 } } }, "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 } } } } } } } } } }