{ "openapi": "3.0.1", "info": { "title": "Companies House UK Company Data & Accounts", "description": "Companies House data with no API key needed: look up UK companies by number or name and get status, SIC codes, filing deadlines and overdue flags, charges, insolvency, and turnover, profit and net assets from the latest accounts. Company-level only, no personal data. Failed look-ups are free.", "version": "0.1", "x-build-id": "hey01OP7cBkdURRoA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetchgrove~uk-companies-house-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetchgrove-uk-companies-house-data", "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/fetchgrove~uk-companies-house-data/runs": { "post": { "operationId": "runs-sync-fetchgrove-uk-companies-house-data", "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/fetchgrove~uk-companies-house-data/run-sync": { "post": { "operationId": "run-sync-fetchgrove-uk-companies-house-data", "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": { "companyNumbers": { "title": "Company numbers", "type": "array", "description": "UK company numbers to look up, or register page links such as https://find-and-update.company-information.service.gov.uk/company/00445790 (the number is read from the link). Spaces are removed and letters uppercased; purely numeric numbers are left-padded to 8 digits (e.g. 445790 → 00445790, \"0050 2851\" → 00502851) and prefixed ones to two letters plus 6 digits (SC45551 → SC045551). Prefixes such as SC, NI and OC are kept. A value that is still not a valid company number returns a free error item. If this, the searches and the advanced-search filters are all empty, the run returns one example company (00445790), free of charge.", "items": { "type": "string" } }, "searchQueries": { "title": "Company name searches", "type": "array", "description": "Company-name search queries. Each hit is fetched as a full company profile.", "items": { "type": "string" }, "default": [] }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of search hits to take from each query (1–100).", "default": 20 }, "filters": { "title": "Advanced search filters", "type": "object", "description": "Find companies by industry, place, incorporation or dissolution date, status and type, using the official Companies House advanced company search. Each match is returned as a full company record (marked matchedFilter) and charged like a name-search hit. Set at least one filter; leave all empty to skip. A key not listed here fails the run before any request. A run returns at most 1,000 companies (25 on the free plan), whatever maxResults says. If Companies House rejects the filters, the run fails with its reason after the companies asked for by number or name are returned.", "properties": { "sicCodes": { "title": "SIC codes", "type": "array", "description": "5-digit Standard Industrial Classification codes, e.g. 62012 (business and domestic software development). A company matches if it has any of them. Companies House matches the exact 5-digit code, so a 4-digit code (e.g. 6201) is rejected: list the 5-digit codes instead (62011, 62012, 62020, ...).", "editor": "stringList", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Town or postcode area of the registered office, e.g. Leeds or LS1.", "editor": "textfield" }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Only companies incorporated on or after this date (YYYY-MM-DD).", "editor": "datepicker", "dateType": "absolute", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Only companies incorporated on or before this date (YYYY-MM-DD).", "editor": "datepicker", "dateType": "absolute", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dissolvedFrom": { "title": "Dissolved from", "type": "string", "description": "Only companies dissolved on or after this date (YYYY-MM-DD). Combine with company status dissolved.", "editor": "datepicker", "dateType": "absolute", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dissolvedTo": { "title": "Dissolved to", "type": "string", "description": "Only companies dissolved on or before this date (YYYY-MM-DD).", "editor": "datepicker", "dateType": "absolute", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "companyStatus": { "title": "Company status", "type": "array", "description": "Any of these statuses, e.g. active, dissolved, liquidation. Empty means any status.", "editor": "select", "items": { "type": "string", "enum": [ "active", "dissolved", "open", "closed", "converted-closed", "receivership", "administration", "liquidation", "insolvency-proceedings", "voluntary-arrangement", "removed" ], "enumTitles": [ "Active", "Dissolved", "Open", "Closed", "Converted / closed", "Receivership", "Administration", "Liquidation", "Insolvency proceedings", "Voluntary arrangement", "Removed" ] } }, "companyType": { "title": "Company type", "type": "array", "description": "Any of these company types, e.g. ltd, plc, llp. Empty means any type.", "editor": "select", "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", "icvc-securities", "icvc-warrant", "icvc-umbrella", "registered-society-non-jurisdictional", "industrial-and-provident-society", "northern-ireland", "northern-ireland-other", "royal-charter", "investment-company-with-variable-capital", "unregistered-company", "llp", "other", "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 unlimited company (private-unlimited)", "Private limited company (ltd)", "Public limited company (plc)", "Old public company (old-public-company)", "Private company limited by guarantee without share capital, exempt from \"Limited\" (private-limited-guarant-nsc-limited-exemption)", "Limited partnership (limited-partnership)", "Private company limited by guarantee without share capital (private-limited-guarant-nsc)", "Converted / closed (converted-or-closed)", "Private unlimited company without share capital (private-unlimited-nsc)", "Private limited company, exempt from \"Limited\" (section 30) (private-limited-shares-section-30-exemption)", "Protected cell company (protected-cell-company)", "Assurance company (assurance-company)", "Overseas company (oversea-company)", "European Economic Interest Grouping (EEIG) (eeig)", "Investment company with variable capital (securities) (icvc-securities)", "Investment company with variable capital (warrant) (icvc-warrant)", "Investment company with variable capital (umbrella) (icvc-umbrella)", "Registered society (registered-society-non-jurisdictional)", "Industrial and provident society (industrial-and-provident-society)", "Northern Ireland company (northern-ireland)", "Northern Ireland, other (northern-ireland-other)", "Royal charter company (royal-charter)", "Investment company with variable capital (investment-company-with-variable-capital)", "Unregistered company (unregistered-company)", "Limited liability partnership (llp)", "Other company type (other)", "European public limited-liability company (SE) (european-public-limited-liability-company-se)", "UK establishment of an overseas company (uk-establishment)", "Scottish qualifying partnership (scottish-partnership)", "Charitable incorporated organisation (charitable-incorporated-organisation)", "Scottish charitable incorporated organisation (scottish-charitable-incorporated-organisation)", "Further education or sixth form college corporation (further-education-or-sixth-form-college-corporation)", "Registered overseas entity (registered-overseas-entity)" ] } }, "maxResults": { "title": "Max results", "type": "integer", "description": "Maximum number of matching companies to take (1–5000).", "editor": "number", "minimum": 1, "maximum": 5000, "default": 100 } } }, "includeFilingSummary": { "title": "Include latest filings", "type": "boolean", "description": "Include the 10 most recent filing-history items for each company.", "default": true }, "includeAccountsFigures": { "title": "Parse latest iXBRL accounts", "type": "boolean", "description": "Download the latest electronically filed accounts (if available as iXBRL) and extract headline figures. Includes the prior-year figures the same accounts carry (previous) and the year-on-year change (change).", "default": false }, "watchMode": { "title": "Watch for changes", "type": "boolean", "description": "Compare each company with what the previous run of the same watch list saw and add changes (field, from, to) for status, status detail, overdue accounts and confirmation statement, outstanding charges, insolvency history, registered office area, company name, the latest filing, and each new filing (up to the latest 50 filings). The first run of a list is the baseline for each company (changedSinceLastRun null). The last-seen state is kept per watch list in a key-value store named uk-companies-house-watch in your own Apify account. Schedule the run (best as a saved task) to watch a list daily or weekly.", "default": false }, "onlyChanges": { "title": "Return only companies that changed", "type": "boolean", "description": "With Watch for changes on: return (and pay for) only companies that changed since the last run. The first run returns every company as the baseline. Companies that could not be fetched are always returned as free error items.", "default": false }, "watchListName": { "title": "Watch list name", "type": "string", "description": "Optional. Snapshots are kept separately per watch list, so two lists (or two tasks) watching the same company each get their own baseline and each see every change. Default: the saved task when the run belongs to a task, otherwise the exact set of companies, searches and filters, so editing that input starts a new baseline. Set a name to keep one list across edits or to share it between tasks. Case and extra spaces are ignored. Lists watched before this option existed start a new baseline once." }, "apiKey": { "title": "Companies House API key", "type": "string", "description": "Your Companies House public data API key (HTTP Basic username, empty password). If omitted, the COMPANIES_HOUSE_API_KEY environment variable is used." } } }, "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 } } } } } } } } } }