{ "openapi": "3.0.1", "info": { "title": "UK Companies House — New Company Leads by SIC & Date", "description": "UK company data from the official Companies House API: profiles, SIC codes, accounts and confirmation dates, filing history. Lists of newly incorporated companies by industry, date and place. No personal data.", "version": "0.0", "x-build-id": "tvkY3dgIr7k9dX5xK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/saliga~uk-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-saliga-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/saliga~uk-companies-house/runs": { "post": { "operationId": "runs-sync-saliga-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/saliga~uk-companies-house/run-sync": { "post": { "operationId": "run-sync-saliga-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": { "companyNumbers": { "title": "Company numbers", "type": "array", "description": "UK company registration numbers, e.g. 00445790 or SC123456. Short numbers are padded (445790 → 00445790).", "items": { "type": "string" } }, "searchQueries": { "title": "Search by company name", "type": "array", "description": "Company names to look up. Each search returns the best matches, up to \"Results per name search\".", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Results per name search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many matches to keep for each name search.", "default": 5 }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "YYYY-MM-DD, or \"today\", \"yesterday\", \"7 days ago\", \"2 weeks ago\"." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "YYYY-MM-DD or a relative date like \"yesterday\"." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Industry codes (SIC 2007), e.g. 62020 (IT consultancy), 56101 (restaurants), 68100 (buying and selling own real estate).", "items": { "type": "string" } }, "companyStatus": { "title": "Company status", "type": "array", "description": "Keep only companies with these statuses. On its own this filter is too broad; combine it with dates, SIC codes, name or location.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "administration", "receivership", "voluntary-arrangement", "insolvency-proceedings", "converted-closed", "open", "closed", "registered", "removed" ], "enumTitles": [ "Active", "Dissolved", "Liquidation", "Administration", "Receivership", "Voluntary arrangement", "Insolvency proceedings", "Converted / closed", "Open (overseas)", "Closed (overseas)", "Registered", "Removed" ] } }, "companyType": { "title": "Company type", "type": "array", "description": "Keep only these company types.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-unlimited", "limited-partnership", "scottish-partnership", "charitable-incorporated-organisation", "registered-society-non-jurisdictional", "uk-establishment", "registered-overseas-entity", "oversea-company" ], "enumTitles": [ "Private limited company (Ltd)", "Public limited company (PLC)", "Limited liability partnership (LLP)", "Private limited by guarantee", "Private limited by guarantee, 'Limited' exemption", "Private unlimited", "Limited partnership", "Scottish partnership", "Charitable incorporated organisation", "Registered society", "UK establishment of an overseas company", "Registered overseas entity", "Overseas company" ] } }, "location": { "title": "Location", "type": "string", "description": "Town, city or postcode area of the registered office, e.g. Manchester." }, "nameIncludes": { "title": "Name includes", "type": "string", "description": "Only companies whose name contains this text." }, "nameExcludes": { "title": "Name excludes", "type": "string", "description": "Leave out companies whose name contains this text." }, "dissolvedFrom": { "title": "Dissolved from", "type": "string", "description": "YYYY-MM-DD or a relative date. For lists of recently dissolved companies." }, "dissolvedTo": { "title": "Dissolved to", "type": "string", "description": "YYYY-MM-DD or a relative date." }, "maxCompanies": { "title": "Max companies", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many companies in total.", "default": 500 }, "fetchProfiles": { "title": "Fetch full profiles", "type": "boolean", "description": "On: each company gets accounts and confirmation statement dates, charges and insolvency flags, previous names ($2 per 1,000). Off: advanced search rows only, much faster ($0.50 per 1,000). Company numbers and name searches always get full profiles.", "default": true }, "includeFilingHistory": { "title": "Include filing history", "type": "boolean", "description": "Add each company's latest filings (accounts, confirmation statements, changes), with a link to the PDF for accounts. $1 per 1,000 companies.", "default": false }, "maxFilingsPerCompany": { "title": "Filings per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many of the latest filings to add.", "default": 10 }, "apiKey": { "title": "Your Companies House API key (optional)", "type": "string", "description": "Not needed: the Actor has its own key. Add your own free REST API key (developer.company-information.service.gov.uk) to get the full rate limit to yourself on large runs." } } }, "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 } } } } } } } } } }