{ "openapi": "3.0.1", "info": { "title": "UK Companies House Search & New Company Leads", "description": "Search all ~5.7M UK companies from Companies House's official free bulk data: new incorporations, SIC code, postcode, town, status, overdue accounts, charges, previous names. Optional officers via your free API key. Fast, no scraping.", "version": "1.0", "x-build-id": "p7SGhRmU0PtZopotZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clever_firebox~uk-companies-house-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clever_firebox-uk-companies-house-search", "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/clever_firebox~uk-companies-house-search/runs": { "post": { "operationId": "runs-sync-clever_firebox-uk-companies-house-search", "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/clever_firebox~uk-companies-house-search/run-sync": { "post": { "operationId": "run-sync-clever_firebox-uk-companies-house-search", "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 within N days of the snapshot", "minimum": 1, "maximum": 36500, "type": "integer", "description": "New-company leads. Counted back from the snapshot date (published monthly). Clear it to search all companies.", "default": 30 }, "incorporatedFrom": { "title": "Incorporated from (YYYY-MM-DD)", "type": "string", "description": "Overrides the field above." }, "incorporatedTo": { "title": "Incorporated to (YYYY-MM-DD)", "type": "string", "description": "Optional." }, "sicCodes": { "title": "SIC codes (prefix)", "type": "array", "description": "E.g. 62 (IT), 56101 (restaurants), 41 (construction), 6820 (letting).", "items": { "type": "string" } }, "nameKeywords": { "title": "Company name keywords (any)", "type": "array", "description": "Whole-word match, e.g. solar, dental, consulting.", "items": { "type": "string" } }, "postcodePrefixes": { "title": "Postcode prefixes", "type": "array", "description": "E.g. EC1, M, LS7, SW1A.", "items": { "type": "string" } }, "postTown": { "title": "Post town (exact)", "type": "string", "description": "E.g. LEEDS, LONDON, MANCHESTER." }, "statuses": { "title": "Company status", "type": "array", "description": "E.g. Active, Liquidation, In Administration, Active - Proposal to Strike off.", "default": [ "Active" ], "items": { "type": "string" } }, "companyTypes": { "title": "Company type contains (any)", "type": "array", "description": "E.g. Private Limited Company, PLC, Limited Liability Partnership, Community Interest Company.", "items": { "type": "string" } }, "accountsCategories": { "title": "Accounts category", "type": "array", "description": "E.g. MICRO ENTITY, SMALL, FULL, DORMANT, NO ACCOUNTS FILED.", "items": { "type": "string" } }, "accountsOverdueOnly": { "title": "Accounts overdue only", "type": "boolean", "description": "Next accounts due date has passed (as of the snapshot).", "default": false }, "hasOutstandingChargesOnly": { "title": "Has outstanding charges (mortgages)", "type": "boolean", "description": "Companies with secured lending outstanding.", "default": false }, "onlyNewSinceLastRun": { "title": "Only new since last run", "type": "boolean", "description": "Remembers companies already delivered (per alert name). Useful with a monthly schedule.", "default": false }, "alertStateName": { "title": "Alert name", "type": "string", "description": "Separate memory per saved search.", "default": "default" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "You are charged per company delivered.", "default": 100 }, "companiesHouseApiKey": { "title": "Companies House API key (optional, adds officers)", "type": "string", "description": "Free key from developer.company-information.service.gov.uk. Adds current officers (1 API call per company, rate-limited to ~2/s)." } } }, "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 } } } } } } } } } }