{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper (No API Key)", "description": "Search the official UK Companies House register without an API key. Find new companies by SIC code, location, status, type and incorporation date, or look up company numbers. Company data only, no personal data.", "version": "0.1", "x-build-id": "aijKXIH0usDZ6qznu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bircolabots~uk-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bircolabots-uk-companies-house", "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/bircolabots~uk-companies-house/runs": { "post": { "operationId": "runs-sync-bircolabots-uk-companies-house", "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/bircolabots~uk-companies-house/run-sync": { "post": { "operationId": "run-sync-bircolabots-uk-companies-house", "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": { "mode": { "title": "Mode", "enum": [ "search", "lookup" ], "type": "string", "description": "Search the register with filters, or fetch specific companies by their company number.", "default": "search" }, "sicCodes": { "title": "SIC codes (industry)", "type": "array", "description": "5-digit SIC 2007 codes, e.g. 41201 (commercial buildings), 62012 (software development), 56101 (restaurants). Companies with any of these codes are returned.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Town, city or postcode area of the registered office, e.g. \"Manchester\", \"London\" or \"M1\"." }, "incorporatedWithinDays": { "title": "Incorporated in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only new companies incorporated in the last N days. Leave empty to use the date fields below instead (or no date filter)." }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Only companies incorporated on or after this date (YYYY-MM-DD)." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Only companies incorporated on or before this date (YYYY-MM-DD)." }, "companyStatus": { "title": "Company status", "type": "array", "description": "Only companies with these statuses. Default: active. Empty list = any status.", "items": { "type": "string", "enum": [ "active", "dissolved", "open", "closed", "converted-closed", "receivership", "administration", "liquidation", "insolvency-proceedings", "voluntary-arrangement", "registered", "removed" ], "enumTitles": [ "Active", "Dissolved", "Open", "Closed", "Converted closed", "Receivership", "Administration", "Liquidation", "Insolvency proceedings", "Voluntary arrangement", "Registered", "Removed" ] }, "default": [ "active" ] }, "companyType": { "title": "Company type", "type": "array", "description": "Only companies of these types, e.g. Ltd or LLP. Empty = any type.", "items": { "type": "string", "enum": [ "private-unlimited", "ltd", "plc", "old-public-company", "private-limited-guarant-nsc-limited-exemption", "limited-partnership", "private-limited-guarant-nsc", "converted-or-closed", "private-unlimited-nsc", "private-limited-shares-section-30-exemption", "protected-cell-company", "assurance-company", "oversea-company", "eeig", "icvc-securities", "icvc-warrant", "icvc-umbrella", "registered-society-non-jurisdictional", "industrial-and-provident-society", "northern-ireland", "northern-ireland-other", "royal-charter", "investment-company-with-variable-capital", "unregistered-company", "llp", "other", "european-public-limited-liability-company-se", "uk-establishment", "scottish-partnership", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "further-education-or-sixth-form-college-corporation", "registered-overseas-entity" ], "enumTitles": [ "Private unlimited company", "Private limited company (Ltd)", "Public limited company (PLC)", "Old public company", "Private limited by guarantee (exempt from \"Limited\")", "Limited partnership", "Private limited by guarantee", "Converted or closed", "Private unlimited nsc", "Private limited shares section 30 exemption", "Protected cell company", "Assurance company", "Overseas company", "Eeig", "Icvc securities", "Icvc warrant", "Icvc umbrella", "Registered society non jurisdictional", "Industrial and provident society", "Northern ireland", "Northern ireland other", "Royal charter", "Investment company with variable capital", "Unregistered company", "Limited liability partnership (LLP)", "Other", "European public limited liability company se", "UK establishment of an overseas company", "Scottish partnership", "Charitable incorporated organisation (CIO)", "Scottish charitable incorporated organisation", "Further education or sixth form college corporation", "Registered overseas entity" ] } }, "companyNameIncludes": { "title": "Company name includes", "type": "string", "description": "Only companies whose name contains this text, e.g. \"construction\"." }, "companyNameExcludes": { "title": "Company name excludes", "type": "string", "description": "Skip companies whose name contains this text, e.g. \"holdings\"." }, "dissolvedFrom": { "title": "Dissolved from", "type": "string", "description": "Only companies dissolved on or after this date. Use with status \"dissolved\"." }, "dissolvedTo": { "title": "Dissolved to", "type": "string", "description": "Only companies dissolved on or before this date. Use with status \"dissolved\"." }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Used in Lookup mode. Up to 5,000 company numbers, e.g. 00000006 or SC123456 (leading zeros are added for you).", "items": { "type": "string" } }, "includeProfile": { "title": "Include full company profile", "type": "boolean", "description": "Adds accounts and confirmation statement due dates, overdue flags, last accounts type, previous names, charges and insolvency flags. Slower: one extra request per company. Always on in Lookup mode.", "default": false }, "maxItems": { "title": "Maximum companies", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many companies. You pay only for companies saved.", "default": 100 }, "apiKey": { "title": "Your own Companies House API key (optional)", "type": "string", "description": "Not needed: the Actor has a built-in key. Add your own free key only for very large or frequent runs (each key allows 600 requests per 5 minutes)." } } }, "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 } } } } } } } } } }