{
"openapi": "3.0.1",
"info": {
"title": "UK Companies House: Companies, Directors, Owners & Filings",
"description": "Export UK companies from the official Companies House API: profiles, name and advanced search (SIC code, location, status, incorporation dates), directors/officers, persons with significant control, filing history and charges. Bring your own free API key.",
"version": "1.0",
"x-build-id": "2xv748PNuyoBh6oi9"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/cleanfeed-data~uk-companies-house/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-cleanfeed-data-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/cleanfeed-data~uk-companies-house/runs": {
"post": {
"operationId": "runs-sync-cleanfeed-data-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/cleanfeed-data~uk-companies-house/run-sync": {
"post": {
"operationId": "run-sync-cleanfeed-data-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": {
"apiKey": {
"title": "Companies House API key",
"type": "string",
"description": "Your own free Companies House REST API key. Get one in about 2 minutes: sign in at developer.company-information.service.gov.uk → Your applications → Create an application (choose Live) → Create new key (type REST). Stored encrypted by Apify and sent only to Companies House. Each key allows 600 requests per 5 minutes; the actor stays under that automatically."
},
"companyNumbers": {
"title": "Company numbers or URLs",
"type": "array",
"description": "Company numbers (e.g. 00445790, SC123456, OC301234; leading zeros optional) or Companies House company page URLs. Each one returns the full company profile.",
"items": {
"type": "string"
}
},
"searchQueries": {
"title": "Search companies by name",
"type": "array",
"description": "Company names or keywords, searched with the official Companies House search (same ranking as the register's search box).",
"items": {
"type": "string"
}
},
"maxResultsPerSearch": {
"title": "Max results per name search",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "Companies to take from each name search (Companies House returns at most 1,000 per query).",
"default": 20
},
"activeOnlySearch": {
"title": "Name search: active companies only",
"type": "boolean",
"description": "Restrict name searches to active companies.",
"default": false
},
"companyNameIncludes": {
"title": "Name includes",
"type": "string",
"description": "Company name must contain this text."
},
"companyNameExcludes": {
"title": "Name excludes",
"type": "string",
"description": "Company name must not contain this text."
},
"sicCodes": {
"title": "SIC codes",
"type": "array",
"description": "5-digit SIC 2007 codes, e.g. 62012 (software development), 56101 (restaurants), 41100 (property development). Matches any of the listed codes.",
"items": {
"type": "string"
}
},
"location": {
"title": "Location",
"type": "string",
"description": "Town, city, county or postcode district of the registered office, e.g. Manchester or SW1A."
},
"companyStatus": {
"title": "Company status",
"type": "array",
"description": "Leave empty for any status.",
"items": {
"type": "string",
"enum": [
"active",
"dissolved",
"liquidation",
"receivership",
"administration",
"voluntary-arrangement",
"converted-closed",
"insolvency-proceedings",
"registered",
"removed",
"closed",
"open"
],
"enumTitles": [
"Active",
"Dissolved",
"Liquidation",
"Receiver Action",
"In Administration",
"Voluntary Arrangement",
"Converted / Closed",
"Insolvency Proceedings",
"Registered",
"Removed",
"Closed",
"Open"
]
}
},
"companyType": {
"title": "Company type",
"type": "array",
"description": "Leave empty for any type. Private limited company = ltd.",
"items": {
"type": "string",
"enum": [
"private-unlimited",
"ltd",
"plc",
"old-public-company",
"private-limited-guarant-nsc-limited-exemption",
"limited-partnership",
"private-limited-guarant-nsc",
"converted-or-closed",
"private-unlimited-nsc",
"private-limited-shares-section-30-exemption",
"protected-cell-company",
"assurance-company",
"oversea-company",
"eeig-establishment",
"icvc-securities",
"icvc-warrant",
"icvc-umbrella",
"registered-society-non-jurisdictional",
"industrial-and-provident-society",
"northern-ireland",
"northern-ireland-other",
"llp",
"royal-charter",
"investment-company-with-variable-capital",
"unregistered-company",
"other",
"european-public-limited-liability-company-se",
"united-kingdom-societas",
"uk-establishment",
"scottish-partnership",
"charitable-incorporated-organisation",
"scottish-charitable-incorporated-organisation",
"further-education-or-sixth-form-college-corporation",
"eeig",
"ukeig",
"registered-overseas-entity"
],
"enumTitles": [
"Private unlimited company",
"Private limited company",
"Public limited company",
"Old public company",
"Private Limited Company by guarantee without share capital, use of 'Limited' exemption",
"Limited partnership",
"Private limited by guarantee without share capital",
"Converted / closed",
"Private unlimited company without share capital",
"Private Limited Company, use of 'Limited' exemption",
"Protected cell company",
"Assurance company",
"Overseas company",
"European Economic Interest Grouping Establishment (EEIG)",
"Investment company with variable capital",
"Investment company with variable capital",
"Investment company with variable capital",
"Registered society",
"Industrial and Provident society",
"Northern Ireland company",
"Credit union (Northern Ireland)",
"Limited liability partnership",
"Royal charter company",
"Investment company with variable capital",
"Unregistered company",
"Other company type",
"European public limited liability company (SE)",
"United Kingdom Societas",
"UK establishment company",
"Scottish qualifying partnership",
"Charitable incorporated organisation",
"Scottish charitable incorporated organisation",
"Further education or sixth form college corporation",
"European Economic Interest Grouping (EEIG)",
"United Kingdom Economic Interest Grouping",
"Overseas entity"
]
}
},
"incorporatedWithinDays": {
"title": "Incorporated within the last N days",
"minimum": 0,
"type": "integer",
"description": "Shortcut for new-company leads: only companies incorporated in the last N days. 0 = off. Great for scheduled runs.",
"default": 0
},
"incorporatedFrom": {
"title": "Incorporated from",
"type": "string",
"description": "YYYY-MM-DD"
},
"incorporatedTo": {
"title": "Incorporated to",
"type": "string",
"description": "YYYY-MM-DD"
},
"dissolvedFrom": {
"title": "Dissolved from",
"type": "string",
"description": "YYYY-MM-DD (dissolved companies)"
},
"dissolvedTo": {
"title": "Dissolved to",
"type": "string",
"description": "YYYY-MM-DD"
},
"maxAdvancedResults": {
"title": "Max advanced-search results",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Companies to take from the advanced search.",
"default": 100
},
"enrichWithProfile": {
"title": "Full profile for search results",
"type": "boolean",
"description": "On: every search hit is upgraded to the full company profile (accounts and confirmation-statement dates, overdue flags, previous names, charges/insolvency flags). Off: search hits are saved as cheaper 'company-summary' rows with name, number, status, type, dates, address and (advanced search) SIC codes.",
"default": true
},
"includeOfficers": {
"title": "Officers (directors, secretaries, LLP members)",
"type": "boolean",
"description": "One 'officer' row per appointment, plus active director names on the company row.",
"default": false
},
"includeResignedOfficers": {
"title": "Include resigned officers",
"type": "boolean",
"description": "Also return officers who have resigned (with resignedOn dates).",
"default": false
},
"maxOfficersPerCompany": {
"title": "Max officers per company",
"minimum": 0,
"maximum": 5000,
"type": "integer",
"description": "Cap on officer rows per company.",
"default": 100
},
"includePsc": {
"title": "Persons with significant control (owners)",
"type": "boolean",
"description": "One 'psc' row per beneficial owner / controlling entity, with ownership and voting bands.",
"default": false
},
"includeCeasedPsc": {
"title": "Include ceased PSCs",
"type": "boolean",
"description": "Also return PSCs who have ceased to have control.",
"default": false
},
"includeFilingHistory": {
"title": "Filing history",
"type": "boolean",
"description": "One 'filing' row per filing, newest first, with a readable description and a document link.",
"default": false
},
"filingCategories": {
"title": "Filing categories",
"type": "array",
"description": "Only these filing categories. Empty = 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",
"gazette"
],
"enumTitles": [
"Accounts",
"Registered office address",
"Annual return",
"Capital / shares",
"Change of name",
"Incorporation",
"Liquidation",
"Miscellaneous",
"Charges (mortgage)",
"Officers",
"Resolutions",
"Confirmation statement",
"Persons with significant control",
"Insolvency",
"Gazette notices"
]
}
},
"maxFilingsPerCompany": {
"title": "Max filings per company",
"minimum": 0,
"maximum": 5000,
"type": "integer",
"description": "Newest filings first; cap per company.",
"default": 25
},
"includeCharges": {
"title": "Charges (mortgages / secured lending)",
"type": "boolean",
"description": "One 'charge' row per charge, with lender (persons entitled), status and dates.",
"default": false
},
"maxChargesPerCompany": {
"title": "Max charges per company",
"minimum": 0,
"maximum": 5000,
"type": "integer",
"description": "Cap on charge rows per company.",
"default": 50
},
"maxCompanies": {
"title": "Max companies per run",
"minimum": 0,
"type": "integer",
"description": "Overall cap on companies across all inputs. 0 = no cap.",
"default": 0
},
"maxConcurrency": {
"title": "Parallel requests",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Companies processed in parallel. The rate limit is enforced regardless.",
"default": 4
},
"requestsPer5Minutes": {
"title": "Requests per 5 minutes",
"minimum": 10,
"maximum": 100000,
"type": "integer",
"description": "Request budget per 5-minute window for your key. Companies House allows 600 by default; keep some headroom if the key is used elsewhere. Raise only if Companies House granted your key a higher limit.",
"default": 550
}
}
},
"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
}
}
}
}
}
}
}
}
}
}