{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper - Search, Profiles & Filings", "description": "Company search, profiles, filing history, charges and SIC/incorporation-date filters from the UK Companies House official public API.", "version": "0.1", "x-build-id": "8jabXIlJ2xfkOTn2v" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bridged~uk-companies-house-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bridged-uk-companies-house-api", "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/bridged~uk-companies-house-api/runs": { "post": { "operationId": "runs-sync-bridged-uk-companies-house-api", "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/bridged~uk-companies-house-api/run-sync": { "post": { "operationId": "run-sync-bridged-uk-companies-house-api", "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", "required": [ "mode" ], "properties": { "apiKey": { "title": "Companies House API key", "type": "string", "description": "Required. Get a free key at developer.company-information.service.gov.uk (instant, no approval wait). Companies House has no public/shared key option." }, "mode": { "title": "Mode", "enum": [ "search", "advancedSearch", "lookup" ], "type": "string", "description": "search: free-text company name search. advancedSearch: filter by SIC code, incorporation date, status, location. lookup: fetch specific companies by number.", "default": "advancedSearch" }, "queries": { "title": "Search queries", "type": "array", "description": "Free-text company names (mode=search).", "items": { "type": "string" } }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "8-character Companies House company numbers, or Companies House URLs (mode=lookup).", "items": { "type": "string" } }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "e.g. [\"62012\"] for computer programming activities (mode=advancedSearch).", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "ISO date, e.g. 2020-01-01 (mode=advancedSearch)." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "ISO date, e.g. 2026-01-01 (mode=advancedSearch)." }, "companyStatus": { "title": "Company status", "type": "array", "description": "e.g. [\"active\"]. One or more of: active, dissolved, liquidation, receivership, administration, voluntary-arrangement, converted-closed, insolvency-proceedings, registered, removed, open.", "default": [ "active" ], "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Town or postcode prefix to filter registered address (mode=advancedSearch)." }, "includeFilingHistory": { "title": "Include filing history", "type": "boolean", "description": "Fetch and attach recent filing history per company (extra API call per company).", "default": false }, "includeCharges": { "title": "Include charges", "type": "boolean", "description": "Fetch and attach registered charges per company (extra API call per company).", "default": false }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Off by default: officer/PSC names, month/year of birth and correspondence addresses are personal data under UK GDPR. Enable only with your own lawful basis for processing it.", "default": false }, "maxResults": { "title": "Max results", "type": "integer", "description": "Stop after this many companies.", "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 } } } } } } } } } }