{ "openapi": "3.0.1", "info": { "title": "UK Company Changes: Strike-offs, Liquidations & Status Feed", "description": "Monthly feed of status changes at UK Companies House companies: strike-off proposals, liquidations, administrations, SIC and name changes. Company-level only, no personal data.", "version": "0.1", "x-build-id": "2aSJn622DCyMbhZcv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/eythan~uk-company-changes/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-eythan-uk-company-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/eythan~uk-company-changes/runs": { "post": { "operationId": "runs-sync-eythan-uk-company-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/eythan~uk-company-changes/run-sync": { "post": { "operationId": "run-sync-eythan-uk-company-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": { "eventTypes": { "title": "Event types", "type": "array", "description": "Which kinds of change to return. 'status_change' covers strike-off proposals, liquidations and administrations.", "items": { "type": "string", "enum": [ "status_change", "new_company", "name_change", "sic_change", "accounts_category_change", "charges_change", "category_change", "dissolution_date_set", "removed_from_snapshot" ], "enumTitles": [ "Status change", "New company", "Name change", "SIC code change", "Accounts category change", "Charges change", "Company category change", "Dissolution date set", "Removed from register snapshot" ] }, "default": [ "status_change" ] }, "statusTo": { "title": "New status (optional filter)", "type": "array", "description": "Only return status changes INTO one of these statuses, e.g. 'Liquidation' or 'Active - Proposal to Strike off'. Leave empty for all.", "default": [], "items": { "type": "string" } }, "dateFrom": { "title": "From snapshot date", "type": "string", "description": "Earliest monthly snapshot to include, format YYYY-MM-DD (snapshots are dated the 1st of each month).", "default": "" }, "dateTo": { "title": "To snapshot date", "type": "string", "description": "Latest monthly snapshot to include, format YYYY-MM-DD.", "default": "" }, "sicPrefixes": { "title": "SIC code prefixes (optional)", "type": "array", "description": "Only companies whose SIC codes start with one of these, e.g. '62' (IT) or '6820' (real estate rental).", "default": [], "items": { "type": "string" } }, "postcodeAreas": { "title": "Postcode areas (optional)", "type": "array", "description": "Only companies whose registered-office postcode starts with one of these outward-code prefixes, e.g. 'EC1', 'M', 'LS'.", "default": [], "items": { "type": "string" } }, "companyNumbers": { "title": "Company numbers (optional)", "type": "array", "description": "Only these Companies House company numbers (8 characters, e.g. '08209948').", "default": [], "items": { "type": "string" } }, "nameContains": { "title": "Company name contains (optional)", "type": "string", "description": "Case-insensitive text the current company name must contain.", "default": "" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many events. You are only charged for events returned.", "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 } } } } } } } } } }