{ "openapi": "3.0.1", "info": { "title": "UK Sponsor Register Changes", "description": "Dated changes to the UK sponsor register: organisations added, no longer listed, rating or route changed. Contains public sector information licensed under the Open Government Licence v3.0. Not affiliated with or endorsed by the Home Office or UK Visas and Immigration.", "version": "0.0", "x-build-id": "UZ3GFL8p93LYCsqUL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yappman~uk-sponsor-register-changes/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yappman-uk-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/yappman~uk-sponsor-register-changes/runs": { "post": { "operationId": "runs-sync-yappman-uk-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/yappman~uk-sponsor-register-changes/run-sync": { "post": { "operationId": "run-sync-yappman-uk-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": { "changedSince": { "title": "Changed since", "type": "string", "description": "First day to include, YYYY-MM-DD. Default: 7 days before the end date. History starts on the day collection began; an earlier date is cut to that day and the run says so." }, "changedUntil": { "title": "Changed until", "type": "string", "description": "Last day to include, YYYY-MM-DD. Default: today. The window is at most 92 days." }, "changeTypes": { "title": "Change types", "type": "array", "description": "Which changes to return: added, removed (no longer listed), ratingChanged, routeAdded, routeRemoved. Default: all five.", "items": { "type": "string" } }, "routes": { "title": "Routes", "maxItems": 20, "type": "array", "description": "Only these sponsor routes (exact names, any capitals). An unknown route is refused and the known routes are listed.", "items": { "type": "string" } }, "towns": { "title": "Towns", "maxItems": 20, "type": "array", "description": "Only these towns or cities (exact, any capitals).", "items": { "type": "string" } }, "counties": { "title": "Counties", "maxItems": 20, "type": "array", "description": "Only these counties (exact, any capitals).", "items": { "type": "string" } }, "organisationContains": { "title": "Organisation name contains", "minLength": 3, "maxLength": 60, "type": "string", "description": "Only organisations whose published name contains this text (3 to 60 characters), for example to follow one employer." }, "maxItems": { "title": "Maximum rows", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The most change rows to return, and so the most you can be charged for rows: each row costs $0.005 on every plan, so 3 rows cost up to $0.015, 100 up to $0.50 and 5000 up to $25.00. 1 to 5000. The Console form starts at 3; a call that leaves it out gets 100.", "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 } } } } } } } } } }