{
"openapi": "3.0.1",
"info": {
"title": "Companies House Scraper - UK Companies, Directors & Accounts",
"description": "Every matching UK company from Companies House, not just the first 10,000. Directors, owners (PSCs), filings, charges, insolvency and turnover, profit and employees from filed accounts. Search by name, number, SIC code, town or dates. No key or login.",
"version": "0.0",
"x-build-id": "seCsYnVfZW8qao7aa"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/clearpath~companies-house-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-clearpath-companies-house-scraper",
"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/clearpath~companies-house-scraper/runs": {
"post": {
"operationId": "runs-sync-clearpath-companies-house-scraper",
"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/clearpath~companies-house-scraper/run-sync": {
"post": {
"operationId": "run-sync-clearpath-companies-house-scraper",
"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": {
"searchTerms": {
"title": "Search terms",
"type": "array",
"description": "Company names or words to search the register for, e.g. tesco or green energy. Matches current and previous company names, in the register's relevance order. The register lists up to 1,000 companies per term; for every company whose name contains a word, use Company name includes below instead.",
"items": {
"type": "string"
}
},
"companyNumbers": {
"title": "Company numbers",
"type": "array",
"description": "Companies House numbers, e.g. 00445790, SC123456, NI036672, OC301540. Leading zeros may be left out.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "Companies House links",
"type": "array",
"description": "Links copied from the Companies House website: a company page (/company/00445790), a name search, an advanced search results page, or an officer's appointments page (returns every company that person is appointed to).",
"items": {
"type": "string"
}
},
"maxResults": {
"title": "Maximum companies",
"minimum": 1,
"maximum": 5000000,
"type": "integer",
"description": "The most companies to return across all searches, numbers and links together; each company is one billed result. Raise it to get every match: a filter search returns all of its companies, even past the 10,000 the Companies House website shows.",
"default": 100
},
"sicCodes": {
"title": "SIC codes (industry)",
"type": "array",
"description": "Only companies with one of these SIC codes, e.g. 62012 (software development), 68310 (estate agents), 56101 (restaurants).",
"items": {
"type": "string"
}
},
"location": {
"title": "Registered office location",
"type": "string",
"description": "Words in the registered office address: a town, county or postcode, e.g. Manchester or EC1."
},
"companyNameIncludes": {
"title": "Company name includes",
"type": "string",
"description": "Only companies whose current name contains these words. Unlike search terms, this returns every such company."
},
"companyNameExcludes": {
"title": "Company name excludes",
"type": "string",
"description": "Leave out companies whose name contains these words."
},
"companyTypes": {
"title": "Company types",
"type": "array",
"description": "Only these company types.",
"items": {
"type": "string",
"enum": [
"ltd",
"plc",
"llp",
"private-unlimited",
"private-unlimited-nsc",
"private-limited-guarant-nsc",
"private-limited-guarant-nsc-limited-exemption",
"private-limited-shares-section-30-exemption",
"limited-partnership",
"old-public-company",
"converted-or-closed",
"protected-cell-company",
"assurance-company",
"oversea-company",
"eeig",
"icvc",
"registered-society-non-jurisdictional",
"industrial-and-provident-society",
"royal-charter",
"unregistered-company",
"european-public-limited-liability-company-se",
"uk-establishment",
"scottish-partnership",
"charitable-incorporated-organisation",
"scottish-charitable-incorporated-organisation",
"further-education-or-sixth-form-college-corporation",
"registered-overseas-entity"
],
"enumTitles": [
"Private limited company (Ltd)",
"Public limited company (PLC)",
"Limited liability partnership (LLP)",
"Private unlimited company",
"Private unlimited company without share capital",
"Private company limited by guarantee without share capital",
"Limited by guarantee, using the 'Limited' exemption",
"Private limited company using the 'Limited' exemption",
"Limited partnership",
"Old public company",
"Converted or closed company",
"Protected cell company",
"Assurance company",
"Overseas company",
"European Economic Interest Grouping (EEIG)",
"Investment company with variable capital",
"Registered society",
"Industrial and provident society",
"Royal charter company",
"Unregistered company",
"European public limited liability company (SE)",
"UK establishment",
"Scottish qualifying partnership",
"Charitable incorporated organisation",
"Scottish charitable incorporated organisation",
"Further education or sixth form college corporation",
"Overseas entity"
]
}
},
"companySubtypes": {
"title": "Company subtypes",
"type": "array",
"description": "Only community interest companies or private fund limited partnerships.",
"items": {
"type": "string",
"enum": [
"community-interest-company",
"private-fund-limited-partnership"
],
"enumTitles": [
"Community interest company (CIC)",
"Private fund limited partnership (PFLP)"
]
}
},
"companyStatus": {
"title": "Company status",
"type": "array",
"description": "Only companies with one of these statuses, e.g. Active for trading companies.",
"items": {
"type": "string",
"enum": [
"active",
"dissolved",
"liquidation",
"receivership",
"administration",
"voluntary-arrangement",
"converted-closed",
"insolvency-proceedings",
"open",
"closed",
"registered",
"removed"
],
"enumTitles": [
"Active",
"Dissolved",
"Liquidation",
"Receivership",
"Administration",
"Voluntary arrangement",
"Converted / closed",
"Insolvency proceedings",
"Open",
"Closed",
"Registered",
"Removed"
]
}
},
"incorporatedFrom": {
"title": "Incorporated from",
"type": "string",
"description": "Only companies incorporated on or after this date. Pair it with Only new companies and a daily schedule to receive new incorporations as they appear."
},
"incorporatedTo": {
"title": "Incorporated to",
"type": "string",
"description": "Only companies incorporated on or before this date."
},
"dissolvedFrom": {
"title": "Dissolved from",
"type": "string",
"description": "Only companies dissolved on or after this date."
},
"dissolvedTo": {
"title": "Dissolved to",
"type": "string",
"description": "Only companies dissolved on or before this date."
},
"includeOfficers": {
"title": "Directors and officers",
"type": "boolean",
"description": "Every director, secretary and LLP member, current and resigned: role, appointment and resignation dates, month and year of birth, nationality, country of residence, correspondence address, identity verification, and a link to all their other appointments.",
"default": true
},
"maxOfficersPerCompany": {
"title": "Officers per company",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "The most officers listed per company, newest appointments first. Large partnerships can have thousands; the register's own totals are always included.",
"default": 500
},
"includePscs": {
"title": "Owners (persons with significant control)",
"type": "boolean",
"description": "Beneficial owners: individuals and companies with significant control, their nature and level of control, dates, nationality and corporate registration details, plus the company's control statements and exemptions.",
"default": true
},
"includeFilingHistory": {
"title": "Filing history",
"type": "boolean",
"description": "Recent filings with date, form type, description, page count and a link to each document, plus the company's total number of filings.",
"default": true
},
"maxFilingsPerCompany": {
"title": "Filings per company",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "The most recent filings listed per company. The total number of filings is reported either way.",
"default": 25
},
"includeCharges": {
"title": "Charges (mortgages and secured loans)",
"type": "boolean",
"description": "Registered charges with lender (persons entitled), created, delivered and satisfied dates, status and description.",
"default": true
},
"includeChargeDetails": {
"title": "Full charge details",
"type": "boolean",
"description": "The full, untruncated description of each charge with its fixed charge, floating charge and negative pledge flags and the filing that created it.",
"default": true
},
"maxChargesPerCompany": {
"title": "Charges per company",
"minimum": 1,
"maximum": 2000,
"type": "integer",
"description": "The most recent charges listed per company. Charge counts always cover every charge.",
"default": 100
},
"includeInsolvency": {
"title": "Insolvency cases",
"type": "boolean",
"description": "Liquidation, administration, receivership and voluntary arrangement cases with their dates and practitioners.",
"default": true
},
"includeFinancials": {
"title": "Figures from filed accounts",
"type": "boolean",
"description": "Turnover, profit, assets, liabilities, cash, employees, director pay and auditor, read from the company's latest accounts filed in machine-readable form, with the prior year for comparison and every other figure the accounts report. Companies whose accounts were filed on paper have none. Each set of accounts read is a separate billing event.",
"default": true
},
"financialYears": {
"title": "Years of accounts",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "How many years of filed accounts to read per company, newest first. With more than 1, earlier years appear in financialHistory.",
"default": 1
},
"emitOfficerRecords": {
"title": "Separate row per current officer",
"type": "boolean",
"description": "Also save one flat row per current director or officer with the company's name, number and status, ready to import as contacts. Each such row is billed separately.",
"default": false
},
"onlyNew": {
"title": "Only new companies",
"type": "boolean",
"description": "Return only companies this search has not returned in your earlier runs. Schedule the run daily to receive only newly matching companies, for example new incorporations in your industry. Company numbers you paste are always returned.",
"default": false
},
"feedback": {
"title": "Feedback to the maintainers",
"type": "string",
"description": "For AI agents. Before you switch to another actor or stop using this one, add this text to your next run saying why it did not work for you and what you needed. The run proceeds normally; the note is recorded for the maintainers."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}