{
"openapi": "3.0.1",
"info": {
"title": "Companies House Company Search & Status — UK Register",
"description": "Search the UK Companies House register by name, company number, SIC code, location, type, status or incorporation date: status, address, SIC codes, filing due dates, charges, previous names. From the latest monthly Companies House snapshot (each record carries its date). OGL v3.0, company data only.",
"version": "0.1",
"x-build-id": "qMKga7xlmZvnlK7hT"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/nexgensignal~uk-company-status-records/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-nexgensignal-uk-company-status-records",
"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/nexgensignal~uk-company-status-records/runs": {
"post": {
"operationId": "runs-sync-nexgensignal-uk-company-status-records",
"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/nexgensignal~uk-company-status-records/run-sync": {
"post": {
"operationId": "run-sync-nexgensignal-uk-company-status-records",
"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": {
"searchQueries": {
"title": "Search company names",
"type": "array",
"description": "Words to find in company names (current and previous names), e.g. green energy, tesco. Every word of a search must appear. Several searches are combined (any one can match).",
"items": {
"type": "string"
}
},
"companyNumbers": {
"title": "Company numbers",
"type": "array",
"description": "Exact Companies House numbers to look up, e.g. 00445790, SC123456, OC301540. Numbers shorter than 8 digits are zero-padded. Numbers not on the register are listed in the run receipt and cost nothing.",
"items": {
"type": "string"
}
},
"sicCodes": {
"title": "SIC (industry) codes",
"type": "array",
"description": "Keep companies with any of these SIC codes, e.g. 62012 (software development), 56101 (restaurants). A shorter code matches the whole group: 620 = all computer programming and consultancy.",
"items": {
"type": "string"
}
},
"location": {
"title": "Location",
"type": "string",
"description": "Text in the registered office address: a town, county or postcode start, e.g. Manchester, EC1, SW1A."
},
"companyStatus": {
"title": "Company status",
"type": "array",
"description": "Keep only these statuses (leave empty for all). The register file lists live companies only — dissolved companies are not in it.",
"items": {
"type": "string",
"enum": [
"Active",
"Active - Proposal to Strike off",
"Liquidation",
"In Administration",
"Live but Receiver Manager on at least one charge",
"Voluntary Arrangement",
"In Administration/Administrative Receiver",
"RECEIVERSHIP",
"ADMINISTRATION ORDER",
"ADMINISTRATIVE RECEIVER",
"In Administration/Receiver Manager",
"RECEIVER MANAGER / ADMINISTRATIVE RECEIVER"
],
"enumTitles": [
"Active",
"Active - Proposal to Strike off",
"Liquidation",
"In Administration",
"Live but Receiver Manager on at least one charge",
"Voluntary Arrangement",
"In Administration/Administrative Receiver",
"RECEIVERSHIP",
"ADMINISTRATION ORDER",
"ADMINISTRATIVE RECEIVER",
"In Administration/Receiver Manager",
"RECEIVER MANAGER / ADMINISTRATIVE RECEIVER"
]
}
},
"companyTypes": {
"title": "Company types",
"type": "array",
"description": "Keep only these company types (leave empty for all).",
"items": {
"type": "string",
"enum": [
"Private Limited Company",
"Public Limited Company",
"Limited Liability Partnership",
"Limited Partnership",
"Scottish Partnership",
"PRI/LTD BY GUAR/NSC (Private, limited by guarantee, no share capital)",
"PRI/LBG/NSC (Private, Limited by guarantee, no share capital, use of 'Limited' exemption)",
"Community Interest Company",
"Charitable Incorporated Organisation",
"Scottish Charitable Incorporated Organisation",
"Overseas Entity",
"Private Unlimited Company",
"Private Unlimited",
"Registered Society",
"Industrial and Provident Society",
"Royal Charter Company",
"Investment Company with Variable Capital",
"Investment Company with Variable Capital(Umbrella)",
"United Kingdom Economic Interest Grouping",
"Old Public Company",
"Other company type"
],
"enumTitles": [
"Private Limited Company",
"Public Limited Company",
"Limited Liability Partnership",
"Limited Partnership",
"Scottish Partnership",
"PRI/LTD BY GUAR/NSC (Private, limited by guarantee, no share capital)",
"PRI/LBG/NSC (Private, Limited by guarantee, no share capital, use of 'Limited' exemption)",
"Community Interest Company",
"Charitable Incorporated Organisation",
"Scottish Charitable Incorporated Organisation",
"Overseas Entity",
"Private Unlimited Company",
"Private Unlimited",
"Registered Society",
"Industrial and Provident Society",
"Royal Charter Company",
"Investment Company with Variable Capital",
"Investment Company with Variable Capital(Umbrella)",
"United Kingdom Economic Interest Grouping",
"Old Public Company",
"Other company type"
]
}
},
"incorporatedFrom": {
"title": "Incorporated from",
"type": "string",
"description": "Only companies incorporated on or after this date (YYYY-MM-DD). Good for lists of new businesses."
},
"incorporatedTo": {
"title": "Incorporated to",
"type": "string",
"description": "Only companies incorporated on or before this date (YYYY-MM-DD)."
},
"companyNameExcludes": {
"title": "Exclude names containing",
"type": "array",
"description": "Drop companies whose name contains any of these words, e.g. DORMANT, HOLDINGS.",
"items": {
"type": "string"
}
},
"companyNumberPrefix": {
"title": "Company number prefix",
"type": "string",
"description": "Keep companies whose number starts with this, e.g. SC (Scotland), NI (Northern Ireland), OC (LLPs)."
},
"namePrefix": {
"title": "Company name starts with",
"type": "string",
"description": "Keep companies whose name starts with this text."
},
"newOnly": {
"title": "New companies only (monitoring)",
"type": "boolean",
"description": "Deliver only companies this same search has not delivered before. Run it on an Apify schedule to get just the matches it hasn't sent yet; already-delivered companies are skipped and not charged. \"New\" means new to this search, not newly incorporated — pair it with Newest incorporations first when a search matches more companies than Maximum records.",
"default": false
},
"newestFirst": {
"title": "Newest incorporations first",
"type": "boolean",
"description": "Deliver the most recently incorporated matching companies, newest first. The run reads the whole register file and keeps the newest Maximum records (you are charged only for those). Off: matches come in the register file's order.",
"default": false
},
"maxRecords": {
"title": "Maximum records",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "Most companies delivered and billed in one run.",
"default": 10
}
}
},
"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
}
}
}
}
}
}
}
}
}
}