{ "openapi": "3.0.1", "info": { "title": "UK Companies House Register and New Companies", "description": "Download UK companies from the Companies House register: number, name, status, type, SIC codes, registered office address and filing dates. Filter by SIC code, postcode area, status and incorporation date. Get new companies each month. No API key.", "version": "0.1", "x-build-id": "wy74uXW4H6Tyi8Yq7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maliksaid~uk-companies-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maliksaid-uk-companies-register", "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/maliksaid~uk-companies-register/runs": { "post": { "operationId": "runs-sync-maliksaid-uk-companies-register", "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/maliksaid~uk-companies-register/run-sync": { "post": { "operationId": "run-sync-maliksaid-uk-companies-register", "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": { "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Optional. Look up these companies by number, for example 00445790 or SC123456. Short numbers are padded with zeros. The run stops once every number is found. A number that is missing (for example a dissolved company) makes the run read the whole file. Other filters still apply, so clear them for a plain lookup.", "default": [], "items": { "type": "string" } }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Keep companies with at least one SIC code that starts with one of these digits. Use 2 digits for a division (62 = computer programming and IT), or a full 5-digit code (62020). Leave empty for every industry.", "default": [], "items": { "type": "string" } }, "sicKeywords": { "title": "SIC description words", "type": "array", "description": "Keep companies with a SIC description that has one of these words, for example dental or software. Whole words, any case.", "default": [], "items": { "type": "string" } }, "postcodeAreas": { "title": "Postcode areas", "type": "array", "description": "Keep companies whose registered office is in one of these postcode areas or districts. Letters only match an area (M = Manchester, EC = London EC). With digits it matches a district (SW1A) or a full postcode. Leave empty for the whole UK.", "default": [], "items": { "type": "string" } }, "postTowns": { "title": "Post towns", "type": "array", "description": "Keep companies whose registered office post town is one of these, for example LEEDS. Any case.", "default": [], "items": { "type": "string" } }, "companyStatuses": { "title": "Company status", "type": "array", "description": "Keep companies with one of these statuses. The file holds live companies only. Leave empty for every status.", "items": { "type": "string", "enum": [ "Active", "Active - Proposal to Strike off", "Liquidation", "In Administration", "Live but Receiver Manager on at least one charge", "Voluntary Arrangement", "In Administration/Administrative Receiver", "RECEIVERSHIP", "ADMINISTRATION ORDER", "ADMINISTRATIVE RECEIVER", "In Administration/Receiver Manager", "RECEIVER MANAGER / ADMINISTRATIVE RECEIVER" ] }, "default": [] }, "companyTypes": { "title": "Company types", "type": "array", "description": "Keep companies whose type contains one of these words, for example Private Limited Company, Limited Liability Partnership, Community Interest Company or Public Limited Company. Case does not matter. Leave empty for every type.", "default": [], "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated on or after", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Keep companies incorporated on or after this date (yyyy-mm-dd)." }, "incorporatedTo": { "title": "Incorporated on or before", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Keep companies incorporated on or before this date (yyyy-mm-dd)." }, "newIncorporationsOnly": { "title": "New incorporations in the latest month", "type": "boolean", "description": "Keep only companies incorporated in the month the latest file covers. The file published in early October covers September. Schedule the Actor monthly with this on.", "default": false }, "onlyOverdue": { "title": "Overdue filings", "enum": [ "off", "accounts", "confirmationStatement", "either" ], "type": "string", "description": "Keep only companies whose next accounts or confirmation statement was due before the file date. Off keeps every company. Skipped companies are not charged.", "default": "off" }, "nameKeywords": { "title": "Company name keywords", "type": "array", "description": "Keep companies whose current or previous name contains one of these words. Whole words only. Leave empty to keep every name.", "default": [], "items": { "type": "string" } }, "nameExcludeKeywords": { "title": "Exclude name words", "type": "array", "description": "Drop companies whose current name has one of these words, for example holdings. Whole words, any case.", "default": [], "items": { "type": "string" } }, "monitorMode": { "title": "Monitor mode (only new companies)", "type": "boolean", "description": "Return only companies that earlier monitor-mode runs with the same state key did not return. If the same monthly file was already read in full with the same filters, the run ends at once and costs only the start fee.", "default": false }, "stateKey": { "title": "Monitor state key", "type": "string", "description": "Name of the memory that monitor mode uses. Use a different key for each separate watch list.", "default": "default" }, "maxItems": { "title": "Maximum companies", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Stop after saving this many companies. One run saves at most 50,000. Set 0 to use that cap.", "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 } } } } } } } } } }