{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper: Officers, PSC, Charges", "description": "Get UK Companies House profiles with officers, PSCs, charge counts and accounts category in one row from the live register, for $0.0032 a company. Look up by company number, register URL or name, or filter by SIC code, location, status, dates and company name. No login, no API key.", "version": "0.1", "x-build-id": "IhW121eGOI5s7oZgG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pradio~companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pradio-companies-house", "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/pradio~companies-house/runs": { "post": { "operationId": "runs-sync-pradio-companies-house", "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/pradio~companies-house/run-sync": { "post": { "operationId": "run-sync-pradio-companies-house", "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": "Company numbers such as 07109264 or SC005336, one per entry. Each company is read once.", "items": { "type": "string" } }, "companyNumbersFileUrl": { "title": "Company numbers from a file", "type": "string", "description": "A link to a text or CSV file of company numbers, such as a sheet exported from Excel or a Google Sheets link shared with anyone who has it. One number per line; in a file with several columns, the column headed Company number (or the one holding the numbers) is read. Numbers that lost a leading zero in a spreadsheet are read as the register writes them. Up to 5 MB." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Companies House company page URLs or /search?q= results URLs; every company they resolve to is read once. Officer and appointment pages are not read and come back as a free row naming them. A linked remote text file is read like the file input above.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Terms run through the register's own search; each company hit is resolved into a profile row, up to maxCompaniesPerSearchQuery per query.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The most rows one run returns, up to 5,000. Left unset, a run still reads at most 5,000 companies." }, "maxCompaniesPerSearchQuery": { "title": "Max Companies Per Search Query", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The most companies one search query may add to a run, up to 5,000; unset means the maxItems cap, or 20 when that is unset too." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Five-digit SIC codes such as 56101, one per entry. Each code is searched on its own and the matches are merged without repeats. Any filter in this section switches the filter search on.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Text the registered office address must contain: a town such as Leeds or a postcode start such as EC2A." }, "companyNameIncludes": { "title": "Name contains", "type": "string", "description": "Only companies whose name carries every one of these words, matched as whole words in any case: bakery keeps SUNFLOWER BAKERY LIMITED but not BAKER & CO LTD. Narrows the filter search and the search queries; it never starts a search on its own, and company numbers and page URLs are always read." }, "companyNameExcludes": { "title": "Name does not contain", "type": "string", "description": "Leave out companies whose name carries any one of these words, matched as whole words in any case, such as holdings dormant. Narrows the filter search and the search queries in the same way." }, "companyStatus": { "title": "Status", "type": "array", "description": "Only companies with one of these statuses. Leave empty for any status.", "items": { "type": "string", "enum": [ "active", "dissolved", "open", "closed", "converted-closed", "removed", "receivership", "liquidation", "administration", "insolvency-proceedings", "voluntary-arrangement" ], "enumTitles": [ "Active", "Dissolved", "Open", "Closed", "Converted or closed", "Removed", "Receivership", "Liquidation", "Administration", "Insolvency proceedings", "Voluntary arrangement" ] } }, "companyTypes": { "title": "Types", "type": "array", "description": "Only companies of these types. Community interest company and private fund limited partnership are subtypes and narrow the types you pick. Leave empty for any type.", "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", "community-interest-company", "private-fund-limited-partnership" ], "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, 'Limited' exemption", "Private limited company, '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", "Community interest company (subtype)", "Private fund limited partnership (subtype)" ] } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Only companies incorporated on or after this date, as YYYY-MM-DD." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Only companies incorporated on or before this date, as YYYY-MM-DD." }, "dissolvedFrom": { "title": "Dissolved from", "type": "string", "description": "Only companies dissolved on or after this date, as YYYY-MM-DD." }, "dissolvedTo": { "title": "Dissolved to", "type": "string", "description": "Only companies dissolved on or before this date, as YYYY-MM-DD." }, "onlyNew": { "title": "Only new since the last run", "type": "boolean", "description": "For the filter search: skip companies an earlier run with the same filters already returned. Useful on a schedule. The memory keeps company numbers only, per filter set, in a named key-value store on your account.", "default": false }, "prevDatasetId": { "title": "Compare with a previous run", "type": "string", "description": "The dataset of an earlier run of this Actor. Each company row is compared with the row that run emitted for the same company number: row_state reads new, unchanged or changed, and changed_fields names the register fields that moved (status, office, accounts or statement due flags, charges, officer and PSC counts, SIC codes). Leave empty for a plain run." }, "includeFilingHistory": { "title": "Include filing history", "type": "boolean", "description": "Add each company's latest filings: date, form type and the register's description. One or more extra page reads per company.", "default": false }, "filingHistoryLimit": { "title": "Filings per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many of the latest filings to add when filing history is on, from 1 to 100.", "default": 5 }, "includeCharges": { "title": "Include charges", "type": "boolean", "description": "Add each charge the register lists: charge code or title, created and delivered dates, status and persons entitled. One extra page read for a company that has charges.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify proxy settings; when set, every register read goes through one proxy session for the whole run. It is never a way past a refusal: a refused read stops the run." } } }, "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 } } } } } } } } } }