{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper", "description": "Extract UK Companies House company data by name search, company number or profile URL: name, number, status, type, incorporation date, registered address, SIC codes, previous names and officers with roles and appointment dates. Filter by status or SIC. No login.", "version": "0.0", "x-build-id": "MDwjg958c6P3YXck3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~uk-companies-house-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-uk-companies-house-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/axiomworks~uk-companies-house-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-uk-companies-house-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/axiomworks~uk-companies-house-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-uk-companies-house-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": { "searchQueries": { "title": "Company name searches (e.g. tesco, bp)", "type": "array", "description": "Company names or keywords to search, e.g. [\"tesco\",\"bp\"]. Matches current and previous names; 20 results per page, in register order, each opened as a full profile. Use at least one of searchQueries, companyNumbers or companyUrls. A search with no hits returns nothing (run still succeeds). maxItems is shared across all searches.", "items": { "type": "string" } }, "companyNumbers": { "title": "Company numbers (e.g. 00445790)", "type": "array", "description": "Exact Companies House numbers, e.g. [\"00445790\",\"SC123456\"]. Up to 8 characters: digits (zero-padded, so \"445790\" works) or a 2-letter prefix (SC, NI, OC, LP) plus digits. Processed before searches; the most precise input. Unknown numbers are skipped with a warning, not failed.", "items": { "type": "string" } }, "companyUrls": { "title": "Company profile URLs", "type": "array", "description": "Full https profile URLs, e.g. [\"https://find-and-update.company-information.service.gov.uk/company/00445790\"]. Same effect as companyNumbers. Any other host or path fails the run immediately with a message naming the bad URL.", "default": [], "items": { "type": "string" } }, "statuses": { "title": "Status filter (e.g. Active)", "type": "array", "description": "Keep only companies whose status equals one of these (case-insensitive), e.g. [\"Active\"] or [\"Dissolved\",\"Liquidation\"]. Empty = any status. Excluded companies do not count toward maxItems; if every match is excluded the run succeeds with 0 items and says so.", "default": [], "items": { "type": "string" } }, "sicCodePrefixes": { "title": "SIC code prefix filter (e.g. 47, 62)", "type": "array", "description": "Keep only companies having a SIC code that starts with one of these 1-5 digit prefixes, e.g. [\"47\",\"62\"] (47 = retail). Non-digit values fail the run. Empty = any SIC code. Excluded companies do not count toward maxItems.", "default": [], "items": { "type": "string" } }, "includeOfficers": { "title": "Include officers (directors, secretaries)", "type": "boolean", "description": "true (default) adds the full officers list (name, role, appointment and resignation dates) to each company at one extra request per 35 officers. false is faster and returns officers [] and officerCount null. Set false for large company lists.", "default": true }, "includePscs": { "title": "Include PSCs (beneficial owners)", "type": "boolean", "description": "false (default) skips them. true adds pscs (persons with significant control: name, status, notified/ceased dates, nature of control, nationality) and pscCount, one extra request per PSC page. Exempt companies return an empty list.", "default": false }, "maxItems": { "title": "Maximum companies to return (1-10000)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum company records returned across all numbers, URLs and searches combined, 1-10000, default 50. Filtered-out companies do not count. Keep small (e.g. 5) for a quick test; each record is one billable result.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings, e.g. {\"useApifyProxy\": false}. Off by default because the site works without it; if a request is blocked or throttled (403/429) the Actor retries through Apify Proxy automatically. Set useApifyProxy true to use it from the start.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }