{ "openapi": "3.0.1", "info": { "title": "UK Companies House Search: Profiles, Directors, PSCs, Filings", "description": "Look up UK companies on the official Companies House API by number, name or filters (SIC code, location, incorporation date): status, registered office, SIC codes, accounts and confirmation dates, directors, PSCs (owners), filing history and charges. New-company lead lists. OGL data.", "version": "1.0", "x-build-id": "ZaOjnPTCEp6Ob7fDK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mercury_ops~uk-companies-house-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mercury_ops-uk-companies-house-search", "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/mercury_ops~uk-companies-house-search/runs": { "post": { "operationId": "runs-sync-mercury_ops-uk-companies-house-search", "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/mercury_ops~uk-companies-house-search/run-sync": { "post": { "operationId": "run-sync-mercury_ops-uk-companies-house-search", "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": "One per line: company numbers (00445790, SC123456, OC301234) or Companies House URLs. Short numbers are zero-padded.", "items": { "type": "string" } }, "searchTerms": { "title": "Company name search", "type": "array", "description": "Company names to search (like the Companies House search box). The top matches per term are fetched.", "items": { "type": "string" } }, "maxResultsPerSearchTerm": { "title": "Results per name search", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many matches to keep per search term (1-100).", "default": 5 }, "sicCodes": { "title": "Advanced search: SIC codes", "type": "array", "description": "Find companies by nature of business, e.g. 62012 (business software), 56101 (restaurants), 68209 (letting). Combine with location and incorporation dates for lead lists.", "items": { "type": "string" } }, "location": { "title": "Advanced search: location", "type": "string", "description": "Town, city or postcode text matched against the registered office address, e.g. 'Manchester' or 'BS1'." }, "nameIncludes": { "title": "Advanced search: name includes", "type": "string", "description": "Only companies whose name includes this text." }, "incorporatedInLastDays": { "title": "Advanced search: incorporated in the last N days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "E.g. 7 for companies registered in the past week. Overrides 'Incorporated from'. Schedule daily with 1-2 days for a new-company feed." }, "incorporatedFrom": { "title": "Advanced search: incorporated from", "type": "string", "description": "YYYY-MM-DD." }, "incorporatedTo": { "title": "Advanced search: incorporated to", "type": "string", "description": "YYYY-MM-DD." }, "companyStatus": { "title": "Advanced search: company status", "type": "array", "description": "Leave empty for all.", "items": { "type": "string", "enum": [ "active", "dissolved", "open", "closed", "converted-closed", "receivership", "administration", "liquidation", "insolvency-proceedings", "voluntary-arrangement", "registered", "removed" ] } }, "companyType": { "title": "Advanced search: company type", "type": "array", "description": "Leave empty for all.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-unlimited", "limited-partnership", "scottish-partnership", "charitable-incorporated-organisation", "royal-charter", "registered-society-non-jurisdictional", "oversea-company", "uk-establishment" ], "enumTitles": [ "Private limited (Ltd)", "Public limited (PLC)", "LLP", "Private limited by guarantee", "Private limited by guarantee (exempt from 'Limited')", "Private unlimited", "Limited partnership", "Scottish partnership", "Charitable incorporated organisation", "Royal charter", "Registered society", "Overseas company", "UK establishment" ] } }, "maxCompanies": { "title": "Max companies", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Cap on companies output per run. Up to 1,000 on the Actor's shared key (fair use), 10,000 with your own key. With 'Search results only' up to 10,000.", "default": 100 }, "searchResultsOnly": { "title": "Search results only (fast, cheapest)", "type": "boolean", "description": "For name/advanced searches, output the search row (name, number, status, type, SIC, address, incorporation date) without fetching each profile. Company numbers you list are always fully fetched.", "default": false }, "includeOfficers": { "title": "Officers (directors, secretaries)", "type": "boolean", "description": "Names, role, appointment dates, occupation, nationality, country of residence. Addresses are never output.", "default": true }, "includeResignedOfficers": { "title": "Include resigned officers and ceased PSCs", "type": "boolean", "description": "Off = current officers and PSCs only.", "default": false }, "includePscs": { "title": "Persons with significant control (owners)", "type": "boolean", "description": "Name, kind, nature of control (share/vote bands), notified/ceased dates.", "default": true }, "includeFilingHistory": { "title": "Filing history", "type": "boolean", "description": "Latest filings with plain-English descriptions and document links.", "default": true }, "filingHistoryLimit": { "title": "Filings per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "1-100, newest first.", "default": 10 }, "includeCharges": { "title": "Charges (mortgages, debentures)", "type": "boolean", "description": "Charges with status, lender (persons entitled), dates.", "default": false }, "includeBirthMonthYear": { "title": "Include officer/PSC birth month and year", "type": "boolean", "description": "Public on the register, but personal data: only switch on if you have a lawful basis (e.g. identity matching for KYC). Off by default.", "default": false }, "apiKey": { "title": "Your Companies House API key (optional)", "type": "string", "description": "Optional. Runs use the Actor's own key by default (shared, fair-use paced). For large or frequent runs add your own free REST API key from developer.company-information.service.gov.uk: it gets its own 600 requests / 5 min and higher caps. Stored encrypted; never logged or output." } } }, "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 } } } } } } } } } }