{ "openapi": "3.0.1", "info": { "title": "UK Companies House Leads: new companies, SIC filter, no API key", "description": "Filter the full UK Companies House register (5.7M companies) into clean B2B lead rows: new incorporations, overdue accounts, SIC, postcode, mass-address filter, only-new-since-last-run. No API key.", "version": "0.1", "x-build-id": "5Yhzf2ToTM8rz1x1O" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/timeout~uk-companies-house-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-timeout-uk-companies-house-leads", "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/timeout~uk-companies-house-leads/runs": { "post": { "operationId": "runs-sync-timeout-uk-companies-house-leads", "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/timeout~uk-companies-house-leads/run-sync": { "post": { "operationId": "run-sync-timeout-uk-companies-house-leads", "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": { "incorporatedWithinDays": { "title": "Incorporated in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only companies incorporated within the last N days (relative to today). Leave empty for all ages. The source snapshot is refreshed monthly, so the newest companies can be up to ~5 weeks old." }, "incorporatedFrom": { "title": "Incorporated from (YYYY-MM-DD)", "type": "string", "description": "Optional. Overrides 'last N days' lower bound." }, "incorporatedTo": { "title": "Incorporated to (YYYY-MM-DD)", "type": "string", "description": "Optional upper bound." }, "sicCodes": { "title": "SIC code prefixes", "type": "array", "description": "E.g. 62 (software/IT), 6920 (accounting), 4120 (construction), 56 (food service). Matches any SIC code of the company.", "default": [], "items": { "type": "string" } }, "sicKeywords": { "title": "SIC description keywords", "type": "array", "description": "Match words in the SIC description, e.g. software, restaurant, consultancy.", "default": [], "items": { "type": "string" } }, "postcodePrefixes": { "title": "Postcode prefixes", "type": "array", "description": "E.g. EC1, M, SW1A, BT. Spaces ignored.", "default": [], "items": { "type": "string" } }, "towns": { "title": "Post towns", "type": "array", "description": "E.g. LONDON, MANCHESTER (case-insensitive, exact match).", "default": [], "items": { "type": "string" } }, "counties": { "title": "Counties", "type": "array", "description": "Exact match on the registered-office county field (often empty in the register; prefer postcodes).", "default": [], "items": { "type": "string" } }, "statuses": { "title": "Company status", "type": "array", "description": "Default: Active. Other values in the snapshot: 'Active - Proposal to Strike off', 'Liquidation', 'In Administration', 'Voluntary Arrangement', 'Receivership Action'...", "default": [ "Active" ], "items": { "type": "string" } }, "companyTypes": { "title": "Company type contains", "type": "array", "description": "E.g. 'Private Limited', 'PLC', 'LLP', 'Community Interest', 'Charitable'.", "default": [], "items": { "type": "string" } }, "accountCategories": { "title": "Accounts category contains", "type": "array", "description": "E.g. DORMANT, MICRO ENTITY, SMALL, FULL, GROUP, NO ACCOUNTS FILED.", "default": [], "items": { "type": "string" } }, "accountsOverdue": { "title": "Accounts overdue", "enum": [ "any", "yes", "no" ], "type": "string", "description": "true = only companies whose annual accounts are past their due date (distress / collections / insolvency leads); false = only up to date. Leave unset for both.", "default": "any" }, "confirmationStatementOverdue": { "title": "Confirmation statement overdue", "enum": [ "any", "yes", "no" ], "type": "string", "description": "Same, for the annual confirmation statement. Leave unset for both.", "default": "any" }, "minAgeDays": { "title": "Minimum company age (days)", "minimum": 0, "type": "integer", "description": "E.g. 365 to skip very new companies." }, "nameContains": { "title": "Name contains any", "type": "array", "description": "Keywords in the company name.", "default": [], "items": { "type": "string" } }, "nameExcludes": { "title": "Name excludes any", "type": "array", "description": "Drop companies whose name contains any of these words.", "default": [], "items": { "type": "string" } }, "maxCompaniesAtSameAddress": { "title": "Drop mass-registration addresses (max companies per address)", "minimum": 0, "type": "integer", "description": "Formation-agent and virtual-office addresses host hundreds or thousands of shells and pollute lead lists. Set e.g. 20 to drop every company whose registered address (line 1 + postcode) is shared by more than 20 companies in the register. 0 = off. Every row also has 'companiesAtSameAddress'.", "default": 0 }, "onlyNewSinceLastRun": { "title": "Only companies not delivered in previous runs", "type": "boolean", "description": "Great with a monthly schedule: each run returns only companies you have not received before (state kept in your account).", "default": false }, "feedName": { "title": "Feed name (for 'only new')", "type": "string", "description": "Use different names to keep separate 'already delivered' lists for different searches.", "default": "default" }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Newest incorporations first. 1-100000.", "default": 100 }, "snapshotUrl": { "title": "Advanced: snapshot URL override", "type": "string", "description": "Leave empty to auto-detect the latest Companies House monthly snapshot." } } }, "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 } } } } } } } } } }