{ "openapi": "3.0.1", "info": { "title": "UK Company Register (Companies House bulk data)", "description": "All live UK companies from the official Companies House monthly snapshot: filter by SIC code, postcode, town, status, type, incorporation date. No API key, no proxy, no officers.", "version": "0.1", "x-build-id": "ONyhXZoDeZdIn3XYQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/delfielectronics~uk-company-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-delfielectronics-uk-company-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/delfielectronics~uk-company-register/runs": { "post": { "operationId": "runs-sync-delfielectronics-uk-company-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/delfielectronics~uk-company-register/run-sync": { "post": { "operationId": "run-sync-delfielectronics-uk-company-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": { "sicCodes": { "title": "SIC codes", "type": "array", "description": "Keep companies with any of their (up to 4) SIC codes starting with these 1-5 digits (e.g. 62 = IT and computer programming, 4110 = property development, 56101 = restaurants). Empty = all.", "default": [], "items": { "type": "string" } }, "postcodePrefixes": { "title": "Postcodes", "type": "array", "description": "Registered office postcode: an area (letters only, e.g. M = Manchester, not ME), a district (outward code, e.g. M1, not M14) or a sector or longer prefix after the space (e.g. EC1A 1). Empty = everywhere.", "default": [], "items": { "type": "string" } }, "postTowns": { "title": "Post towns", "type": "array", "description": "Registered office post town, exact (case and accents ignored, e.g. Leeds). Empty = all.", "default": [], "items": { "type": "string" } }, "statuses": { "title": "Company statuses", "type": "array", "description": "Keep companies with these statuses. Empty = all live companies (the snapshot holds no dissolved ones).", "items": { "type": "string", "enum": [ "Active", "Active - Proposal to Strike off", "Liquidation", "In Administration", "Live but Receiver Manager on at least one charge", "In Administration/Administrative Receiver", "Voluntary Arrangement", "RECEIVERSHIP", "ADMINISTRATIVE RECEIVER", "In Administration/Receiver Manager", "ADMINISTRATION ORDER", "RECEIVER MANAGER / ADMINISTRATIVE RECEIVER", "VOLUNTARY ARRANGEMENT / ADMINISTRATIVE RECEIVER", "VOLUNTARY ARRANGEMENT / RECEIVER MANAGER" ] }, "default": [ "Active" ] }, "categories": { "title": "Company types", "type": "array", "description": "Keep these company types (as published by Companies House). Empty = all.", "items": { "type": "string", "enum": [ "Private Limited Company", "PRI/LTD BY GUAR/NSC (Private, limited by guarantee, no share capital)", "Community Interest Company", "Limited Partnership", "Charitable Incorporated Organisation", "Limited Liability Partnership", "PRI/LBG/NSC (Private, Limited by guarantee, no share capital, use of 'Limited' exemption)", "Overseas Entity", "Other company type", "Registered Society", "Scottish Charitable Incorporated Organisation", "Private Unlimited Company", "Public Limited Company", "Royal Charter Company", "Investment Company with Variable Capital", "Scottish Partnership", "United Kingdom Economic Interest Grouping", "Private Unlimited", "Industrial and Provident Society", "Investment Company with Variable Capital(Umbrella)", "United Kingdom Societas", "Old Public Company", "PRIV LTD SECT. 30 (Private limited company, section 30 of the Companies Act)", "Investment Company with Variable Capital (Securities)", "Other Company Type", "Further Education and Sixth Form College Corps", "Protected Cell Company", "Converted/Closed" ] }, "default": [] }, "incorporatedWithinDays": { "title": "Incorporated in the last N days", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Companies incorporated on the last day of the window and the N days before it; the window ends on 'Incorporated to', else on the snapshot date (the snapshot is published monthly). 0 = no lower limit. Ignored when 'Incorporated from' is set.", "default": 0 }, "incorporatedFrom": { "title": "Incorporated from", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "First incorporation date to keep (YYYY-MM-DD). Overrides 'Incorporated in the last N days'." }, "incorporatedTo": { "title": "Incorporated to", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Last incorporation date to keep (YYYY-MM-DD). Empty = no upper limit." }, "keywords": { "title": "Name keywords", "type": "array", "description": "Keep companies whose current name contains any of these whole words or phrases (case and accents ignored, e.g. solar, property management). Empty = all.", "default": [], "items": { "type": "string" } }, "includePreviousNames": { "title": "Include previous names", "type": "boolean", "description": "Add the company's previous names with the dates they changed.", "default": true }, "onlyNew": { "title": "Only companies not returned before", "type": "boolean", "description": "Return only companies this actor has not returned to you before under the same memory name and filters (memory kept 400 days): run it monthly for new-company leads.", "default": false }, "stateKey": { "title": "Memory name", "pattern": "^[A-Za-z0-9_-]{1,50}$", "type": "string", "description": "Name of the 'Only companies not returned before' memory (1-50 letters, digits, - or _). Use different names for separate lead feeds.", "default": "default" }, "maxItems": { "title": "Max companies", "minimum": 1, "maximum": 10000000, "type": "integer", "description": "Stop after saving this many companies; the remaining file parts are then neither downloaded nor charged. The form starts at 100 for a cheap first run; the API default is 100000.", "default": 100000 } } }, "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 } } } } } } } } } }