{ "openapi": "3.0.1", "info": { "title": "Companies House Scraper & API — UK Companies, Officers, Filings", "description": "Look up UK companies by name, company number or filters and get company profiles, directors and other officers, persons with significant control and filing history as flat rows, ready for KYB checks, B2B lead lists and credit research.", "version": "0.1", "x-build-id": "villJgkdegDZyfahN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~companies-house-uk/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-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/s-r~companies-house-uk/runs": { "post": { "operationId": "runs-sync-s-r-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/s-r~companies-house-uk/run-sync": { "post": { "operationId": "run-sync-s-r-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": { "company_numbers": { "title": "Company numbers", "type": "array", "description": "Companies House numbers. Numeric numbers are padded to eight digits; duplicates are fetched once.", "items": { "type": "string" } }, "search_queries": { "title": "Search queries", "type": "array", "description": "Company name searches, including previous names. max_results applies to each query.", "items": { "type": "string" } }, "sic_codes": { "title": "Sic codes", "type": "array", "description": "Five-digit UK SIC codes for advanced search.", "items": { "type": "string" } }, "location": { "title": "Location", "maxLength": 200, "type": "string", "description": "Registered office address text for advanced search." }, "company_status": { "title": "Company status", "enum": [ "active", "dissolved", "liquidation", "administration", "receivership", "voluntary-arrangement", "insolvency-proceedings" ], "type": "string", "description": "Company status filter for advanced search." }, "incorporated_from": { "title": "Incorporated from", "type": "string", "description": "Earliest incorporation date, inclusive, in YYYY-MM-DD format." }, "incorporated_to": { "title": "Incorporated to", "type": "string", "description": "Latest incorporation date, inclusive, in YYYY-MM-DD format." }, "max_results": { "title": "Max results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum company matches per name search or advanced filter set. Does not limit company_numbers or section rows.", "default": 20 }, "include_officers": { "title": "Include officers", "type": "boolean", "description": "Emit separate officer rows with role, dates, nationality and birth year when disclosed.", "default": false }, "officers_status": { "title": "Officers status", "enum": [ "all", "active" ], "type": "string", "description": "all includes historical officers; active filters the source records locally.", "default": "all" }, "max_officers_per_company": { "title": "Max officers per company", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum delivered appointment rows per company. Active filtering may require more source pages.", "default": 35 }, "include_filings": { "title": "Include filings", "type": "boolean", "description": "Emit filing history records with stable public document links.", "default": false }, "max_filings_per_company": { "title": "Max filings per company", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum filing records per company, newest first.", "default": 25 }, "include_psc": { "title": "Include psc", "type": "boolean", "description": "Emit persons with significant control as officer rows. Exempt companies produce a warning.", "default": false }, "include_lei": { "title": "Include lei", "type": "boolean", "description": "Look up the LEI using the company number and GB legal address in GLEIF. No match omits lei.", "default": true } } }, "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 } } } } } } } } } }