{ "openapi": "3.0.1", "info": { "title": "UK Companies House Search: by SIC Code, Postcode, Town", "description": "Find all UK companies by SIC code (industry), postcode area or district, town, name, company type and incorporation date, from the official Companies House register (5+ million companies). Addresses, SIC codes, status, accounts dates. No API key needed.", "version": "0.1", "x-build-id": "bpz0igdWbOIbdAi3G" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidelane~uk-companies-house-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidelane-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/tidelane~uk-companies-house-search/runs": { "post": { "operationId": "runs-sync-tidelane-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/tidelane~uk-companies-house-search/run-sync": { "post": { "operationId": "run-sync-tidelane-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": { "sicCodes": { "title": "SIC codes (industry)", "type": "array", "description": "UK SIC 2007 codes. A shorter code matches everything below it: 62 = all IT companies, 6201 = software, 62012 = business software only, 561 = restaurants and cafes. Companies match if any of their up to 4 SIC codes fits.", "items": { "type": "string" } }, "postcodes": { "title": "Postcodes", "type": "array", "description": "Postcode areas (B = Birmingham, M = Manchester, EC = London City), districts (SW1A, M1, LS6), sectors (SW1A 1) or full postcodes of the registered office. B matches only Birmingham, not BA or BB.", "items": { "type": "string" } }, "towns": { "title": "Post towns", "type": "array", "description": "Post town of the registered office, e.g. LONDON, LEEDS, GLASGOW (not case sensitive). Postcodes are more reliable because the town field is free text.", "items": { "type": "string" } }, "nameContains": { "title": "Company name contains", "type": "array", "description": "Keep companies whose name contains any of these words, e.g. bakery, solar, dental.", "items": { "type": "string" } }, "companyTypes": { "title": "Company types", "type": "array", "description": "Keep these types only (part of the name is enough): Private Limited Company, Public Limited Company, Limited Liability Partnership, Community Interest Company, Charitable Incorporated Organisation, Limited Partnership, Overseas Entity, Registered Society.", "items": { "type": "string" } }, "accountsCategories": { "title": "Accounts categories (size)", "type": "array", "description": "Filter by the type of the last accounts, a rough size signal: MICRO ENTITY, SMALL, TOTAL EXEMPTION FULL, UNAUDITED ABRIDGED, MEDIUM, FULL, GROUP, NO ACCOUNTS FILED.", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Only companies incorporated on or after this date (YYYY-MM-DD). Great for finding new companies." }, "incorporatedTo": { "title": "Incorporated until", "type": "string", "description": "Only companies incorporated on or before this date (YYYY-MM-DD)." }, "statuses": { "title": "Company status", "type": "array", "description": "Keep these statuses. Default is Active. Others: Active - Proposal to Strike off, Liquidation, In Administration, Voluntary Arrangement. Leave empty for all.", "default": [ "Active" ], "items": { "type": "string" } }, "excludeDormant": { "title": "Exclude dormant companies", "type": "boolean", "description": "Leave out companies with SIC 99999 (dormant) or dormant accounts.", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Stop after this many companies.", "default": 1000 } } }, "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 } } } } } } } } } }