{ "openapi": "3.0.1", "info": { "title": "UK Companies House Company List Builder (No API Key)", "description": "Build UK B2B lead lists from the official Companies House register (5.7M companies). Filter by SIC code, postcode, town, status, incorporation date and company size. New-company feeds with 'only new since last run'. No API key, no login, $0.75 per 1,000 companies.", "version": "0.1", "x-build-id": "6tA9Y4oj06p0AASXA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zaidistudio~uk-companies-house-bulk-filter/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zaidistudio-uk-companies-house-bulk-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/zaidistudio~uk-companies-house-bulk-filter/runs": { "post": { "operationId": "runs-sync-zaidistudio-uk-companies-house-bulk-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/zaidistudio~uk-companies-house-bulk-filter/run-sync": { "post": { "operationId": "run-sync-zaidistudio-uk-companies-house-bulk-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 code prefixes", "type": "array", "description": "Match companies whose SIC codes start with any of these, e.g. \"62\" (all IT), \"56101\" (licensed restaurants). Leave empty for any.", "items": { "type": "string" } }, "sicKeywords": { "title": "SIC description keywords", "type": "array", "description": "Match if any SIC description contains one of these words (case-insensitive), e.g. \"dental\".", "items": { "type": "string" } }, "postcodePrefixes": { "title": "Postcode prefixes", "type": "array", "description": "Registered-office postcode starts with any of these, e.g. \"M1\", \"EC1\", \"BT\". Spaces ignored.", "items": { "type": "string" } }, "postTowns": { "title": "Post towns", "type": "array", "description": "Exact registered-office post town, case-insensitive, e.g. \"LEEDS\".", "items": { "type": "string" } }, "companyStatuses": { "title": "Company statuses", "type": "array", "description": "Exact statuses to keep, e.g. \"Active\". Empty = any status.", "default": [ "Active" ], "items": { "type": "string" } }, "excludeStrikeOffProposals": { "title": "Exclude companies with a proposal to strike off", "type": "boolean", "description": "Drop 'Active - Proposal to Strike off' companies even if 'Active' prefixes are used.", "default": true }, "companyCategories": { "title": "Company types", "type": "array", "description": "e.g. \"Private Limited Company\", \"PRI/LTD BY GUAR/NSC (Private, limited by guarantee, no share capital)\". Empty = any.", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated on or after (YYYY-MM-DD)", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Incorporated on or after (YYYY-MM-DD)" }, "incorporatedTo": { "title": "Incorporated on or before (YYYY-MM-DD)", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Incorporated on or before (YYYY-MM-DD)" }, "incorporatedWithinDays": { "title": "Incorporated within the last N days of the snapshot", "minimum": 1, "type": "integer", "description": "Shortcut for 'new companies'. Counted back from the snapshot date." }, "nameContains": { "title": "Company name contains", "type": "array", "description": "Any of these substrings, case-insensitive.", "items": { "type": "string" } }, "accountsCategories": { "title": "Accounts categories", "type": "array", "description": "e.g. \"MICRO ENTITY\", \"FULL\", \"TOTAL EXEMPTION FULL\". Useful as a size proxy.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Stop after this many matches. The snapshot is ordered by company name, so a low cap gives an alphabetical slice.", "default": 1000 }, "onlyNewSinceLastRun": { "title": "Only new since last run", "type": "boolean", "description": "Remember the companies returned for these filters and return only companies you have not received before. Great for scheduled weekly or monthly runs. Companies House refreshes the snapshot monthly.", "default": false }, "watchName": { "title": "Watch name (optional)", "type": "string", "description": "Optional label for the 'only new' memory, so you can change filters and keep the same history. Leave empty to key it on the filters." }, "includePreviousNames": { "title": "Include previous names", "type": "boolean", "description": "Include previous names", "default": false }, "snapshotPageUrl": { "title": "Snapshot index page (advanced)", "type": "string", "description": "Snapshot index page (advanced)", "default": "https://download.companieshouse.gov.uk/en_output.html" }, "localZipPaths": { "title": "Local zip files (testing only)", "type": "array", "description": "Skip download and read these local snapshot zips.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }