{ "openapi": "3.0.1", "info": { "title": "UK Visa Sponsor Register: Changes and Company Data", "description": "Every UK employer that gains, loses or changes a sponsor licence, as JSON with the company number, status and SIC codes attached. Filter by route, town or change type, check a list of names in one run, and schedule it to get only what is new.", "version": "0.1", "x-build-id": "CD7X0XgbvSVqFSPNe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arjs1000~uk-visa-sponsor-register-changes/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arjs1000-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/arjs1000~uk-visa-sponsor-register-changes/runs": { "post": { "operationId": "runs-sync-arjs1000-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/arjs1000~uk-visa-sponsor-register-changes/run-sync": { "post": { "operationId": "run-sync-arjs1000-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": [ "changes", "snapshot", "verify" ], "type": "string", "description": "changes: sponsors added, removed or changed since a date. snapshot: the current register. verify: check a list of organisation names against the register.", "default": "changes" }, "since": { "title": "Changes since", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Mode changes only. Date in YYYY-MM-DD. Leave empty for the last 7 days. If the register has not changed in that time (it is not published every day, and not over Christmas), an empty date returns the most recent update's changes instead." }, "sinceLastRun": { "title": "Only new since the last run", "type": "boolean", "description": "Mode changes only. Turn this on for scheduled runs. Each run returns only changes newer than the last run that had it on, so you never pay twice for the same item. The actor saves its place in a key-value store called uk-visa-sponsor-register-changes-cursor in your own Apify account. The first run has no saved place and uses the default window. A date in \"Changes since\" overrides the saved place for that run. A failed or aborted run does not move it.", "default": false }, "cursorName": { "title": "Cursor name", "pattern": "^[a-zA-Z0-9!\\-_.'()]{0,256}$", "type": "string", "description": "Used with \"Only new since the last run\". The name of the record that holds the saved place. Leave it empty and each mode and set of filters gets its own. Give two tasks the same name only if they should share one place." }, "changeType": { "title": "Change type", "enum": [ "added", "removed", "changed" ], "type": "string", "description": "Mode changes only. Leave empty for all." }, "route": { "title": "Route", "type": "string", "description": "Filter by visa route, exactly as on the register, case-insensitive. Example: Skilled Worker" }, "town": { "title": "Town or city", "type": "string", "description": "Filter by town, exactly as on the register, case-insensitive. Example: London" }, "names": { "title": "Names to verify", "maxItems": 100000, "type": "array", "description": "Mode verify only. One organisation name per line. Each name is one charged event.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum items", "minimum": 1, "maximum": 250000, "type": "integer", "description": "Stop after this many dataset items (each is a charged event). The form starts at 10 so a first run costs under one cent; raise it for a full pull. Runs started through the API without this field default to 10,000.", "default": 10000 } } }, "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 } } } } } } } } } }