{
"openapi": "3.0.1",
"info": {
"title": "Companies House Scraper: New UK Companies & Directors",
"description": "Export UK Companies House data from the official register: newly incorporated companies by SIC code, town and date, or lookups by company number or name. Optional directors and beneficial owners (PSC). Daily new-company alerts. No API key needed. Export CSV, Excel, JSON.",
"version": "1.0",
"x-build-id": "M49jpi0yfeRyfWhIB"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/studded_columbine~uk-companies-house-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-studded_columbine-uk-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/studded_columbine~uk-companies-house-scraper/runs": {
"post": {
"operationId": "runs-sync-studded_columbine-uk-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/studded_columbine~uk-companies-house-scraper/run-sync": {
"post": {
"operationId": "run-sync-studded_columbine-uk-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",
"required": [
"mode"
],
"properties": {
"mode": {
"title": "Mode",
"enum": [
"search",
"lookup"
],
"type": "string",
"description": "Search: build lead lists with Companies House advanced search (SIC code, location, incorporation date, status, type, name). Lookup: fetch specific companies by number, Companies House URL or name.",
"default": "search"
},
"sicCodes": {
"title": "SIC codes (industry)",
"type": "array",
"description": "SIC 2007 codes or prefixes. \"62\" = all computer programming & IT, \"6201\" = 62011 + 62012, \"56101\" = licensed restaurants, \"41202\" = domestic building construction.",
"items": {
"type": "string"
}
},
"location": {
"title": "Location",
"type": "string",
"description": "Registered office location text, e.g. a town, county or postcode area (\"Manchester\", \"Kent\", \"EC1V\")."
},
"incorporatedWithinDays": {
"title": "Incorporated in the last N days",
"minimum": 1,
"maximum": 3650,
"type": "integer",
"description": "Shortcut for new-company lead lists and daily alerts. Overrides 'Incorporated from'."
},
"incorporatedFrom": {
"title": "Incorporated from",
"type": "string",
"description": "YYYY-MM-DD"
},
"incorporatedTo": {
"title": "Incorporated to",
"type": "string",
"description": "YYYY-MM-DD"
},
"companyStatus": {
"title": "Company status",
"type": "array",
"description": "Default: active only. Clear it to include every status.",
"items": {
"type": "string",
"enum": [
"active",
"dissolved",
"liquidation",
"receivership",
"administration",
"voluntary-arrangement",
"insolvency-proceedings",
"converted-closed",
"open",
"closed",
"removed"
],
"enumTitles": [
"Active",
"Dissolved",
"Liquidation",
"Receivership",
"Administration",
"Voluntary arrangement",
"Insolvency proceedings",
"Converted / closed",
"Open (overseas)",
"Closed (overseas)",
"Removed"
]
},
"default": [
"active"
]
},
"companyTypes": {
"title": "Company types",
"type": "array",
"description": "Leave empty for all types.",
"items": {
"type": "string",
"enum": [
"ltd",
"plc",
"llp",
"private-limited-guarant-nsc",
"private-limited-guarant-nsc-limited-exemption",
"private-unlimited",
"private-unlimited-nsc",
"limited-partnership",
"scottish-partnership",
"charitable-incorporated-organisation",
"scottish-charitable-incorporated-organisation",
"registered-society-non-jurisdictional",
"uk-establishment",
"oversea-company",
"royal-charter"
],
"enumTitles": [
"Private limited company (Ltd)",
"Public limited company (PLC)",
"Limited liability partnership (LLP)",
"Private company limited by guarantee",
"Guarantee company exempt from 'Limited'",
"Private unlimited company",
"Private unlimited, no share capital",
"Limited partnership",
"Scottish qualifying partnership",
"Charitable incorporated organisation",
"Scottish CIO",
"Registered society",
"UK establishment of overseas company",
"Overseas company",
"Royal charter company"
]
}
},
"companySubtypes": {
"title": "Company subtypes",
"type": "array",
"description": "Optional, e.g. \"community-interest-company\", \"private-fund-limited-partnership\".",
"items": {
"type": "string"
}
},
"companyNameIncludes": {
"title": "Company name includes",
"type": "string",
"description": "Only companies whose name contains this text (e.g. \"bakery\", \"solar\")."
},
"companyNameExcludes": {
"title": "Company name excludes",
"type": "string",
"description": "Drop companies whose name contains this text."
},
"dissolvedFrom": {
"title": "Dissolved from",
"type": "string",
"description": "YYYY-MM-DD (use with status 'dissolved')."
},
"dissolvedTo": {
"title": "Dissolved to",
"type": "string",
"description": "YYYY-MM-DD"
},
"sortBy": {
"title": "Sort search results",
"enum": [
"newest",
"oldest",
"none"
],
"type": "string",
"description": "Newest incorporations first (best for lead lists with a max results limit), oldest first, or Companies House's own order.",
"default": "newest"
},
"companies": {
"title": "Companies (Lookup mode)",
"type": "array",
"description": "Company numbers (\"00445790\", \"445790\", \"SC123456\"), Companies House URLs, or company names. Names are matched with Companies House search.",
"items": {
"type": "string"
}
},
"nameMatchesPerQuery": {
"title": "Matches per company name",
"minimum": 1,
"maximum": 100,
"type": "integer",
"description": "For names in Lookup mode: how many top search matches to return (1 = best match only).",
"default": 1
},
"includeOfficers": {
"title": "Include directors & officers",
"type": "boolean",
"description": "Adds officers (names, role, appointed date, nationality, occupation, country of residence, birth month/year, service address) and a 'directorNames' column. Billed as an enriched company.",
"default": false
},
"includePSC": {
"title": "Include beneficial owners (PSC)",
"type": "boolean",
"description": "Adds persons with significant control: owners with ownership/voting bands, corporate owners with registration numbers. Billed as an enriched company.",
"default": false
},
"includeResignedOfficers": {
"title": "Include resigned officers",
"type": "boolean",
"description": "Off = active officers only.",
"default": false
},
"includeCeasedPSC": {
"title": "Include ceased PSCs",
"type": "boolean",
"description": "Off = current owners only.",
"default": false
},
"includeFullProfile": {
"title": "Include full profile in Search mode",
"type": "boolean",
"description": "Adds accounts/confirmation statement due dates, charges, insolvency history and previous names to search results (one extra request per company, so slower). Lookup mode always includes these.",
"default": false
},
"maxResults": {
"title": "Max results",
"minimum": 0,
"type": "integer",
"description": "Maximum companies to return. 0 = no limit.",
"default": 100
},
"onlyNew": {
"title": "Only companies not returned before",
"type": "boolean",
"description": "Remembers which companies this saved search already returned (per 'State key') and returns only new ones. Schedule it daily for new-company alerts.",
"default": false
},
"firstRunBehavior": {
"title": "First run (with 'only new')",
"enum": [
"returnAll",
"baselineOnly"
],
"type": "string",
"description": "'Return all' delivers current matches on the first run; 'Baseline only' silently records them (no charge per company) so you only get companies registered after today.",
"default": "returnAll"
},
"stateKey": {
"title": "State key",
"type": "string",
"description": "Name for this saved search's memory. Defaults to a hash of the filters. Use different keys for different alerts."
},
"apiKey": {
"title": "Companies House API key (optional)",
"type": "string",
"description": "Optional: your own free key from developer.company-information.service.gov.uk. Gives you your own 600 requests / 5 min quota. Leave empty to use ours."
},
"requestsPerSecond": {
"title": "Requests per second",
"minimum": 0.1,
"maximum": 1.9,
"type": "number",
"description": "Companies House allows 600 requests per 5 minutes per key (2/s). Keep at 1.8 or lower.",
"default": 1.8
}
}
},
"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
}
}
}
}
}
}
}
}
}
}