{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper: Directors, Leads & Emails", "description": "Scrape the UK Companies House register by SIC code, location, incorporation date and status. Get company profiles, directors and officers, and optionally the website, emails and phones. No 10,000-result cap. Monitor new incorporations and changes.", "version": "1.0", "x-build-id": "93XAizB8fumexGxTN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/euroscrape~uk-companies/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-euroscrape-uk-companies", "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/euroscrape~uk-companies/runs": { "post": { "operationId": "runs-sync-euroscrape-uk-companies", "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/euroscrape~uk-companies/run-sync": { "post": { "operationId": "run-sync-euroscrape-uk-companies", "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": { "sicCodes": { "title": "🏭 SIC codes (industry)", "type": "array", "description": "5-digit UK SIC 2007 codes, e.g. 43220 (plumbing & heating), 62020 (IT consultancy), 56101 (restaurants). Each code is searched separately and results are merged.", "items": { "type": "string" } }, "location": { "title": "πŸ“ Location (registered office)", "type": "string", "description": "Town, county or postcode in the registered office address, e.g. \"Leeds\", \"Manchester\", \"SW1\"." }, "companyNameIncludes": { "title": "Company name contains", "type": "string", "description": "Optional word(s) the company name must contain." }, "companyNameExcludes": { "title": "Company name excludes", "type": "string", "description": "Optional word(s) to exclude from company names." }, "incorporatedInLastDays": { "title": "πŸ†• Incorporated in the last N days", "minimum": 1, "type": "integer", "description": "Shortcut for new-business feeds, e.g. 7. Overrides \"Incorporated from\"." }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "YYYY-MM-DD." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "YYYY-MM-DD." }, "dissolvedFrom": { "title": "Dissolved from", "type": "string", "description": "Only for dissolved companies." }, "dissolvedTo": { "title": "Dissolved to", "type": "string", "description": "Only for dissolved companies." }, "statuses": { "title": "Company status", "type": "array", "description": "Default: active companies only.", "items": { "type": "string", "enum": [ "active", "dissolved", "open", "closed", "converted-closed", "removed", "receivership", "liquidation", "administration", "insolvency-proceedings", "voluntary-arrangement" ], "enumTitles": [ "Active", "Dissolved", "Open", "Closed", "Converted closed", "Removed", "Receivership", "Liquidation", "Administration", "Insolvency proceedings", "Voluntary arrangement" ] }, "default": [ "active" ] }, "companyTypes": { "title": "Company types", "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "limited-partnership", "private-unlimited", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "charitable-incorporated-organisation", "scottish-partnership", "oversea-company", "uk-establishment", "registered-society-non-jurisdictional" ], "enumTitles": [ "Private limited company", "Public limited company", "Limited liability partnership", "Limited partnership", "Private unlimited company", "Private limited by guarantee (no share capital)", "Private limited by guarantee, exempt from \"Limited\"", "Charitable incorporated organisation", "Scottish partnership", "Overseas company", "UK establishment of an overseas company", "Registered society" ] } }, "subtypes": { "title": "Subtypes", "type": "array", "description": "Optional.", "items": { "type": "string", "enum": [ "community-interest-company", "private-fund-limited-partnership" ], "enumTitles": [ "Community interest company (CIC)", "Private fund limited partnership" ] } }, "companyNumbers": { "title": "…or look up company numbers", "type": "array", "description": "Enrich your own list: one Companies House number per line (e.g. 00445790, SC123456). Other filters are then ignored.", "items": { "type": "string" } }, "maxItems": { "title": "Max companies", "minimum": 1, "type": "integer", "description": "No 10,000 cap: large searches are split automatically by incorporation date.", "default": 500 }, "includeDetails": { "title": "Full company profile", "type": "boolean", "description": "SIC descriptions, accounts & confirmation statement dates (incl. overdue flag), previous names, charges and insolvency flags.", "default": true }, "includeOfficers": { "title": "Directors & officers", "type": "boolean", "description": "Name, role, appointment/resignation dates, month of birth, nationality, country of residence, occupation, identity verification status.", "default": true }, "maxOfficersPerCompany": { "title": "Max officers per company", "minimum": 1, "type": "integer", "description": "Large PLCs can have hundreds of past officers.", "default": 50 }, "findContacts": { "title": "🌐 Find website, emails & phones", "type": "boolean", "description": "Find the company's own website, check it against the company number or the full company name, then extract emails, phones and social links. Billed only when a website is found.", "default": false }, "monitorName": { "title": "πŸ”” Monitor name (new & changed companies)", "type": "string", "description": "Name this search and schedule it: each run then returns only NEW companies matching your filters and companies whose key data CHANGED (status, name, registered office, SIC, active directors, accounts, type), with before/after values. The first run is the baseline." }, "monitorChanges": { "title": "Also report changed companies", "type": "boolean", "description": "If off, the monitor only reports new companies.", "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 } } } } } } } } } }