{ "openapi": "3.0.1", "info": { "title": "UK Companies House API – Company Search, SIC & Filings", "description": "UK company data from the official Companies House API with your own free key: profiles by number or URL, name search, advanced search by SIC code, incorporation date, status and location, due dates, risk flags, filing history. Company-level only. $1.50 per 1k.", "version": "1.0", "x-build-id": "JYIu6sP7edVK5H6b4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pinkish_armada~companies-house-uk/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pinkish_armada-companies-house-uk", "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/pinkish_armada~companies-house-uk/runs": { "post": { "operationId": "runs-sync-pinkish_armada-companies-house-uk", "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/pinkish_armada~companies-house-uk/run-sync": { "post": { "operationId": "run-sync-pinkish_armada-companies-house-uk", "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": { "companiesHouseApiKey": { "title": "Companies House REST API key", "type": "string", "description": "Your own free Companies House REST API key. Register at https://developer.company-information.service.gov.uk/, create an application and add a REST API key (live). Used only inside your run, never stored. Without a key nothing is fetched or charged." }, "companies": { "title": "Company numbers or URLs", "type": "array", "description": "Companies House company numbers (e.g. 00445790, SC123456) or company page URLs. Each returns the full company profile.", "items": { "type": "string" } }, "searchTerms": { "title": "Search by company name", "type": "array", "description": "Company names or keywords, ranked like the Companies House search.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max results per name search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many ranked companies to take from each name search.", "default": 20 }, "sicCodes": { "title": "SIC codes (advanced search)", "type": "array", "description": "SIC 2007 codes, e.g. 62012 (software development), 56101 (restaurants), 68209 (letting). Combine with the other advanced filters to build lists of companies by industry.", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "YYYY-MM-DD. Find newly incorporated companies, e.g. 2026-10-01." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "YYYY-MM-DD." }, "companyStatus": { "title": "Company status", "type": "array", "description": "Only companies with these statuses.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "administration", "receivership", "insolvency-proceedings", "voluntary-arrangement", "converted-closed", "open", "closed", "registered", "removed" ] } }, "companyType": { "title": "Company type", "type": "array", "description": "Companies House type codes, e.g. ltd, plc, llp, private-limited-guarant-nsc, scottish-partnership.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Registered office town, city or postcode area, e.g. Manchester or BS1." }, "nameIncludes": { "title": "Company name includes", "type": "string", "description": "Only companies whose name contains this text." }, "dissolvedFrom": { "title": "Dissolved from", "type": "string", "description": "YYYY-MM-DD (use with status dissolved)." }, "dissolvedTo": { "title": "Dissolved to", "type": "string", "description": "YYYY-MM-DD." }, "maxAdvancedResults": { "title": "Max advanced-search results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum companies from the advanced search (Companies House returns at most 5,000 per query; narrow the filters for more).", "default": 100 }, "includeFullProfile": { "title": "Full profile for search results", "type": "boolean", "description": "On: every search result gets the full profile (accounts and confirmation-statement dates, charges/insolvency flags, previous names) at the company price. Off: the search fields only (name, number, status, type, dates, SIC, address) at the lower basic price, much faster.", "default": true }, "includeFilingHistory": { "title": "Include filing history", "type": "boolean", "description": "Add the newest filings (date, form type, category, description, document link) to each full company row. Charged per filing.", "default": false }, "maxFilingsPerCompany": { "title": "Filings per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "Newest filings to include per company.", "default": 10 }, "filingCategory": { "title": "Filing category", "enum": [ "", "accounts", "confirmation-statement", "annual-return", "incorporation", "change-of-name", "capital", "mortgage", "address", "resolution", "liquidation", "insolvency", "dissolution", "miscellaneous" ], "type": "string", "description": "Only filings of this category.", "default": "" } } }, "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 } } } } } } } } } }