{ "openapi": "3.0.1", "info": { "title": "Companies House Scraper — UK Company Directors & Filings", "description": "Companies House scraper on the official UK register, no API key needed: company profile, SIC codes, current and resigned directors and officers, and the latest filing history in one row per company. Search by name, company number, SIC code, incorporation date or location. $5 per 1,000 companies.", "version": "0.1", "x-build-id": "pW1kOyu6yehlEgSSB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/actor-forge~uk-companies-house-enrichment/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-actor-forge-uk-companies-house-enrichment", "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/actor-forge~uk-companies-house-enrichment/runs": { "post": { "operationId": "runs-sync-actor-forge-uk-companies-house-enrichment", "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/actor-forge~uk-companies-house-enrichment/run-sync": { "post": { "operationId": "run-sync-actor-forge-uk-companies-house-enrichment", "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": "Enrich exactly these companies (e.g. 09876543). Takes priority over search terms and filters.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Free-text company name search, e.g. 'plumbing manchester'. Used only when no company numbers and no advanced filters are given.", "items": { "type": "string" } }, "sicCodes": { "title": "SIC codes (advanced filter)", "type": "array", "description": "Filter by Standard Industrial Classification codes, e.g. 43991 for scaffolding. Combine with status/date/location filters for targeted lead lists.", "items": { "type": "string" } }, "companyStatus": { "title": "Company status (advanced filter)", "enum": [ "any", "active", "dissolved", "liquidation" ], "type": "string", "description": "Only companies in this state. 'any' disables the filter.", "default": "any" }, "incorporatedFrom": { "title": "Incorporated from (advanced filter)", "type": "string", "description": "Earliest incorporation date, YYYY-MM-DD. Great for 'new companies' lead lists." }, "incorporatedTo": { "title": "Incorporated to (advanced filter)", "type": "string", "description": "Latest incorporation date, YYYY-MM-DD." }, "location": { "title": "Location (advanced filter)", "type": "string", "description": "Registered-office location filter, e.g. 'Manchester'." }, "maxResults": { "title": "Max companies", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many companies. You are charged per company: 1,000 companies = $5.00. If you set a run budget (max total charge), the actor automatically stays inside it.", "default": 100 }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Attach current and resigned officers (name, role, dates, occupation, nationality). No dates of birth or personal addresses are ever returned.", "default": true }, "includeFilings": { "title": "Include filing history", "type": "boolean", "description": "Attach the 25 most recent filings (date, category, type, description).", "default": true }, "apiKey": { "title": "Your Companies House API key (optional)", "type": "string", "description": "Optional: bring your own free key from developer.company-information.service.gov.uk for dedicated throughput (600 requests/5 min per key). Without it, the actor's shared key is used." } } }, "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 } } } } } } } } } }