{ "openapi": "3.0.1", "info": { "title": "Companies House UK Company Registry Scraper", "description": "Scrapes the UK Companies House register for company names, registration numbers, status, incorporation dates, addresses, SIC codes, and previous names. Optional director and secretary details can be filtered by various criteria. No account or API key required.", "version": "0.0", "x-build-id": "viGxGMF4pOi0g7McW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moving_beacon-owner1~companies-house-uk-company-registry-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moving_beacon-owner1-companies-house-uk-company-registry-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/moving_beacon-owner1~companies-house-uk-company-registry-scraper/runs": { "post": { "operationId": "runs-sync-moving_beacon-owner1-companies-house-uk-company-registry-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/moving_beacon-owner1~companies-house-uk-company-registry-scraper/run-sync": { "post": { "operationId": "run-sync-moving_beacon-owner1-companies-house-uk-company-registry-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", "properties": { "company_name_includes": { "title": "Company name contains", "type": "string", "description": "Words the registered company name must contain, e.g. 'solar', 'dental', 'logistics'. Leave empty to search on the other filters alone (SIC code, location, incorporation dates). Ignored when 'Company numbers' is filled in.", "default": "solar" }, "sic_codes": { "title": "SIC industry codes", "type": "string", "description": "Comma-separated UK SIC 2007 codes to restrict the search to one or more industries, e.g. '35110' (production of electricity) or '62012,62020' (software and IT consultancy). Leave empty for all industries.", "default": "" }, "location": { "title": "Registered office location", "type": "string", "description": "Town, county or postcode the registered office address must contain, e.g. 'Manchester', 'Cornwall', 'W1G'. Leave empty for the whole United Kingdom.", "default": "" }, "company_status": { "title": "Company status", "enum": [ "active", "dissolved", "liquidation", "administration", "open", "closed", "any" ], "type": "string", "description": "Restrict results to companies in this state on the register. Choose 'Any status' to include every company.", "default": "active" }, "company_type": { "title": "Company type", "type": "string", "description": "Optional register company-type code, e.g. 'ltd' (private limited), 'plc' (public limited), 'llp' (limited liability partnership). Leave empty for all types.", "default": "" }, "incorporated_from": { "title": "Incorporated from", "type": "string", "description": "Earliest incorporation date to include, as YYYY-MM-DD (or DD/MM/YYYY). Leave empty for no lower bound.", "default": "" }, "incorporated_to": { "title": "Incorporated to", "type": "string", "description": "Latest incorporation date to include, as YYYY-MM-DD (or DD/MM/YYYY). Leave empty for no upper bound.", "default": "" }, "company_numbers": { "title": "Company numbers", "type": "array", "description": "Look up these specific companies instead of searching. Accepts company numbers ('00445790', '445790', 'OE035072') or full register profile links. When filled in, all search filters are ignored.", "default": [], "items": { "type": "string" } }, "include_details": { "title": "Include full company details", "type": "boolean", "description": "Read each company's overview page for the full SIC industry descriptions, accounts and confirmation-statement dates, dissolution date and previous company names. Adds one request per company.", "default": true }, "include_officers": { "title": "Include officers", "type": "boolean", "description": "Attach the company's current directors and secretaries — name, role, appointment date, nationality, month and year of birth and correspondence address. Adds one request per company.", "default": false }, "max_results": { "title": "Max results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of company records to return.", "default": 25 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings for the run. The UK register is open worldwide — enable a UK or US proxy for the most reliable results on busy networks.", "default": { "useApifyProxy": 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 } } } } } } } } } }