{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper", "description": "Use this when you need UK companies from the official Companies House register: new incorporations, companies by name, SIC code, location, status or type, with registered address, SIC codes, accounts dates and officers (directors). Uses your free Companies House API key. Pay per result.", "version": "0.1", "x-build-id": "dam1ZLGphpK9NrJA4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hexadatalabs~uk-companies-house-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hexadatalabs-uk-companies-house-scraper", "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/hexadatalabs~uk-companies-house-scraper/runs": { "post": { "operationId": "runs-sync-hexadatalabs-uk-companies-house-scraper", "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/hexadatalabs~uk-companies-house-scraper/run-sync": { "post": { "operationId": "run-sync-hexadatalabs-uk-companies-house-scraper", "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", "required": [ "apiKey" ], "properties": { "apiKey": { "title": "Companies House API key", "type": "string", "description": "Your free REST API key from https://developer.company-information.service.gov.uk/get-started (Developer Hub → your application → Keys → REST API key, Live environment, no IP restriction). Required." }, "searchQueries": { "title": "Company name contains", "type": "array", "description": "Words the company name must contain, one search per line, e.g. \"software\", \"solar\", \"dental\". Leave empty to filter only by SIC code, location or dates.", "items": { "type": "string" } }, "companyNameExcludes": { "title": "Company name excludes", "type": "string", "description": "Words the company name must not contain, e.g. \"holdings\"." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "UK SIC 2007 codes (5 digits), e.g. 62012 = business and domestic software development, 62020 = IT consultancy, 41100 = development of building projects, 56101 = licensed restaurants. List: https://resources.companieshouse.gov.uk/sic/", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Registered-office location as free text: a town, county or postcode area, e.g. \"London\", \"Manchester\", \"Cardiff\", \"SW1\"." }, "companyStatus": { "title": "Company status", "enum": [ "active", "any", "dissolved", "liquidation", "administration", "receivership", "voluntary-arrangement", "insolvency-proceedings" ], "type": "string", "description": "Use \"active\" for companies currently trading, \"dissolved\" for closed ones, or \"any\".", "default": "active" }, "companyTypes": { "title": "Company types", "type": "array", "description": "Companies House type codes, e.g. ltd (private limited), plc, llp, limited-partnership, private-limited-guarant-nsc (limited by guarantee), charitable-incorporated-organisation, registered-overseas-entity. Empty = all types.", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only companies incorporated on or after this date (YYYY-MM-DD), e.g. 2026-10-01 for new companies. With no other filter, the last 7 days are used." }, "incorporatedTo": { "title": "Incorporated until", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only companies incorporated on or before this date (YYYY-MM-DD)." }, "onlyNewSinceLastRun": { "title": "Only new since last run", "type": "boolean", "description": "Use this on a schedule: the Actor remembers when it last ran (shared store \"hexadata-uk-companies-house\" in your account) and returns only companies incorporated since then that it has not delivered before. The first run saves everything that matches.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many companies. Searches with more than 10,000 matches are split by incorporation date automatically.", "default": 100 }, "includeDetails": { "title": "Include company profile", "type": "boolean", "description": "One extra API request per company: accounts and confirmation-statement due dates, previous names, charges and insolvency flags, jurisdiction. Charged as a detail request.", "default": false }, "includeOfficers": { "title": "Include officers (directors)", "type": "boolean", "description": "One extra API request per company: current and resigned officers with name, role, appointment dates, nationality, country of residence and occupation (never birth dates or home addresses). Officers are named individuals; turn on only if you have a lawful basis to use them. Charged as a detail request.", "default": false }, "includeRaw": { "title": "Include raw API records", "type": "boolean", "description": "Attach the original search hit under \"raw\".", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed for the Companies House API; leave it off (your API key may be restricted to fixed IPs).", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }