{ "openapi": "3.0.1", "info": { "title": "UK Companies House Company Profiles and Filings", "description": "Returns UK company data from the official Companies House register as flat JSON: status, type, incorporation date, SIC industry, registered town/postcode, accounts and confirmation deadlines, overdue flags, charges, insolvency and recent filings. Look up by number, name, SIC or date.", "version": "0.1", "x-build-id": "97Gic4lR67hxkBUfk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/studded_lantana~uk-company-profile/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-studded_lantana-uk-company-profile", "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/studded_lantana~uk-company-profile/runs": { "post": { "operationId": "runs-sync-studded_lantana-uk-company-profile", "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/studded_lantana~uk-company-profile/run-sync": { "post": { "operationId": "run-sync-studded_lantana-uk-company-profile", "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": { "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Companies House registration numbers to look up, e.g. \"00445790\" or \"SC123456\". Leading zeros may be left out (\"445790\" works). Each returns the full profile. Leave empty to search instead.", "items": { "type": "string" } }, "searchQuery": { "title": "Company name search", "type": "string", "description": "Find companies by name, e.g. \"coffee roasters\". Used alone, it runs the register's name search (best matches first). Combined with any filter below, it matches names containing these words. Leave empty to look up company numbers only." }, "incorporatedFrom": { "title": "Incorporated on or after", "type": "string", "description": "Only companies incorporated on or after this date (YYYY-MM-DD), e.g. \"2026-10-01\". Pair with \"Incorporated on or before\" to list new companies for a week. Leave empty for no lower bound." }, "incorporatedTo": { "title": "Incorporated on or before", "type": "string", "description": "Only companies incorporated on or before this date (YYYY-MM-DD), e.g. \"2026-10-07\". Leave empty for no upper bound." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "UK SIC 2007 industry codes; matches companies with any of them, e.g. [\"62012\", \"62020\"] for software and IT consultancy. Leave empty for all industries.", "items": { "type": "string" } }, "location": { "title": "Registered office location", "type": "string", "description": "Town, city or postcode area of the registered office, e.g. \"Manchester\" or \"LS1\". Leave empty for anywhere in the UK." }, "companyStatuses": { "title": "Company status", "type": "array", "description": "Only companies with these statuses, e.g. [\"active\"]. Leave empty for any status.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "receivership", "administration", "voluntary-arrangement", "converted-closed", "insolvency-proceedings", "registered", "removed", "closed", "open" ] } }, "companyTypes": { "title": "Company type", "type": "array", "description": "Only these legal forms, e.g. [\"ltd\"] for private limited companies. Leave empty for all types.", "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", "oversea-company", "uk-establishment", "royal-charter" ] } }, "fullProfiles": { "title": "Full profiles for search results", "type": "boolean", "description": "Search results include name, number, status, type, incorporation date, SIC codes and town/postcode. Turn on to also get accounts and confirmation-statement dates, overdue flags, charges, insolvency history and previous names (slower: one extra lookup per company). Company-number lookups always return full profiles.", "default": false }, "filingsPerCompany": { "title": "Filings per company", "minimum": 0, "maximum": 100, "type": "integer", "description": "How many recent filings (newest first) to include for each full profile, 0-100, e.g. 10. Each filing has date, form type, readable description and a link to the PDF on Companies House. 0 = none.", "default": 0 }, "filingCategories": { "title": "Filing categories", "type": "array", "description": "Only include filings of these categories, e.g. [\"accounts\", \"confirmation-statement\"]. Leave empty for all.", "items": { "type": "string", "enum": [ "accounts", "address", "annual-return", "capital", "change-of-name", "incorporation", "liquidation", "miscellaneous", "mortgage", "officers", "resolution", "confirmation-statement", "persons-with-significant-control", "insolvency" ] } }, "maxItems": { "title": "Max companies", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many companies, e.g. 100. You are charged per company returned.", "default": 100 } } }, "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 } } } } } } } } } }