{ "openapi": "3.0.1", "info": { "title": "UK Companies House Company Data & Monthly Changes", "description": "Search UK Companies House company data by SIC code, postcode, status, company type and incorporation date, or get monthly new incorporations, dissolutions and status changes. Bulk open data, no API key, company-only fields.", "version": "0.1", "x-build-id": "yJmebkraEXe2n0Z9s" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ayuki~uk-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ayuki-uk-companies-house", "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/ayuki~uk-companies-house/runs": { "post": { "operationId": "runs-sync-ayuki-uk-companies-house", "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/ayuki~uk-companies-house/run-sync": { "post": { "operationId": "run-sync-ayuki-uk-companies-house", "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": [ "snapshot", "monthlyDiff" ], "type": "string", "description": "snapshot = filter the latest monthly company snapshot. monthlyDiff = companies that are new, dissolved/removed or changed status between the latest and the previous monthly snapshot.", "default": "snapshot" }, "changeTypes": { "title": "Change types (monthly diff)", "minItems": 1, "type": "array", "description": "Which changes to return in monthlyDiff mode.", "items": { "type": "string", "enum": [ "new", "dissolved", "statusChanged" ], "enumTitles": [ "New on register (incorporations)", "Dissolved / removed", "Status changed" ] }, "default": [ "new", "dissolved", "statusChanged" ] }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "SIC 2007 codes or prefixes, e.g. 62020 or 62 (all IT). A company matches if any of its SIC codes starts with any value.", "items": { "type": "string" } }, "postcodePrefixes": { "title": "Postcode prefixes", "type": "array", "description": "Registered-office postcode prefixes, e.g. EC1, SW1A, M1. Spaces and case are ignored. Note: 'M1' also matches M11-M19; add the space-free outward code plus a digit (e.g. 'M14') for precision.", "items": { "type": "string" } }, "companyStatuses": { "title": "Company status", "type": "array", "description": "Exact status values, e.g. Active, Liquidation, In Administration, Active - Proposal to Strike off. Case-insensitive. In monthlyDiff it applies to the latest status (not to removed companies).", "items": { "type": "string" } }, "companyTypes": { "title": "Company type", "type": "array", "description": "Exact Companies House categories, e.g. Private Limited Company, Public Limited Company, Limited Liability Partnership, Community Interest Company. Case-insensitive.", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "YYYY-MM-DD, inclusive." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "YYYY-MM-DD, inclusive." }, "snapshotDate": { "title": "Snapshot date (optional)", "pattern": "^(\\d{4}-\\d{2}-01)?$", "type": "string", "description": "Advanced. Monthly snapshot to use as 'latest' (YYYY-MM-01). Empty = newest published. Companies House only keeps recent months online." }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum companies to return.", "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 } } } } } } } } } }