{ "openapi": "3.0.1", "info": { "title": "UK Company Lookup - Companies House API (No Personal Data)", "description": "Bulk-check UK companies by number or name via the official Companies House API: status, type, dates, registered office, SIC codes with descriptions, accounts and confirmation-statement due/overdue, optional filing history. Company data only - no directors or PSC personal data.", "version": "1.0", "x-build-id": "hRw2rcJI6VZbE8clG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shelly_fen~uk-company-lookup-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shelly_fen-uk-company-lookup-companies-house", "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/shelly_fen~uk-company-lookup-companies-house/runs": { "post": { "operationId": "runs-sync-shelly_fen-uk-company-lookup-companies-house", "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/shelly_fen~uk-company-lookup-companies-house/run-sync": { "post": { "operationId": "run-sync-shelly_fen-uk-company-lookup-companies-house", "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": "Companies House numbers, e.g. 00445790, SC012345, OC301540. Leading zeros optional (445790 works).", "items": { "type": "string" } }, "searchQueries": { "title": "Company names to search", "type": "array", "description": "Name searches using the official Companies House search. Each match becomes one full company record.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max matches per name search", "minimum": 1, "maximum": 100, "type": "integer", "description": "Top matches per name (Companies House relevance order). Each match is one charged company record.", "default": 5 }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Skip dissolved, liquidation and other non-active companies.", "default": false }, "currentNameMatchOnly": { "title": "Current-name matches only", "type": "boolean", "description": "Companies House search also matches previous names. Turn on to keep only companies whose current name contains every word you searched. Each row also carries matchedOn = currentName / previousNameOrOther.", "default": false }, "includeFilingHistory": { "title": "Add filing history summary (add-on)", "type": "boolean", "description": "Adds the latest filings (date, form type, category, plain-English description). Names of directors/PSCs inside filing descriptions are replaced with [omitted]. Charged as a separate small event.", "default": false }, "filingHistoryCount": { "title": "Filings per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many latest filings to include when the add-on is on.", "default": 10 }, "maxCompanies": { "title": "Max companies per run", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Safety cap on company records per run.", "default": 1000 }, "apiKey": { "title": "Your own Companies House API key (optional)", "type": "string", "description": "Optional. Leave empty to use the Actor's key. With your own free REST API key (developer.company-information.service.gov.uk) your runs get your own 600 requests / 5 min quota, which is faster for large batches." }, "maxRequestsPer5Min": { "title": "Max API requests per 5 minutes", "minimum": 10, "maximum": 600, "type": "integer", "description": "Throttle. Companies House allows 600 per 5 minutes per key. When the Actor's shared key is used, runs are capped at 300.", "default": 500 } } }, "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 } } } } } } } } } }