{ "openapi": "3.0.1", "info": { "title": "UK Company Filing & Insolvency Delta", "version": "0.1", "x-build-id": "nU3SOI7zhmvKNzZZe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ursog~uk-company-filing-insolvency-delta/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ursog-uk-company-filing-insolvency-delta", "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/ursog~uk-company-filing-insolvency-delta/runs": { "post": { "operationId": "runs-sync-ursog-uk-company-filing-insolvency-delta", "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/ursog~uk-company-filing-insolvency-delta/run-sync": { "post": { "operationId": "run-sync-ursog-uk-company-filing-insolvency-delta", "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", "required": [ "companyNumbers" ], "properties": { "companyNumbers": { "title": "UK company numbers", "minItems": 1, "maxItems": 250, "type": "array", "description": "Eight-digit Companies House numbers, including valid two-letter prefixes such as SC, NI, OC, or FC.", "items": { "type": "string", "pattern": "^(?:[A-Za-z]{2}[0-9]{6}|[0-9]{8})$", "maxLength": 16 } }, "monitorKey": { "title": "Monitor key", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "maxLength": 256, "type": "string", "description": "A stable private name for this watchlist. Changing it creates a separate baseline.", "default": "default" }, "maxCompanies": { "title": "Maximum companies", "minimum": 1, "maximum": 250, "type": "integer", "description": "Stops the run before checking more than this many unique company numbers.", "default": 250 }, "enableAdvancedLimit": { "title": "Allow more than 100 companies", "type": "boolean", "description": "Advanced mode. Large watchlists may span multiple rate-limit windows and should be validated gradually.", "default": false }, "maxConcurrency": { "title": "Concurrent company acquisitions", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of companies acquired concurrently while output remains deterministically ordered.", "default": 5 }, "requestTimeoutSecs": { "title": "Transaction timeout", "minimum": 3, "maximum": 60, "type": "integer", "description": "Maximum total time for headers and body streaming of one official API request.", "default": 15 }, "maxRequestRetries": { "title": "Temporary-failure retries", "minimum": 0, "maximum": 1, "type": "integer", "description": "Retries only temporary 429, timeout, and server failures with bounded backoff.", "default": 1 }, "maxResponseBytes": { "title": "Maximum bytes per response", "minimum": 50000, "maximum": 10000000, "type": "integer", "description": "Aborts a response while streaming if it exceeds this memory and bandwidth safety limit.", "default": 5000000 }, "maxPagesPerResource": { "title": "Maximum pages per resource", "minimum": 1, "maximum": 2, "type": "integer", "description": "Hard pagination bound for filings, officers, and charges for each company.", "default": 2 }, "pageSize": { "title": "Records per page", "minimum": 10, "maximum": 100, "type": "integer", "description": "Requested page size for supported Companies House list resources.", "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 } } }, "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 } } } } } } } } } }