{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper - Officers, PSC, Filings $1.50/1K", "description": "Export UK companies, directors, PSC owners, filing history with PDF links, charges and insolvency from the official Companies House API using your free key. Search by name, SIC code, location or date. $1.50 per 1,000 records.", "version": "0.1", "x-build-id": "9XbhqhCMCVvLDsYdP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plotpointtech~uk-companies-house-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plotpointtech-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/plotpointtech~uk-companies-house-scraper/runs": { "post": { "operationId": "runs-sync-plotpointtech-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/plotpointtech~uk-companies-house-scraper/run-sync": { "post": { "operationId": "run-sync-plotpointtech-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", "properties": { "apiKey": { "title": "Your Companies House API key (free)", "type": "string", "description": "Your own free REST API key from the Companies House Developer Hub (developer.company-information.service.gov.uk > Your applications > Create an application > Create new key > REST). Takes about 2 minutes; see the README. Without a key the tool still returns basic company records from the keyless data Companies House publishes (monthly snapshot and URI service), but officers, PSC, filings, charges and insolvency need a key." }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Look up specific companies by registration number, e.g. 00445790 or SC123456. Leading zeros are added automatically.", "items": { "type": "string" } }, "searchQuery": { "title": "Search companies by name or keyword", "type": "string", "description": "Company name search, like the search box on the Companies House website, e.g. 'tesco' or 'green energy'. With an API key this uses the official search (current and previous names, ranked by relevance); without a key every word must appear in the company name." }, "sicCodes": { "title": "Advanced search: SIC codes", "type": "array", "description": "5-digit SIC 2007 nature-of-business codes, e.g. 62012 (business and domestic software development), 56101 (licensed restaurants), 68100 (buying and selling of own real estate).", "items": { "type": "string" } }, "location": { "title": "Advanced search: location", "type": "string", "description": "Town, city, county or postcode (district) of the registered office, e.g. Manchester, Kent or M1." }, "incorporatedFrom": { "title": "Advanced search: incorporated from", "type": "string", "description": "Only companies incorporated on or after this date (YYYY-MM-DD)." }, "incorporatedTo": { "title": "Advanced search: incorporated to", "type": "string", "description": "Only companies incorporated on or before this date (YYYY-MM-DD)." }, "companyStatus": { "title": "Advanced search: company status", "type": "array", "description": "Keep only these statuses. Leave empty for all. Note: the keyless monthly snapshot only contains live companies (active, liquidation, administration...), not dissolved ones.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "receivership", "administration", "voluntary-arrangement", "converted-closed", "insolvency-proceedings", "registered", "removed", "closed", "open" ], "enumTitles": [ "Active", "Dissolved", "Liquidation", "Receivership", "Administration", "Voluntary arrangement", "Converted / closed", "Insolvency proceedings", "Registered", "Removed", "Closed", "Open" ] } }, "companyType": { "title": "Advanced search: company type", "type": "array", "description": "Keep only these company types. Leave empty for all.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "limited-partnership", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-unlimited", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "registered-overseas-entity", "oversea-company", "registered-society-non-jurisdictional" ], "enumTitles": [ "Private limited company (Ltd)", "Public limited company (PLC)", "Limited liability partnership (LLP)", "Limited partnership", "Private company limited by guarantee", "Limited by guarantee, 'Limited' exemption", "Private unlimited company", "Charitable incorporated organisation", "Scottish charitable incorporated organisation", "Registered overseas entity", "Overseas company", "Registered society" ] } }, "nameIncludes": { "title": "Advanced search: name includes", "type": "string", "description": "Company name must contain this text." }, "nameExcludes": { "title": "Advanced search: name excludes", "type": "string", "description": "Company name must not contain this text." }, "recordTypes": { "title": "Records to return", "type": "array", "description": "What to return for every company found. Each record is one dataset row (and one billed result). Everything except 'Company' needs your API key.", "items": { "type": "string", "enum": [ "company", "officers", "psc", "filings", "charges", "insolvency" ], "enumTitles": [ "Company (profile)", "Officers (directors, secretaries, LLP members)", "Persons with significant control (PSC)", "Filing history (with document links)", "Charges (mortgages)", "Insolvency cases" ] }, "default": [ "company" ] }, "currentOnly": { "title": "Current officers and PSCs only", "type": "boolean", "description": "Skip resigned officers and ceased persons with significant control.", "default": true }, "filingCategories": { "title": "Filing categories", "type": "array", "description": "Only these filing-history categories. Leave empty for all.", "items": { "type": "string", "enum": [ "accounts", "confirmation-statement", "annual-return", "officers", "persons-with-significant-control", "incorporation", "change-of-name", "address", "capital", "mortgage", "resolution", "insolvency", "liquidation", "miscellaneous" ], "enumTitles": [ "Accounts", "Confirmation statement", "Annual return", "Officers", "Persons with significant control", "Incorporation", "Change of name", "Address", "Capital", "Mortgage / charges", "Resolution", "Insolvency", "Liquidation", "Miscellaneous" ] } }, "fullProfiles": { "title": "Fetch full profile for search results", "type": "boolean", "description": "Search results already include name, number, status, type, address, incorporation date (and SIC codes for advanced search). Turn on to also get accounts and confirmation-statement dates, previous names and charge/insolvency flags. Uses one extra API request per company.", "default": false }, "maxCompanies": { "title": "Maximum companies", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum companies taken from the name search and from the advanced search.", "default": 100 }, "maxItemsPerCompany": { "title": "Maximum officers / PSCs / filings / charges per company", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Cap per company and record type. Large PLCs can have thousands of filings.", "default": 100 }, "maxResults": { "title": "Maximum results (all records)", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many dataset rows in total (you pay per row).", "default": 1000 }, "dataSource": { "title": "Data source", "enum": [ "auto", "api", "snapshot" ], "type": "string", "description": "Auto: live API when you supply a key, otherwise the keyless sources. Snapshot: always use the monthly Free Company Data Product (useful for very large exports of live companies; no API quota used).", "default": "auto" } } }, "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 } } } } } } } } } }