{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper: Company Search & Profiles API", "description": "UK companies from the official Companies House API with your free key: search by name, status, type, SIC code, date or location, or look up company numbers. Profile, registered office, accounts and confirmation statement dates, SIC codes, filings and charges. No officers or PSCs; pay per company.", "version": "1.0", "x-build-id": "e9wbMG1B7uS3WFKVB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rowcraft~uk-companies-house-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rowcraft-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/rowcraft~uk-companies-house-scraper/runs": { "post": { "operationId": "runs-sync-rowcraft-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/rowcraft~uk-companies-house-scraper/run-sync": { "post": { "operationId": "run-sync-rowcraft-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", "required": [ "apiKey" ], "properties": { "apiKey": { "title": "Companies House API key", "type": "string", "description": "Your own key from the Companies House Developer Hub (free: sign in → Your applications → Create an application (live) → Create new key, type API key). Stored encrypted by Apify, used only for requests to api.company-information.service.gov.uk, never logged. The key's limit is 600 requests per 5 minutes; the run stops at the first 429 to protect it." }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Specific companies, one per line: 00445790, SC123456, or a link to a Companies House company page. Numbers without leading zeros are completed (445790 → 00445790).", "items": { "type": "string" } }, "searchNames": { "title": "Names to search", "type": "array", "description": "Free-text searches of the register, one per line (Tesco, Barclays Bank). Each search returns the best matches in Companies House order, up to the limit below.", "items": { "type": "string" } }, "maxResultsPerName": { "title": "Results per name search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many matches to take from each name search (1 = only the best match).", "default": 10 }, "nameIncludes": { "title": "Name contains", "type": "string", "description": "Advanced search: words the company name must contain (software consulting)." }, "nameExcludes": { "title": "Name does not contain", "type": "string", "description": "Words the company name must not contain." }, "statuses": { "title": "Company status", "type": "array", "description": "Empty = all statuses.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "receivership", "administration", "voluntary-arrangement", "insolvency-proceedings", "converted-closed", "open", "closed", "registered", "removed" ], "enumTitles": [ "Active", "Dissolved", "Liquidation", "Receiver action", "In administration", "Voluntary arrangement", "Insolvency proceedings", "Converted / closed", "Open", "Closed", "Registered", "Removed" ] } }, "types": { "title": "Company type", "type": "array", "description": "Empty = all types.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "limited-partnership", "private-unlimited", "private-unlimited-nsc", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-limited-shares-section-30-exemption", "oversea-company", "uk-establishment", "registered-overseas-entity", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "registered-society-non-jurisdictional", "industrial-and-provident-society", "royal-charter", "scottish-partnership", "european-public-limited-liability-company-se", "united-kingdom-societas", "eeig", "ukeig", "icvc-umbrella", "icvc-securities", "icvc-warrant", "investment-company-with-variable-capital", "protected-cell-company", "assurance-company", "old-public-company", "unregistered-company", "northern-ireland", "northern-ireland-other", "further-education-or-sixth-form-college-corporation", "converted-or-closed", "other" ], "enumTitles": [ "Private limited company (Ltd)", "Public limited company (PLC)", "Limited liability partnership (LLP)", "Limited partnership", "Private unlimited company", "Private unlimited company without share capital", "Private limited by guarantee without share capital", "Private limited by guarantee without share capital, 'Limited' exemption", "Private limited company, 'Limited' exemption", "Overseas company", "UK establishment company", "Overseas entity", "Charitable incorporated organisation", "Scottish charitable incorporated organisation", "Registered society", "Industrial and provident society", "Royal charter company", "Scottish qualifying partnership", "European public limited liability company (SE)", "United Kingdom Societas", "European Economic Interest Grouping (EEIG)", "United Kingdom Economic Interest Grouping", "Investment company with variable capital (umbrella)", "Investment company with variable capital (securities)", "Investment company with variable capital (warrant)", "Investment company with variable capital", "Protected cell company", "Assurance company", "Old public company", "Unregistered company", "Northern Ireland company", "Credit union (Northern Ireland)", "Further education or sixth form college corporation", "Converted / closed", "Other company type" ] } }, "subtypes": { "title": "Company subtype", "type": "array", "description": "Empty = all.", "items": { "type": "string", "enum": [ "community-interest-company", "private-fund-limited-partnership" ], "enumTitles": [ "Community interest company", "Private fund limited partnership" ] } }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Standard Industrial Classification 2007 codes, one per line: a full code (62012 = software development) or a prefix (62 = all computer programming and consultancy codes).", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Earliest incorporation date: 2026-01-01, today, yesterday, or a relative value such as 30 days, 6 months, 2 years." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Latest incorporation date, same formats." }, "dissolvedFrom": { "title": "Dissolved from", "type": "string", "description": "Earliest dissolution date (use with the Dissolved status)." }, "dissolvedTo": { "title": "Dissolved to", "type": "string", "description": "Latest dissolution date." }, "location": { "title": "Registered office location", "type": "string", "description": "Town, county, postcode or part of the registered office address (Manchester, SW1A, Cardiff)." }, "maxItems": { "title": "Maximum companies", "minimum": 0, "type": "integer", "description": "Stop after this many companies. 0 = all matching.", "default": 500 }, "includeProfile": { "title": "Read the full company profile", "type": "boolean", "description": "One request per company for the complete profile (accounts and confirmation statement dates, previous names, jurisdiction, flags). Off = only the search fields (name, number, status, type, dates, address, SIC codes), which costs one request per 500 companies.", "default": true }, "includeFilingHistory": { "title": "Include recent filings", "type": "boolean", "description": "The latest filings (date, category, type, description from the official templates, names of people removed), plus the total count.", "default": false }, "maxFilings": { "title": "Filings per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many of the latest filings to include (up to 100).", "default": 20 }, "includeCharges": { "title": "Include charges (mortgages)", "type": "boolean", "description": "Counts (total, satisfied, outstanding) and the list of charges with status, dates and description. Persons entitled are not included.", "default": false }, "includeInsolvency": { "title": "Include insolvency cases", "type": "boolean", "description": "Insolvency status and cases (type, dates). Practitioners are not included.", "default": false }, "countOnly": { "title": "Count only (free check)", "type": "boolean", "description": "Only count how many rows match your filters and estimate the cost at your price tier. Nothing is delivered and nothing is charged apart from the start event. Turn it off to get the data.", "default": false }, "onlyNew": { "title": "Only new rows since the last run", "type": "boolean", "description": "Remember the rows already delivered to you (in a key-value store in your Apify account) and deliver only rows that appeared since the last run with the same state key. The first run delivers everything that matches; later runs cost only the new rows. Ideal for schedules.", "default": false }, "stateName": { "title": "State name", "type": "string", "description": "Name of the memory used by \"Only new rows\". Use a different name for each schedule or search (for example `stockholm-python`) so they do not share one memory.", "default": "default" }, "notifyUrl": { "title": "Notify this URL when the run ends", "type": "string", "description": "A webhook address that receives one JSON POST with the number of new rows and links to the dataset: a Slack or Discord incoming webhook, a Make, n8n or Zapier catch hook, or your own endpoint. The message is also in the `text` (Slack) and `content` (Discord) fields." }, "notifyWhenEmpty": { "title": "Notify also when there are no new rows", "type": "boolean", "description": "By default the notification is sent only when at least one row was delivered.", "default": false }, "requestIntervalMs": { "title": "Delay between API requests (ms)", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Default 600 ms. The Companies House limit is 600 requests per 5 minutes per key (one every 500 ms); the minimum here is 500. The first 429 ends the run so your key is never flagged.", "default": 600 } } }, "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 } } } } } } } } } }