{ "openapi": "3.0.1", "info": { "title": "UK Visa Sponsor Register: New Sponsors, Removals & Downgrades", "description": "UK Home Office Register of Licensed Sponsors (workers) as clean JSON, plus a daily change feed: newly licensed sponsors, removed sponsors, A-to-B rating downgrades and route changes (Skilled Worker, Global Business Mobility...). Filter by town, county, route, rating, keyword.", "version": "0.1", "x-build-id": "yvebYfQETBtQHJEEh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moment-data~uk-visa-sponsor-register-changes/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moment-data-uk-visa-sponsor-register-changes", "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/moment-data~uk-visa-sponsor-register-changes/runs": { "post": { "operationId": "runs-sync-moment-data-uk-visa-sponsor-register-changes", "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/moment-data~uk-visa-sponsor-register-changes/run-sync": { "post": { "operationId": "run-sync-moment-data-uk-visa-sponsor-register-changes", "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": [ "latest", "changes" ], "type": "string", "description": "latest (default): sponsors from today's register that match your filters, no saved state. changes: compares today's register with the snapshot saved by your previous changes run (per State key) and returns sponsors added, removed, re-rated (e.g. A -> B) or with routes added/removed. The first changes run saves the baseline and returns a sample flagged changeType = baseline.", "default": "latest" }, "locations": { "title": "Towns / cities / counties", "type": "array", "description": "Whole-word match on the register's Town/City or County, e.g. London, Manchester, Scotland, West Midlands. Empty = all of the UK.", "items": { "type": "string" } }, "routes": { "title": "Routes", "type": "array", "description": "Partial match on the visa route, e.g. Skilled Worker, Global Business Mobility (or GBM), Senior or Specialist Worker, Scale-up, Creative Worker, Charity Worker, Religious Worker, International Sportsperson, Seasonal Worker, Government Authorised Exchange. Empty = all routes.", "items": { "type": "string" } }, "ratings": { "title": "Ratings", "type": "array", "description": "A, B (sponsors with compliance issues on an action plan), Provisional (UK Expansion Worker), Premium, SME+. Empty = all ratings.", "items": { "type": "string" } }, "licenceType": { "title": "Licence type", "enum": [ "any", "worker", "temporaryWorker" ], "type": "string", "description": "Worker (long-term routes like Skilled Worker) or Temporary Worker (Creative, Charity, Religious, GAE, Seasonal...).", "default": "any" }, "keyword": { "title": "Organisation name keyword", "type": "string", "description": "Words that must all appear in the organisation name, e.g. \"care\", \"nhs trust\", \"university\". Comma-separate alternatives: \"care home, nursing\"." }, "changeTypes": { "title": "Change types (changes mode)", "type": "array", "description": "Only these changes: added, removed, downgrade (A -> B), upgrade (B -> A), ratingChanged, routeAdded, routeRemoved, locationChanged. Empty = all.", "items": { "type": "string" } }, "maxItems": { "title": "Max sponsors per run", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Hard cap on delivered records (also caps your spend). The full register has about 128,000 organisations.", "default": 40 }, "stateKey": { "title": "State key (changes mode)", "type": "string", "description": "Name of the saved snapshot in the named key-value store uk-visa-sponsor-register-changes-state. Use one key per schedule. Snapshots always hold the full register, so filters can change between runs.", "default": "default" }, "updateSnapshot": { "title": "Advance snapshot after run (changes mode)", "type": "boolean", "description": "Save today's register as the new baseline after delivering the changes. Turn off to re-run the same comparison. The snapshot is never advanced if the run hits your spending limit, so no change is skipped.", "default": true }, "compareRegisterUrl": { "title": "Compare with an older register CSV URL (advanced)", "type": "string", "description": "changes mode: diff against this older register CSV (e.g. a previous assets.publishing.service.gov.uk file you saved, or a web.archive.org copy) instead of the saved snapshot. The snapshot is not touched." }, "registerUrl": { "title": "Use this register CSV instead of today's (advanced)", "type": "string", "description": "Override the current register with a specific CSV URL. Together with compareRegisterUrl this compares any two register versions. Empty = today's register from the gov.uk Content API." } } }, "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 } } } } } } } } } }