{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper: New Companies, Status & Profiles", "description": "Search the UK company register without an API key: by name, SIC code, status, type, address or incorporation date. Bulk company profiles, new-company monitoring and status-change tracking. Company data only, no officer names.", "version": "0.1", "x-build-id": "PpiGJKMfVgVR3gavP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datasmithlab~companies-house-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datasmithlab-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/datasmithlab~companies-house-scraper/runs": { "post": { "operationId": "runs-sync-datasmithlab-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/datasmithlab~companies-house-scraper/run-sync": { "post": { "operationId": "run-sync-datasmithlab-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": { "nameContains": { "title": "Company name contains", "type": "array", "description": "One keyword or phrase per line, e.g. 'bakery' or 'tesco'. Each line is a separate search; companies found twice are returned once. Leave empty to search by dates, SIC code, status or address only.", "items": { "type": "string" } }, "nameExcludes": { "title": "Name does not contain", "type": "string", "description": "Skip companies whose name contains this word, e.g. 'holdings'." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Industry codes, one per line, e.g. 62012 (software), 56101 (restaurants), 68100 (property). Each code is a separate search.", "items": { "type": "string" } }, "incorporatedInLastDays": { "title": "Newly incorporated in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Shortcut for new-company monitoring: companies registered in the last N days (up to today). Overrides the incorporation dates below." }, "incorporatedFrom": { "title": "Incorporated from (date)", "type": "string", "description": "First incorporation day, format YYYY-MM-DD, e.g. 2026-10-01." }, "incorporatedTo": { "title": "Incorporated to (date)", "type": "string", "description": "Last incorporation day, format YYYY-MM-DD. Searches above 10,000 matches are split into date windows automatically, so you get everything." }, "dissolvedFrom": { "title": "Dissolved from (date)", "type": "string", "description": "First dissolution day, YYYY-MM-DD. Use with status 'Dissolved' to find companies that just closed." }, "dissolvedTo": { "title": "Dissolved to (date)", "type": "string", "description": "Last dissolution day, YYYY-MM-DD." }, "statuses": { "title": "Company status", "type": "array", "description": "Only these statuses. Leave empty for all.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "receivership", "administration", "voluntary-arrangement", "insolvency-proceedings", "converted-closed", "open", "closed" ], "enumTitles": [ "Active", "Dissolved", "Liquidation", "Receivership", "Administration", "Voluntary arrangement", "Insolvency proceedings", "Converted / closed", "Open", "Closed" ] } }, "companyTypes": { "title": "Company type", "type": "array", "description": "Only these company types. Leave empty for all.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "limited-partnership", "private-unlimited", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-unlimited-nsc", "old-public-company", "scottish-partnership", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "royal-charter", "industrial-and-provident-society", "registered-society-non-jurisdictional", "oversea-company", "uk-establishment", "eeig", "european-public-limited-liability-company-se", "icvc", "assurance-company", "protected-cell-company", "registered-overseas-entity", "unregistered-company", "converted-or-closed", "further-education-or-sixth-form-college-corporation" ], "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)", "Private unlimited (no share capital)", "Old public company", "Scottish partnership", "Charitable incorporated organisation", "Scottish charitable incorporated organisation", "Royal charter company", "Industrial and provident society", "Registered society", "Overseas company", "UK establishment", "EEIG", "European public limited company (SE)", "Investment company with variable capital", "Assurance company", "Protected cell company", "Registered overseas entity", "Unregistered company", "Converted / closed", "Further education or sixth form college" ] } }, "addressContains": { "title": "Registered office address contains", "type": "string", "description": "Text or postcode (part) of the registered office address, e.g. 'Manchester' or 'M1'." }, "companyNumbers": { "title": "Company numbers (bulk profiles)", "type": "array", "description": "One company number per line, e.g. 00445790 or SC123456 (leading zeros optional). When set, the search filters above are ignored and each company's full profile is returned.", "items": { "type": "string" } }, "includeProfile": { "title": "Full profile for every search result", "type": "boolean", "description": "Adds accounts and confirmation-statement dates, SIC descriptions and previous names to each found company (one extra page per company, charged as a profile row). Off = fast, cheap search rows.", "default": false }, "includePscCount": { "title": "Add the number of persons with significant control", "type": "boolean", "description": "Adds pscCount and pscStatementCount (numbers only, no names). Needs full profiles or company numbers. One extra page per company.", "default": false }, "onlyNewOrChanged": { "title": "Only new or changed companies", "type": "boolean", "description": "Schedule the run and every later run returns only companies not seen before (NEW) or whose status, name or registered address changed (CHANGED, with the previous values). Unchanged companies are skipped and not charged. Memory is kept per identical settings.", "default": false }, "maxItems": { "title": "Max companies", "minimum": 1, "type": "integer", "description": "Stop after this many company rows (you pay per row).", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Requests go out without a proxy first. Only if Companies House rate-limits them is this proxy used (at most 3 new IPs, then the run stops and reports it).", "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 } } } } } } } } } }