{ "openapi": "3.0.1", "info": { "title": "UK Companies House Company Data", "description": "Official UK company data straight from the Companies House public register. Search by name, SIC code, status or incorporation date, or look up company numbers in bulk. No scraping, no blocks, no ToS risk.", "version": "0.1", "x-build-id": "ofNAUazhEgzOeC1JV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/adv3ntur3~uk-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-adv3ntur3-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/adv3ntur3~uk-companies-house/runs": { "post": { "operationId": "runs-sync-adv3ntur3-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/adv3ntur3~uk-companies-house/run-sync": { "post": { "operationId": "run-sync-adv3ntur3-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": { "apiKey": { "title": "Companies House API key", "type": "string", "description": "**Free, and takes about two minutes.** Register at https://developer.company-information.service.gov.uk/, create an application on the *Live* environment, and paste its REST API key here. This Actor reads the official Companies House register rather than scraping web pages, and the register requires a key. Because the key is yours, you get the full 600-requests-per-5-minutes allowance to yourself instead of queueing behind other users — and your runs can never be blocked by anti-bot systems. Leave this empty and the run will exit cleanly with setup instructions and no charge." }, "companyNumbers": { "title": "Company numbers (bulk lookup)", "type": "array", "description": "Look up these specific company numbers directly. Include leading zeros exactly as Companies House writes them — 00000006, not 6. If you fill this in, the search filters below are ignored.", "items": { "type": "string" } }, "searchQuery": { "title": "Company name contains", "type": "string", "description": "Find companies whose name contains this text. Leave the company numbers field empty to use search mode." }, "companyStatus": { "title": "Company status", "type": "array", "description": "Only return companies with these statuses. Leave empty for all. Most lead-generation use cases want 'active' only.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "receivership", "administration", "voluntary-arrangement", "converted-closed", "insolvency-proceedings", "registered", "removed", "closed", "open" ] }, "default": [ "active" ] }, "companyType": { "title": "Company type", "type": "array", "description": "Only return these company types. Leave empty for all.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "private-unlimited", "old-public-company", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-limited-shares-section-30-exemption", "limited-partnership", "scottish-partnership", "charitable-incorporated-organisation", "community-interest-company", "royal-charter", "other" ] } }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Filter by Standard Industrial Classification code — the UK's industry classification. For example 62012 is business software development, 43210 is electrical installation. Full list: https://resources.companieshouse.gov.uk/sic/", "items": { "type": "string" } }, "location": { "title": "Registered office location", "type": "string", "description": "Filter by the town, city or region in the registered office address, for example 'Manchester'." }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Only companies incorporated on or after this date. Format YYYY-MM-DD. Useful for finding newly formed companies." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Only companies incorporated on or before this date. Format YYYY-MM-DD." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many companies. Each company costs one search request plus, if full profiles are enabled, one more request.", "default": 100 }, "fetchFullProfile": { "title": "Fetch full company profile", "type": "boolean", "description": "Make an extra request per company to get the complete profile — accounts due dates, confirmation statement dates, insolvency and charges flags, previous names. Turn this off to run roughly twice as fast when the search fields alone are enough.", "default": true }, "requestIntervalMs": { "title": "Delay between requests (ms)", "minimum": 100, "maximum": 10000, "type": "integer", "description": "Companies House allows 600 requests per five minutes, which is 2 per second. The default of 550ms stays safely under that. Lower it only if you know your key has a raised limit.", "default": 550 }, "maxRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a failed request before giving up on that company. Rate-limit responses are always retried after the delay Companies House asks for.", "default": 5 } } }, "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 } } }, "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 } } } } } } } } } }