{ "openapi": "3.0.1", "info": { "title": "UK Companies & Directors by Industry — Lead Generation", "description": "Build UK B2B lead lists in seconds. Search the official Companies House registry by industry (SIC code), location, status & date — then enrich with active directors ready for outreach. No subscription, pay only for results.", "version": "0.1", "x-build-id": "yDgO9SPtro8TFUrTv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/quiet_scooter~uk-companies-by-industry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-quiet_scooter-uk-companies-by-industry", "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/quiet_scooter~uk-companies-by-industry/runs": { "post": { "operationId": "runs-sync-quiet_scooter-uk-companies-by-industry", "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/quiet_scooter~uk-companies-by-industry/run-sync": { "post": { "operationId": "run-sync-quiet_scooter-uk-companies-by-industry", "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": [ "companiesHouseApiKey" ], "properties": { "sicCodes": { "title": "SIC codes (industry)", "uniqueItems": true, "type": "array", "description": "One or more 5-digit Standard Industrial Classification codes. Examples: '43220' = plumbing, heating and air-conditioning installation; '43210' = electrical installation; '43910' = roofing activities; '68310' = real estate agencies. See the Actor README for a full reference list.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Filter by registered office location. Accepts town, city, county, region, or postcode (e.g. 'London', 'Manchester', 'Surrey', 'SW1A')." }, "companyStatus": { "title": "Company status", "uniqueItems": true, "type": "array", "description": "Which company statuses to include. 'Active' is the default and what you'll want for B2B outreach.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "receivership", "administration", "voluntary-arrangement", "converted-closed", "insolvency-proceedings", "registered", "removed", "open", "closed" ], "enumTitles": [ "Active", "Dissolved", "Liquidation", "Receivership", "Administration", "Voluntary arrangement", "Converted / closed", "Insolvency proceedings", "Registered", "Removed", "Open", "Closed" ] }, "default": [ "active" ] }, "incorporatedFrom": { "title": "Incorporated from (date)", "type": "string", "description": "Only return companies incorporated on or after this date. Format: YYYY-MM-DD. Useful for finding newly registered businesses." }, "incorporatedTo": { "title": "Incorporated to (date)", "type": "string", "description": "Only return companies incorporated on or before this date. Format: YYYY-MM-DD." }, "companyNameIncludes": { "title": "Company name contains", "type": "string", "description": "Optional keyword that must appear in the company name (e.g. 'plumbing', 'electrical', 'consulting')." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of companies to return. The Companies House API caps the total at ~10,000 per search — if you need more, split your search by location or date range.", "default": 1000 }, "includeDirectors": { "title": "🎯 Include directors (premium — best for B2B outreach)", "type": "boolean", "description": "Enrich each company with director names, roles, dates of appointment, and occupations. Perfect for sales outreach, recruitment, and decision-maker research. ⚠️ Adds one extra API call per company, so 1,000 companies takes ~5–10 minutes instead of ~1 minute.", "default": false }, "activeDirectorsOnly": { "title": "Active directors only", "type": "boolean", "description": "Exclude directors who have resigned. Recommended for outreach — you only want to contact people still at the company. Only used if 'Include directors' is on.", "default": true }, "oneRowPerDirector": { "title": "One row per director (flat layout for mail-merge)", "type": "boolean", "description": "If a company has 3 directors, return 3 rows instead of 1. Each row has the full company data plus one director. Ideal for importing straight into CRMs and email-outreach tools. If off, the row contains a 'directors' summary column plus the primary director's details. Only used if 'Include directors' is on.", "default": false }, "companiesHouseApiKey": { "title": "Companies House API key (free — 60 sec setup)", "type": "string", "description": "Paste your free Companies House API key here. 👉 Don't have one yet? Follow the 60-second setup guide in the Information tab. The key is stored privately in your Apify account and is only sent to Companies House to authenticate your data requests." } } }, "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 } } } } } } } } } }