{ "openapi": "3.0.1", "info": { "title": "New UK Companies from Companies House – SIC & Postcode Feed", "description": "UK Companies House company data: a daily feed of new UK companies by SIC code, postcode and type, with optional Companies House directors and secretaries, accounts due dates, filing history and summaries. Lookup by company number. No API key. $0.003 per company.", "version": "0.1", "x-build-id": "5GaXm5AxYA7VrTfqO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wantmannu~uk-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wantmannu-uk-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/wantmannu~uk-companies-house/runs": { "post": { "operationId": "runs-sync-wantmannu-uk-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/wantmannu~uk-companies-house/run-sync": { "post": { "operationId": "run-sync-wantmannu-uk-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": { "mode": { "title": "Mode", "enum": [ "newCompanies", "lookup" ], "type": "string", "description": "\"New companies feed\" lists companies incorporated in the date window that match your filters (lead lists, market monitoring). \"Look up\" returns the full profile of each company number you enter. Defaults run a cheap sample (last 3 days, 5 companies ≈ $0.015) — no other fields required.", "default": "newCompanies" }, "companyNumbers": { "title": "Company numbers (lookup mode)", "type": "array", "description": "Companies House numbers, e.g. \"00445790\", \"SC123456\", \"OC301540\". Leading zeros may be omitted. Used only in lookup mode.", "items": { "type": "string" } }, "sicCodes": { "title": "SIC codes (industry)", "type": "array", "description": "Nature of business. Exact 5-digit codes (\"62012\" = software development), a prefix for a whole group (\"62\" = all computer programming & IT consultancy, \"4322\" = plumbing & heating), or a section letter (\"J\" = information & communication). A company matches if any of its SIC codes match. Leave empty (the default) for all industries.", "items": { "type": "string" } }, "excludeSicCodes": { "title": "Exclude SIC codes", "type": "array", "description": "Drop companies that list any of these codes or prefixes, e.g. \"68\" (real estate) or \"70100\" (holding companies).", "items": { "type": "string" } }, "excludeDormant": { "title": "Exclude dormant / non-trading companies", "type": "boolean", "description": "Skip companies whose only SIC codes are 99999 (dormant) or 74990 (non-trading).", "default": true }, "lastNDays": { "title": "Incorporated in the last N days", "minimum": 1, "maximum": 366, "type": "integer", "description": "Window ending today (UK time); default 3 days. Ignored if \"Incorporated from\" is set.", "default": 3 }, "dateFrom": { "title": "Incorporated from", "type": "string", "description": "Start of the incorporation date range (YYYY-MM-DD). Overrides \"last N days\"." }, "dateTo": { "title": "Incorporated to", "type": "string", "description": "End of the incorporation date range (YYYY-MM-DD). Defaults to today." }, "companyStatuses": { "title": "Company status", "type": "array", "description": "Empty = any status. New incorporations are almost always Active.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "administration", "receivership", "voluntary-arrangement", "insolvency-proceedings", "converted-closed", "open", "closed", "removed" ], "enumTitles": [ "Active", "Dissolved", "Liquidation", "Administration", "Receivership", "Voluntary arrangement", "Insolvency proceedings", "Converted / closed", "Open (overseas entity)", "Closed (overseas entity)", "Removed" ] } }, "companyTypes": { "title": "Company types", "type": "array", "description": "Empty = all types (mostly private limited companies).", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-limited-shares-section-30-exemption", "private-unlimited", "private-unlimited-nsc", "limited-partnership", "scottish-partnership", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "registered-society-non-jurisdictional", "industrial-and-provident-society", "royal-charter", "old-public-company", "oversea-company", "uk-establishment", "registered-overseas-entity", "european-public-limited-liability-company-se", "eeig", "icvc", "protected-cell-company", "assurance-company", "further-education-or-sixth-form-college-corporation", "unregistered-company", "converted-or-closed" ], "enumTitles": [ "Private limited company", "Public limited company", "Limited liability partnership", "Private limited by guarantee without share capital", "Private limited company 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", "Limited partnership", "Scottish qualifying partnership", "Charitable incorporated organisation", "Scottish charitable incorporated organisation", "Registered society", "Industrial and provident society", "Royal charter company", "Old public company", "Overseas company", "UK establishment company", "Overseas entity", "European public limited liability company (SE)", "European Economic Interest Grouping (EEIG)", "Investment company with variable capital", "Protected cell company", "Assurance company", "Further education or sixth form college corporation", "Unregistered company", "Converted or closed" ] } }, "companySubtypes": { "title": "Company subtypes", "type": "array", "description": "Optional: only community interest companies (CIC) or private fund limited partnerships.", "items": { "type": "string", "enum": [ "community-interest-company", "private-fund-limited-partnership" ], "enumTitles": [ "Community interest company", "Private fund limited partnership" ] } }, "location": { "title": "Registered office contains", "type": "string", "description": "Text match on the registered office address, e.g. \"Manchester\" or \"Leeds\". Matched by Companies House as plain text." }, "postcodePrefixes": { "title": "Postcode areas / districts", "type": "array", "description": "Keep only registered offices in these postcode areas or districts, e.g. \"M\" (Manchester), \"EC1\", \"SW1A\", \"BS\".", "items": { "type": "string" } }, "nameIncludes": { "title": "Company name includes", "type": "string", "description": "Only companies whose name contains this word (Companies House word match)." }, "nameExcludes": { "title": "Company name excludes", "type": "string", "description": "Drop companies whose name contains this word, e.g. \"HOLDINGS\"." }, "includeDetails": { "title": "Add profile details", "type": "boolean", "description": "Adds accounts and confirmation statement dates, overdue flags and previous names (one extra request per company, slower). Always on in lookup mode.", "default": false }, "includeFilingHistory": { "title": "Add filing history", "type": "boolean", "description": "Adds the latest filings (date, form type, description, PDF link) and last-filing fields. One or more extra requests per company.", "default": false }, "maxFilings": { "title": "Filings per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many of the newest filings to include when filing history is on.", "default": 10 }, "includeOfficers": { "title": "Add officers (directors & secretaries)", "type": "boolean", "description": "Adds each company's officers from the public register: name, role, appointed date and resigned date, plus a flat \"directorNames\" column for spreadsheets. One extra request per company (more for very large boards). No dates of birth, nationality or home addresses are collected. Officer names are personal data: you are responsible for a lawful basis under UK GDPR and for PECR rules on marketing to individuals.", "default": false }, "officersCurrentOnly": { "title": "Current officers only", "type": "boolean", "description": "Only officers still in post. Turn off to include resigned officers too (active ones listed first).", "default": true }, "maxOfficers": { "title": "Officers per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum officers listed per company when officers are on.", "default": 10 }, "addSummary": { "title": "Add one-line plain-English summary", "type": "boolean", "description": "Adds a \"summary\" field, e.g. \"ACME LTD: private limited company incorporated 10 Oct 2026 in M1 (England and Wales); business and domestic software development. Active.\" Built from the record by fixed rules, not an AI model: free, instant and never invents facts.", "default": true }, "maxResults": { "title": "Max companies", "minimum": 1, "type": "integer", "description": "Stop after this many companies are saved (you are charged per saved company). Results are ordered newest incorporation date first, then by the numeric part of the company number (highest first), and the limit applies after that ordering. Default 5 is a quick, cheap sample (about $0.015); raise it for bigger pulls.", "default": 5 }, "deltaMode": { "title": "Only new since last run (delta mode)", "type": "boolean", "description": "For scheduled alerts: skip companies an earlier run with the same filters already delivered, so you only pay for new ones.", "default": false }, "deltaStoreName": { "title": "Delta store name", "type": "string", "description": "Named key-value store that remembers delivered companies. Change it to keep separate alert lists.", "default": "uk-companies-house-delta" }, "apiKey": { "title": "Companies House API key (optional)", "type": "string", "description": "Optional free key from developer.company-information.service.gov.uk. With a key the Actor uses the official REST API (adds charges/insolvency flags and filing categories); without one it reads the same public register from the Companies House website." }, "maxRequestsPerSecond": { "title": "Max requests per second", "enum": [ "0.5", "1", "1.5", "2" ], "type": "string", "description": "Politeness limit towards Companies House (their API allows 600 requests per 5 minutes = 2/s).", "default": "1.5" } } }, "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 } } } } } } } } } }