{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper: SIC Code Search, Overdue Accounts", "description": "Companies House registry data: filter the UK company register by SIC code, postcode, town, status, incorporation date and overdue accounts. Find new companies and business leads with address, SIC codes and filing dates. Monthly snapshot, no directors or PSCs. No API key needed. Unofficial tool.", "version": "0.1", "x-build-id": "NuYIjjuaBri1mbUNf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plainrecordlabs~uk-companies-house-filter/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plainrecordlabs-uk-companies-house-filter", "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/plainrecordlabs~uk-companies-house-filter/runs": { "post": { "operationId": "runs-sync-plainrecordlabs-uk-companies-house-filter", "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/plainrecordlabs~uk-companies-house-filter/run-sync": { "post": { "operationId": "run-sync-plainrecordlabs-uk-companies-house-filter", "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": { "sicCodes": { "title": "SIC codes", "type": "array", "description": "Industry codes or prefixes, for example 56 (food and drink service), 5610 (restaurants) or 62020 (IT consultancy). Leave empty for every industry.", "default": [], "items": { "type": "string" } }, "postcodePrefixes": { "title": "Postcode prefixes", "type": "array", "description": "Postcode areas or districts, for example M, M1, SW1A or EH3 6. B matches Birmingham postcodes only, not BN.", "default": [], "items": { "type": "string" } }, "towns": { "title": "Towns", "type": "array", "description": "Post towns as written on the register, for example LEEDS or HOVE. Case does not matter, but the whole town name must match.", "default": [], "items": { "type": "string" } }, "incorporatedWithinDays": { "title": "Incorporated within (days)", "minimum": 0, "type": "integer", "description": "Companies registered in the N days before the register snapshot date, for example 30 for the newest month in the snapshot. 0 = any date.", "default": 0 }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Earliest incorporation date, YYYY-MM-DD, for example 2026-01-01. Overrides the days field." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Latest incorporation date, YYYY-MM-DD, for example 2026-06-30." }, "statuses": { "title": "Statuses", "type": "array", "description": "Company statuses to keep, written as the register writes them, for example Active, Liquidation or In Administration. The README lists the exact strike-off status. Clear the list for all.", "default": [ "Active" ], "items": { "type": "string" } }, "companyTypes": { "title": "Company types", "type": "array", "description": "Keep companies whose register category contains any of these, for example Private Limited Company or PRI/LTD BY GUAR.", "default": [], "items": { "type": "string" } }, "accountCategories": { "title": "Account categories", "type": "array", "description": "Keep companies whose last accounts category is one of these, written in full, for example MICRO ENTITY, DORMANT, TOTAL EXEMPTION FULL or FULL. Case does not matter.", "default": [], "items": { "type": "string" } }, "accountsOverdue": { "title": "Accounts overdue", "type": "boolean", "description": "Only companies whose next accounts due date in the snapshot has passed, for example to find businesses that may need an accountant.", "default": false }, "confirmationStatementOverdue": { "title": "Confirmation statement overdue", "type": "boolean", "description": "Only companies whose confirmation statement due date in the snapshot has passed, for example to find companies behind on their yearly filing.", "default": false }, "nameKeywords": { "title": "Company name contains", "type": "array", "description": "Words matched at the start of a word in the current or previous names, for example \"Bakery\" or \"Tech\". Case does not matter, so \"tech\" also finds TECHNOLOGIES.", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Most companies one run returns, for example 500. 0 = no cap.", "default": 100 } } }, "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 } } } } } } } } } }