{ "openapi": "3.0.1", "info": { "title": "Companies House API: UK Company Search & New Companies", "description": "UK Companies House search via the official API: company profiles, SIC codes, registered office, accounts and confirmation-statement dates, filing history, charges, and daily new incorporations by SIC code, location and date. Company-level data only.", "version": "0.1", "x-build-id": "jXe0tyMpSA4xGCyco" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/postatelier~uk-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-postatelier-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/postatelier~uk-companies-house/runs": { "post": { "operationId": "runs-sync-postatelier-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/postatelier~uk-companies-house/run-sync": { "post": { "operationId": "run-sync-postatelier-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": { "queries": { "title": "Company names or numbers", "type": "array", "description": "One per line. Company numbers (e.g. 00445790, SC123456, OC301234) return that company; names return the best matches.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max matches per name", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many best-matching companies to return for each name.", "default": 5 }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Find companies by UK SIC 2007 code, e.g. 62012 (business and domestic software development), 56101 (licensed restaurants). Leave empty to skip the filtered search.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Town, county or postcode area of the registered office, e.g. \"Manchester\"." }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "YYYY-MM-DD" }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "YYYY-MM-DD" }, "incorporatedWithinDays": { "title": "Incorporated within the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Rolling window instead of fixed dates, e.g. 7. Best for daily monitoring: each run only pages recent incorporations." }, "companyStatus": { "title": "Company status", "type": "array", "description": "Leave empty for any status.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "administration", "receivership", "voluntary-arrangement", "insolvency-proceedings", "open", "closed", "converted-closed", "registered", "removed" ] } }, "companyType": { "title": "Company type", "type": "array", "description": "Leave empty for any type.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "private-unlimited", "private-limited-guarant-nsc", "limited-partnership", "charitable-incorporated-organisation", "oversea-company", "registered-society-non-jurisdictional" ] } }, "nameIncludes": { "title": "Name includes", "type": "string", "description": "Only companies whose name contains this text." }, "nameExcludes": { "title": "Name excludes", "type": "string", "description": "Skip companies whose name contains this text." }, "dissolvedFrom": { "title": "Dissolved from", "type": "string", "description": "YYYY-MM-DD" }, "dissolvedTo": { "title": "Dissolved to", "type": "string", "description": "YYYY-MM-DD" }, "maxResults": { "title": "Max companies from filtered search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Upper limit for the filtered search (the register can return thousands).", "default": 100 }, "fullProfile": { "title": "Full company profile", "type": "boolean", "description": "Fetch the full profile (accounts and confirmation-statement dates, previous names, insolvency flags) for every company. Turn off for fast, large lead lists: you still get name, number, status, type, address, SIC codes and incorporation date.", "default": true }, "includeFilings": { "title": "Include filing history", "type": "boolean", "description": "Add the most recent filings (date, type, description, document link).", "default": false }, "maxFilings": { "title": "Max filings per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many recent filings to include per company.", "default": 10 }, "includeCharges": { "title": "Include charges (mortgages)", "type": "boolean", "description": "Add registered charges: status, type, dates and the lending organisations.", "default": false }, "onlyNew": { "title": "Only new companies (monitoring)", "type": "boolean", "description": "Skip companies this monitor already returned in earlier runs. Schedule the Actor daily to get only fresh incorporations or changes in your list. You are not charged for skipped companies.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Keeps separate memory per monitor, e.g. \"manchester-software\".", "default": "default" }, "apiKey": { "title": "Your own Companies House API key (optional)", "type": "string", "description": "Not needed. For very large jobs you can use your own free key from developer.company-information.service.gov.uk to get your own rate limit." }, "selfCheck": { "title": "Self-check (maintainer)", "type": "boolean", "description": "Maintainer health check. Leave off.", "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 } } } } } } } } } }