{ "openapi": "3.0.1", "info": { "title": "UK Companies House Search: New Companies, Filings", "description": "Search the official UK Companies House register: new incorporations by date, SIC, status and town, company profiles with accounts and confirmation deadlines, overdue flags, insolvency and charges. No personal data. Failures free.", "version": "1.0", "x-build-id": "A8nCsxfhDXNhznmVF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/michael80~uk-companies-house-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-michael80-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/michael80~uk-companies-house-search/runs": { "post": { "operationId": "runs-sync-michael80-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/michael80~uk-companies-house-search/run-sync": { "post": { "operationId": "run-sync-michael80-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": { "incorporatedWithinDays": { "title": "Incorporated within the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Newly founded companies, e.g. 7 for last week's incorporations. Overrides 'Incorporated from'." }, "sicCodes": { "title": "SIC codes (industry)", "type": "array", "description": "5-digit UK SIC 2007 codes, e.g. 62012 (business software), 56101 (restaurants), 41100 (property development). Companies with any of these codes are returned.", "items": { "type": "string" } }, "companyStatus": { "title": "Company status", "type": "array", "description": "Optional, e.g. active. Several values allowed.", "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": "Optional, e.g. ltd, plc, llp.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "private-unlimited", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "limited-partnership", "scottish-partnership", "registered-society-non-jurisdictional", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "overseas-company", "uk-establishment", "royal-charter", "industrial-and-provident-society", "community-interest-company" ] } }, "location": { "title": "Town or postcode area", "type": "string", "description": "Optional: registered office location, e.g. Manchester or LS1." }, "companyNameIncludes": { "title": "Company name contains", "type": "string", "description": "Optional word that must appear in the company name, e.g. 'solar'." }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Optional start date (YYYY-MM-DD)." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Optional end date (YYYY-MM-DD)." }, "searchTerms": { "title": "Search by name", "type": "array", "description": "Optional: company names to search for (Companies House relevance search, up to 1,000 hits per term).", "items": { "type": "string" } }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Optional: look up specific companies, e.g. 00445790 or SC123456.", "items": { "type": "string" } }, "includeDetails": { "title": "Add filing deadlines and flags", "type": "boolean", "description": "Fetches each company profile: accounts and confirmation statement due dates, overdue flags, accounts type, insolvency history, charges, previous names. One extra request per company (slower, same price).", "default": true }, "maxResults": { "title": "Max. results per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Limit per name search and for the filter search (cost cap).", "default": 100 }, "onlyNew": { "title": "Only companies not delivered before", "type": "boolean", "description": "Remembers delivered company numbers and returns only new ones next time (known ones are free). Ideal for a daily 'new companies' lead feed.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Separate memory for different monitors (e.g. 'it-manchester')." }, "apiKey": { "title": "Companies House API key (optional)", "type": "string", "description": "Your own free key from developer.company-information.service.gov.uk (REST key). If empty, the Actor's built-in key is used. Stored encrypted." }, "selfTest": { "title": "Self-test", "type": "boolean", "description": "Ignore the input and fetch Tesco PLC plus a short name search to verify the Actor works.", "default": 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 } } } } } } } } } }