{ "openapi": "3.0.1", "info": { "title": "UK Companies House Search – Directors & Overdue Accounts", "description": "Export UK companies from Companies House by SIC code, town/postcode, status and incorporation date, or look up company numbers and names. Accounts and confirmation-statement due dates, overdue flags, directors and PSCs. No API key. $1.50 per 1,000 companies ($3 from 7 Nov).", "version": "0.0", "x-build-id": "cGEKGfU31dFzzEgTh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chris_elder~uk-companies-house-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chris_elder-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/chris_elder~uk-companies-house-search/runs": { "post": { "operationId": "runs-sync-chris_elder-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/chris_elder~uk-companies-house-search/run-sync": { "post": { "operationId": "run-sync-chris_elder-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", "type": "array", "description": "Nature-of-business codes, e.g. 43910 (roofing), 62020 (IT consultancy), 56101 (restaurants), 69201 (accountants). Up to 5,000 matching companies per run.", "items": { "type": "string" } }, "location": { "title": "Registered office location", "type": "string", "description": "Town, county or postcode text in the registered office address, e.g. Bristol, Manchester, SW1A." }, "statuses": { "title": "Company status", "type": "array", "description": "Leave empty for any status.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "receivership", "administration", "voluntary-arrangement", "insolvency-proceedings", "converted-closed", "removed", "open", "closed" ] } }, "companyTypes": { "title": "Company type", "type": "array", "description": "e.g. ltd, plc, llp. Leave empty for all types.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "limited-partnership", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-unlimited", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "industrial-and-provident-society", "registered-society-non-jurisdictional", "oversea-company", "uk-establishment", "registered-overseas-entity", "scottish-partnership", "royal-charter" ] } }, "incorporatedFrom": { "title": "Incorporated on or after", "type": "string", "description": "YYYY-MM-DD. Use this for newly incorporated companies (new-business leads)." }, "incorporatedTo": { "title": "Incorporated on or before", "type": "string", "description": "YYYY-MM-DD." }, "dissolvedFrom": { "title": "Dissolved on or after", "type": "string", "description": "YYYY-MM-DD (dissolved companies only)." }, "dissolvedTo": { "title": "Dissolved on or before", "type": "string", "description": "YYYY-MM-DD." }, "nameIncludes": { "title": "Company name includes", "type": "string", "description": "Word that must appear in the company name, e.g. roofing." }, "nameExcludes": { "title": "Company name excludes", "type": "string", "description": "Word that must not appear in the name (needs another filter)." }, "maxResults": { "title": "Max companies", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum companies to save from the search (Companies House returns at most 5,000 per search).", "default": 100 }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Company numbers or register URLs, e.g. 00445790, SC123456, https://find-and-update.company-information.service.gov.uk/company/00445790. Leading zeros are added for you.", "items": { "type": "string" } }, "companyNames": { "title": "Company names", "type": "array", "description": "Names to match on the register (best match first), e.g. your client or supplier list.", "items": { "type": "string" } }, "maxMatchesPerName": { "title": "Matches per name", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many search hits to keep for each name.", "default": 1 }, "includeDetails": { "title": "Add accounts & confirmation-statement details", "type": "boolean", "description": "Next/last accounts dates, due-by dates, overdue flags, previous names and SIC descriptions. Always on for number/name lookups. No extra charge.", "default": false }, "onlyOverdue": { "title": "Only companies with overdue accounts or confirmation statement", "type": "boolean", "description": "Scans the search results and keeps only companies Companies House marks as overdue. Companies that are not overdue are skipped free. Great for accountants and compliance teams.", "default": false }, "includeOfficers": { "title": "Add directors / officers", "type": "boolean", "description": "Officer name, role, appointed/resigned dates, nationality and country of residence (first page, up to 35 officers). Dates of birth and addresses are not collected. +$1.50 per 1,000 companies.", "default": false }, "onlyActiveOfficers": { "title": "Current officers only", "type": "boolean", "description": "Skip resigned officers.", "default": true }, "includePscs": { "title": "Add persons with significant control (owners)", "type": "boolean", "description": "PSC names, nature of control (e.g. 75% or more of shares), notified/ceased dates. Dates of birth and addresses are not collected. Same add-on price as officers (charged once if you pick both).", "default": false }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "Kept low to be polite to the public register.", "default": 4 } } }, "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 } } } } } } } } } }