{ "openapi": "3.0.1", "info": { "title": "UK Companies House Feed: New Companies & Status Alerts", "description": "Daily feed of new UK company incorporations from the official Companies House API, filtered by SIC code, region, postcode and type, plus watchlist alerts for liquidation, administration, dissolution, overdue accounts and name/address changes. Company-level OGL data.", "version": "0.1", "x-build-id": "Ef7DeyO211paQUnRj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/seaf999ield~uk-companies-house-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-seaf999ield-uk-companies-house-feed", "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/seaf999ield~uk-companies-house-feed/runs": { "post": { "operationId": "runs-sync-seaf999ield-uk-companies-house-feed", "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/seaf999ield~uk-companies-house-feed/run-sync": { "post": { "operationId": "run-sync-seaf999ield-uk-companies-house-feed", "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": { "mode": { "title": "Mode", "enum": [ "new_companies", "watchlist", "status_changes" ], "type": "string", "description": "What to fetch. 'new_companies' is a daily lead feed of new incorporations. 'watchlist' monitors your list of company numbers and outputs only changes since the previous run. 'status_changes' outputs dissolutions in a date range and companies that newly entered an insolvency status since the previous run.", "default": "new_companies" }, "companiesHouseApiKey": { "title": "Companies House API key (optional)", "type": "string", "description": "Optional: your own free Companies House REST API key (developer.company-information.service.gov.uk). If empty, the actor's built-in key is used. Using your own key gives you a dedicated 600 requests / 5 min quota." }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 365, "type": "integer", "description": "Used when no explicit From date is set: covers the last N full days, ending yesterday (UK time). 1 = yesterday only, ideal for a daily schedule.", "default": 1 }, "incorporatedFrom": { "title": "Incorporated from (YYYY-MM-DD)", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "new_companies: first incorporation date to include. Overrides 'Days back'." }, "incorporatedTo": { "title": "Incorporated to (YYYY-MM-DD)", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "new_companies: last incorporation date to include (default: yesterday, or today if a From date is set)." }, "changedFrom": { "title": "Dissolved from (YYYY-MM-DD)", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "status_changes: first dissolution date to include. Overrides 'Days back'." }, "changedTo": { "title": "Dissolved to (YYYY-MM-DD)", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "status_changes: last dissolution date to include." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Only companies with any of these 5-digit SIC 2007 codes, e.g. 62012 (software development), 56101 (restaurants), 41100 (property development), 69201 (accounting). Empty = all industries.", "default": [], "items": { "type": "string" } }, "regions": { "title": "UK regions", "type": "array", "description": "Only companies whose registered office postcode is in these regions (mapped from the postcode area). Empty = all.", "items": { "type": "string", "enum": [ "London", "South East", "East of England", "South West", "West Midlands", "East Midlands", "Yorkshire and The Humber", "North West", "North East", "Wales", "Scotland", "Northern Ireland", "Channel Islands and Isle of Man" ] }, "default": [] }, "postcodePrefixes": { "title": "Postcode prefixes", "type": "array", "description": "Registered office postcode starts with, e.g. 'M' (Manchester area only, not 'ME'), 'SW1A', 'LS1 ', 'EH'. Empty = all.", "default": [], "items": { "type": "string" } }, "location": { "title": "Location text", "type": "string", "description": "Free-text match on the registered office address done by Companies House, e.g. 'Bristol'." }, "companyTypes": { "title": "Company types", "type": "array", "description": "Only these company types. Empty = all.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "private-unlimited", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-unlimited-nsc", "private-limited-shares-section-30-exemption", "limited-partnership", "scottish-partnership", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "registered-society-non-jurisdictional", "industrial-and-provident-society", "royal-charter", "uk-establishment", "overseas-company", "registered-overseas-entity", "protected-cell-company", "eeig", "investment-company-with-variable-capital", "further-education-or-sixth-form-college-corporation", "old-public-company", "assurance-company", "unregistered-company", "other" ], "enumTitles": [ "Private limited company (Ltd)", "Public limited company (PLC)", "Limited liability partnership (LLP)", "Private unlimited company", "Private company limited by guarantee (no share capital)", "Private limited by guarantee, exempt from 'Limited'", "Private unlimited company without share capital", "Private limited (section 30 exemption)", "Limited partnership", "Scottish partnership", "Charitable incorporated organisation (CIO)", "Scottish CIO", "Registered society", "Industrial and provident society", "Royal charter company", "UK establishment of an overseas company", "Overseas company", "Registered overseas entity", "Protected cell company", "EEIG", "Investment company with variable capital", "Further education / sixth form college corporation", "Old public company", "Assurance company", "Unregistered company", "Other" ] }, "default": [] }, "companyStatuses": { "title": "Company status (new_companies)", "type": "array", "description": "new_companies only: current status filter. Empty = all (newly incorporated companies are almost always 'active').", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "receivership", "administration", "voluntary-arrangement", "converted-closed", "insolvency-proceedings", "registered", "removed", "closed", "open" ] }, "default": [] }, "fetchFullProfile": { "title": "Fetch full company profile", "type": "boolean", "description": "new_companies: call the company profile endpoint for each record (1 extra API request per company). Gives jurisdiction, status detail and the official accounts / confirmation-statement dates. Off = due dates are calculated with the statutory rules for new companies (dueDatesSource = 'calculated'), which is much faster.", "default": false }, "companyNumbers": { "title": "Company numbers (watchlist)", "type": "array", "description": "Watchlist mode: Companies House numbers to monitor, e.g. 00445790, SC123456. Leading zeros are added for numeric numbers.", "default": [], "items": { "type": "string" } }, "monitorName": { "title": "Monitor name", "type": "string", "description": "State is saved under this name (named key-value store ch-watchlist- or ch-status-), so you can run separate monitors, e.g. one per client. A new name starts a new baseline.", "default": "default" }, "changeTypes": { "title": "Change types (watchlist)", "type": "array", "description": "Watchlist: which changes to output. Empty = all.", "items": { "type": "string", "enum": [ "STATUS_CHANGED", "NAME_CHANGED", "ADDRESS_CHANGED", "ACCOUNTS_OVERDUE", "CONFIRMATION_STATEMENT_OVERDUE", "INSOLVENCY_HISTORY_ADDED", "COMPANY_NOT_FOUND" ] }, "default": [] }, "statusTypes": { "title": "Statuses (status_changes)", "type": "array", "description": "status_changes: 'dissolved' uses exact dissolution dates in the date range. The insolvency statuses are compared with the previous run of the same monitor (first run = baseline). 'liquidation' covers 100k+ companies, so use it with filters or a higher request cap.", "items": { "type": "string", "enum": [ "dissolved", "liquidation", "administration", "receivership", "insolvency-proceedings", "voluntary-arrangement" ] }, "default": [ "dissolved", "administration", "receivership", "insolvency-proceedings" ] }, "maxWatchlistSize": { "title": "Max watchlist size", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Safety cap on how many company numbers are checked per run (1 API request each).", "default": 2000 }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Maximum records to output (and be charged for) per run. 0 = no limit.", "default": 1000 }, "maxRequests": { "title": "Max API requests", "minimum": 10, "maximum": 20000, "type": "integer", "description": "Cap on Companies House API requests per run. The actor throttles to ~550 requests / 5 min and backs off on HTTP 429.", "default": 1000 } } }, "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 } } } } } } } } } }