{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper — Companies, Officers, PSC & Filings", "description": "Export UK Companies House data without an API key: advanced company search (name, address, status, type, SIC code, dates), full company profiles, directors and officers, persons with significant control, filing history with PDF links and charges.", "version": "0.1", "x-build-id": "dO6KBoauWtLbUVNEG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/teodor_banea~companies-house-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-teodor_banea-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/teodor_banea~companies-house-scraper/runs": { "post": { "operationId": "runs-sync-teodor_banea-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/teodor_banea~companies-house-scraper/run-sync": { "post": { "operationId": "run-sync-teodor_banea-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": { "dataType": { "title": "Data type", "enum": [ "companies", "officers", "psc", "filings", "charges" ], "type": "string", "description": "Choose what each row is: a company, an officer appointment (directors, secretaries, LLP members), a person with significant control (or PSC statement), a filing (with its PDF link) or a charge (mortgage). One row type per run.", "default": "companies" }, "companySource": { "title": "Company source", "enum": [ "search", "companyNumbers" ], "type": "string", "description": "Choose \"Search\" to find companies with the filters below, or \"Company numbers\" to read the companies you list.", "default": "search" }, "maxResults": { "title": "Maximum results", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Enter how many rows to return (companies, officers, filings… depending on the data type). 0 = all (capped at 10,000 companies when no name, address, SIC code or date filter is set).", "default": 100 }, "companyNameIncludes": { "title": "Company name includes", "type": "string", "description": "Enter a word or phrase the company name must contain, e.g. \"bakery\"." }, "companyNameExcludes": { "title": "Company name excludes", "type": "string", "description": "Enter a word the company name must NOT contain, e.g. \"holdings\"." }, "registeredOfficeAddress": { "title": "Registered office address", "type": "string", "description": "Enter a town, street or postcode the registered office address must contain, e.g. \"Leeds\" or \"LS1\". The site matches the whole address text (a \"Leeds Road\" in Bradford matches \"Leeds\")." }, "companyStatuses": { "title": "Company status", "type": "array", "description": "Keep companies with any of these statuses. Empty = all statuses.", "items": { "type": "string", "enum": [ "active", "dissolved", "open", "closed", "converted-closed", "removed", "receivership", "liquidation", "administration", "insolvency-proceedings", "voluntary-arrangement" ], "enumTitles": [ "Active", "Dissolved", "Open", "Closed", "Converted / closed", "Removed", "Receivership", "Liquidation", "Administration", "Insolvency proceedings", "Voluntary arrangement" ] } }, "companyTypes": { "title": "Company type", "type": "array", "description": "Keep companies of any of these types (e.g. Private limited company, LLP). Empty = all types.", "items": { "type": "string", "enum": [ "assurance-company", "charitable-incorporated-organisation", "converted-or-closed", "eeig", "european-public-limited-liability-company-se", "further-education-or-sixth-form-college-corporation", "industrial-and-provident-society", "icvc", "llp", "limited-partnership", "old-public-company", "oversea-company", "registered-overseas-entity", "private-limited-guarant-nsc", "ltd", "private-limited-guarant-nsc-limited-exemption", "private-limited-shares-section-30-exemption", "private-unlimited", "private-unlimited-nsc", "protected-cell-company", "plc", "registered-society-non-jurisdictional", "royal-charter", "scottish-charitable-incorporated-organisation", "scottish-partnership", "uk-establishment", "unregistered-company" ], "enumTitles": [ "Assurance company", "Charitable incorporated organisation", "Converted or closed", "European Economic Interest Grouping (EEIG)", "European public limited liability company (SE)", "Further education or sixth form college corporation", "Industrial and provident society", "Investment company with variable capital", "Limited liability partnership", "Limited partnership", "Old public company", "Overseas company", "Overseas entity", "Private limited by guarantee without share capital", "Private limited company", "Private limited by guarantee without share capital, use of 'Limited' exemption", "Private limited company, use of 'Limited' exemption", "Private unlimited company", "Private unlimited company without share capital", "Protected cell company", "Public limited company", "Registered society", "Royal charter company", "Scottish charitable incorporated organisation", "Scottish qualifying partnership", "UK establishment company", "Unregistered company" ] } }, "companySubtype": { "title": "Company subtype", "enum": [ "community-interest-company", "private-fund-limited-partnership" ], "type": "string", "description": "Keep only community interest companies or private fund limited partnerships. Leave empty for all." }, "sicCodes": { "title": "SIC codes (nature of business)", "type": "array", "description": "Enter 5-digit UK SIC 2007 codes, e.g. 10710 (bread and cakes) or 62020 (IT consultancy). Companies with ANY of the codes are returned (each once).", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T.*)?$", "type": "string", "description": "Keep companies incorporated on or after this date." }, "incorporatedTo": { "title": "Incorporated to", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T.*)?$", "type": "string", "description": "Keep companies incorporated on or before this date." }, "dissolvedFrom": { "title": "Dissolved from", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T.*)?$", "type": "string", "description": "Keep companies dissolved on or after this date. Companies House only shows companies dissolved since 2010-01-01." }, "dissolvedTo": { "title": "Dissolved to", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T.*)?$", "type": "string", "description": "Keep companies dissolved on or before this date (2010-01-01 or later)." }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Enter company numbers (00445790, SC700865, OC390769, NI725763 — 6- or 7-digit numbers are zero-padded) or company page URLs. Used when Company source is \"Company numbers\".", "items": { "type": "string" } }, "includeCompanyDetails": { "title": "Include company details", "type": "boolean", "description": "Companies: open each company page for the full profile (SIC descriptions, previous names, accounts and confirmation statement dates, overdue flags, charges / insolvency flags, officer counts, split address). Two page loads per company. Off: search fields only — a whole search download of up to 5,000 companies in one request.", "default": true }, "officerStatus": { "title": "Officer status", "enum": [ "active", "all", "resigned" ], "type": "string", "description": "Officers: return current officers only, resigned officers only, or both.", "default": "active" }, "maxOfficersPerCompany": { "title": "Maximum officers per company", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Officers: stop after this many appointments per company (35 per page). 0 = all.", "default": 100 }, "maxFilingsPerCompany": { "title": "Maximum filings per company", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Filing history: stop after this many filings per company, newest first (25 per page). 0 = the whole history.", "default": 50 }, "filingCategories": { "title": "Filing categories", "type": "array", "description": "Filing history: keep only filings of these categories (derived from the form type, e.g. AA = accounts, CS01 = confirmation statement, AP01 = officers). Empty = all filings. With categories set, only the newest 200 filings of each company are checked.", "items": { "type": "string", "enum": [ "accounts", "confirmation-statement", "annual-return", "officers", "persons-with-significant-control", "capital", "mortgage", "address", "change-of-name", "incorporation", "resolution", "insolvency", "liquidation", "dissolution", "gazette", "other" ], "enumTitles": [ "Accounts", "Confirmation statements", "Annual returns", "Officers", "Persons with significant control", "Capital (shares)", "Charges (mortgages)", "Registered office address", "Change of name", "Incorporation", "Resolutions", "Insolvency (administration, CVA, receivership)", "Liquidation", "Dissolution", "Gazette notices", "Other" ] } }, "maxCompanies": { "title": "Maximum companies", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Officers, PSC, filings and charges from a search: scan at most this many companies (each costs one or more page loads). 0 = all matching companies.", "default": 100 } } }, "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 } } } } } } } } } }