{ "openapi": "3.0.1", "info": { "title": "UK Companies House Company Data Scraper", "description": "Search UK Companies House and export clean company data: profile, officers/directors, beneficial owners (PSC) and filings. For KYC, due diligence and B2B lead enrichment.", "version": "0.1", "x-build-id": "3SYc0GSlxJdA2EKNt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/straightforward_hydra~companies-house-uk-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-straightforward_hydra-companies-house-uk-scraper", "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/straightforward_hydra~companies-house-uk-scraper/runs": { "post": { "operationId": "runs-sync-straightforward_hydra-companies-house-uk-scraper", "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/straightforward_hydra~companies-house-uk-scraper/run-sync": { "post": { "operationId": "run-sync-straightforward_hydra-companies-house-uk-scraper", "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", "required": [ "apiKey" ], "properties": { "apiKey": { "title": "Companies House API key", "type": "string", "description": "Your free Companies House REST API key. Register at developer.company-information.service.gov.uk (available worldwide), create an application, and copy the key. Required. Only sent to Companies House." }, "searchQuery": { "title": "Company name contains", "type": "string", "description": "Find companies whose name includes this text, e.g. \"solar\" or \"consulting\". Combine with the filters below to narrow results." }, "companyNumbers": { "title": "Company numbers (direct lookup)", "type": "array", "description": "Look up specific companies by their Companies House number, e.g. 00445790. When set, the search filters are ignored.", "items": { "type": "string" } }, "companyStatus": { "title": "Company status", "type": "array", "description": "Filter by status. Leave empty for all.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "administration", "receivership", "open", "closed" ], "enumTitles": [ "Active", "Dissolved", "Liquidation", "Administration", "Receivership", "Open", "Closed" ] } }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Filter by SIC industry codes, e.g. 62012 (business software development), 35110 (electricity production). Leave empty for all.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Filter by registered office location, e.g. \"London\", \"Manchester\". Leave empty for all." }, "incorporatedFrom": { "title": "Incorporated from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only companies incorporated on/after this date. Format YYYY-MM-DD." }, "incorporatedTo": { "title": "Incorporated to", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only companies incorporated on/before this date. Format YYYY-MM-DD." }, "includeOfficers": { "title": "Include officers (directors)", "type": "boolean", "description": "Fetch the officers/directors for each company (one extra request per company).", "default": true }, "includePsc": { "title": "Include persons with significant control", "type": "boolean", "description": "Fetch the beneficial owners (PSC) for each company (one extra request per company).", "default": false }, "includeFilingHistory": { "title": "Include recent filings", "type": "boolean", "description": "Fetch the most recent filing-history entries for each company (one extra request per company).", "default": false }, "maxCompanies": { "title": "Max companies", "minimum": 1, "type": "integer", "description": "Stop after this many companies. Leave empty for no limit. Note: enrichment adds one request per company, and the API allows ~600 requests per 5 minutes.", "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 } } }, "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 } } } } } } } } } }