{ "openapi": "3.0.1", "info": { "title": "UK Companies House Lookup - Company, Officers, PSC & Filings", "description": "Look up UK companies by number or name using the official Companies House API. Get status, SIC codes, accounts dates, officers, persons with significant control and recent filings as clean JSON. Pay only per company returned.", "version": "0.0", "x-build-id": "SqKtVNyg8NnZiK2CQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rootcause-data~uk-companies-house-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rootcause-data-uk-companies-house-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/rootcause-data~uk-companies-house-lookup/runs": { "post": { "operationId": "runs-sync-rootcause-data-uk-companies-house-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/rootcause-data~uk-companies-house-lookup/run-sync": { "post": { "operationId": "run-sync-rootcause-data-uk-companies-house-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": { "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Companies House company numbers (e.g. 00000006, SC123456). Purely numeric values shorter than 8 digits are zero-padded. Duplicates are removed.", "items": { "type": "string" } }, "searchQueries": { "title": "Company name searches", "type": "array", "description": "Company-name search terms. Each term returns the top results (see 'Max companies per search').", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max companies per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum companies returned for each search term.", "default": 20 }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Add directors, secretaries and other officers (current and resigned). Billed per officer.", "default": true }, "includePsc": { "title": "Include PSC (persons with significant control)", "type": "boolean", "description": "Add the persons-with-significant-control register. Billed per PSC.", "default": false }, "includeFilingHistory": { "title": "Include filing history", "type": "boolean", "description": "Add the most recent filings. Billed per filing.", "default": false }, "filingHistoryLimit": { "title": "Filings per company", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum recent filings per company.", "default": 10 }, "includeOfficerBirthMonth": { "title": "Include officer birth month and year", "type": "boolean", "description": "Off by default (personal data, UK GDPR). Companies House publishes month and year only, never the day. Enable only if you have a lawful basis.", "default": false }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Skip dissolved, closed, removed and converted-closed companies.", "default": false }, "apiKey": { "title": "Your Companies House API key", "type": "string", "description": "Needed for real data. Free from developer.company-information.service.gov.uk (register an application, then create a REST key). Without a key the run returns one example row (marked demo, no company charge). Stored encrypted. Rate limit: 600 requests / 5 minutes per key." } } }, "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 } } } } } } } } } }