{ "openapi": "3.0.1", "info": { "title": "UK Companies House Company Lookup - Official API, No PII", "description": "UK company data from the official Companies House API (your free key): status, SIC codes, accounts and confirmation-statement due dates with overdue flags, optional filings. No officers/PSC. $0.00297/company, no start fee. Built with AI assistance.", "version": "1.0", "x-build-id": "cSrV5V9Dn8lPDWynB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/digivibetech~uk-companies-house-company-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-digivibetech-uk-companies-house-company-lookup", "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/digivibetech~uk-companies-house-company-lookup/runs": { "post": { "operationId": "runs-sync-digivibetech-uk-companies-house-company-lookup", "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/digivibetech~uk-companies-house-company-lookup/run-sync": { "post": { "operationId": "run-sync-digivibetech-uk-companies-house-company-lookup", "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": { "apiKey": { "title": "Companies House REST API key (free)", "type": "string", "description": "Your own free key from developer.company-information.service.gov.uk (Register an application -> Create new key -> REST, live). Stored encrypted by Apify, sent only to api.company-information.service.gov.uk, never logged. Without a key the actor returns 1 free sample record so you can see the output." }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "UK company numbers, e.g. 00000006, SC123456, OC301540. Spaces are removed and short numbers padded (6 -> 00000006). Invalid entries are listed in ERRORS and never charged.", "items": { "type": "string" } }, "searchQueries": { "title": "Search by company name", "type": "array", "description": "Company names or keywords (Companies House company search). Each matching company is looked up in full; duplicates with the numbers above are removed.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max companies per search query", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many search results (best matches first) to look up per query.", "default": 10 }, "activeOnly": { "title": "Search: active companies only", "type": "boolean", "description": "Skip dissolved/closed companies from search results (company numbers you list yourself are always looked up).", "default": false }, "includeFilingHistory": { "title": "Include filing history", "type": "boolean", "description": "Add the most recent filings (date, category, form type, readable description, PDF link). One extra API call per company; charged $0.00049 per company only when filings are returned. Person names are masked as [person].", "default": false }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "Newest filings to include per company (one API call, up to 100).", "default": 25 }, "filingCategories": { "title": "Filing categories (optional)", "type": "array", "description": "Only these categories, e.g. accounts, confirmation-statement, address, capital, incorporation, mortgage, change-of-name, liquidation, resolution. Empty = all.", "items": { "type": "string" } }, "maxCompanies": { "title": "Max companies per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Safety cap on companies looked up (each costs $0.00297). At 1 request per second, 100 companies take about 2 minutes (4 with filings).", "default": 100 } } }, "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 } } } } } } } } } }