{ "openapi": "3.0.1", "info": { "title": "Companies House Data API: UK Company Register", "description": "Companies House data for 5M+ UK companies: search the official register by SIC code, status, location and incorporation date. Returns company number, name, registered address, accounts, mortgages, SIC codes and previous names as JSON. Open Government Licence v3.0.", "version": "0.1", "x-build-id": "OWLRit0vTHq6uH1Xb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/smoked_drift~uk-companies-house-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-smoked_drift-uk-companies-house-data", "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/smoked_drift~uk-companies-house-data/runs": { "post": { "operationId": "runs-sync-smoked_drift-uk-companies-house-data", "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/smoked_drift~uk-companies-house-data/run-sync": { "post": { "operationId": "run-sync-smoked_drift-uk-companies-house-data", "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": "UK SIC 2007 codes, e.g. 62020 for IT consultancy, 68209 for letting of real estate. A company matches if any of its four SIC codes is listed here.", "items": { "type": "string" } }, "sicText": { "title": "SIC description contains", "type": "string", "description": "Free-text match against the SIC description instead of the code, e.g. 'consultancy' or 'software'." }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Look up specific companies by their Companies House number, e.g. 08209948. Fastest path: no filtering needed beyond this.", "items": { "type": "string" } }, "status": { "title": "Company status", "type": "array", "description": "Register status values. Leave empty for all. 'Active' is the one you usually want for prospecting.", "items": { "type": "string" } }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Shortcut for status = Active. Ignored when 'Company status' is set.", "default": true }, "category": { "title": "Company type", "type": "array", "description": "Legal form, e.g. 'Private Limited Company', 'PLC', 'LLP', 'Limited Partnership'.", "items": { "type": "string" } }, "postcodePrefix": { "title": "Postcode starts with", "type": "string", "description": "Registered address postcode prefix, e.g. 'EC1', 'M', 'BS3'. Spaces are ignored. A cheap way to search a city or region." }, "postTown": { "title": "Town contains", "type": "string", "description": "Match on the registered address town, e.g. 'Manchester'." }, "nameContains": { "title": "Company name contains", "type": "string", "description": "Case-insensitive substring match on the company name." }, "incorporatedAfter": { "title": "Incorporated on or after", "type": "string", "description": "ISO date, e.g. 2026-01-01. Useful for finding newly formed companies." }, "incorporatedBefore": { "title": "Incorporated on or before", "type": "string", "description": "ISO date, e.g. 2026-09-01." }, "hasPreviousNames": { "title": "Has previous names", "type": "boolean", "description": "Set to true to return only companies that have traded under another name. Leave unchecked to ignore. Renamed companies are a useful signal in due diligence." }, "maxItems": { "title": "Maximum companies", "minimum": 1, "type": "integer", "description": "Hard cap on returned companies. The register holds over 5 million, so keep this explicit. A run that scans the register costs the same either way.", "default": 1000 } } }, "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 } } } } } } } } } }