{ "openapi": "3.0.1", "info": { "title": "UK New Business Registry Leads Finder", "description": "Discover newly registered UK companies from public company registry data. Extract company names, registration numbers, incorporation dates, SIC codes, status, addresses, and source links for sales prospecting, compliance research, accounting outreach, and B2B lead generation.", "version": "0.0", "x-build-id": "cIgKvxnrYCCv7BQWd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lead.gen.labs~uk-new-business-registry-leads-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lead.gen.labs-uk-new-business-registry-leads-finder", "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/lead.gen.labs~uk-new-business-registry-leads-finder/runs": { "post": { "operationId": "runs-sync-lead.gen.labs-uk-new-business-registry-leads-finder", "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/lead.gen.labs~uk-new-business-registry-leads-finder/run-sync": { "post": { "operationId": "run-sync-lead.gen.labs-uk-new-business-registry-leads-finder", "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": [ "locations", "max_companies" ], "properties": { "locations": { "title": "Locations", "type": "array", "description": "Registered office address filters. Use city, county, postcode area, or country terms supported by Companies House advanced search.", "items": { "type": "string" }, "default": [ "London" ] }, "days_back": { "title": "Days Back", "minimum": 0, "maximum": 3650, "type": "integer", "description": "When no explicit date range is supplied, collect companies incorporated from this many days back through today.", "default": 7 }, "incorporated_from": { "title": "Incorporated From", "type": "string", "description": "Optional start date in YYYY-MM-DD format.", "default": "" }, "incorporated_to": { "title": "Incorporated To", "type": "string", "description": "Optional end date in YYYY-MM-DD format.", "default": "" }, "company_name_includes": { "title": "Company Name Includes", "type": "string", "description": "Optional Companies House company name include filter.", "default": "" }, "company_name_excludes": { "title": "Company Name Excludes", "type": "string", "description": "Optional Companies House company name exclude filter.", "default": "" }, "company_statuses": { "title": "Company Statuses", "uniqueItems": true, "type": "array", "description": "Companies House status filters.", "items": { "type": "string", "enum": [ "active", "dissolved", "open", "closed", "converted-closed", "removed", "receivership", "liquidation", "administration", "insolvency-proceedings", "voluntary-arrangement" ], "enumTitles": [ "Active", "Dissolved", "Open", "Closed", "Converted closed", "Removed", "Receivership", "Liquidation", "Administration", "Insolvency proceedings", "Voluntary arrangement" ] }, "default": [ "active" ] }, "company_types": { "title": "Company Types", "uniqueItems": true, "type": "array", "description": "Companies House entity type filters.", "items": { "type": "string", "enum": [ "ltd", "llp", "plc", "private-limited-guarant-nsc", "private-unlimited", "limited-partnership", "oversea-company", "registered-overseas-entity", "uk-establishment" ], "enumTitles": [ "Private limited company", "Limited liability partnership", "Public limited company", "Private limited by guarantee", "Private unlimited company", "Limited partnership", "Overseas company", "Overseas entity", "UK establishment company" ] }, "default": [ "ltd" ] }, "sic_codes": { "title": "SIC Codes", "type": "array", "description": "Optional Standard Industrial Classification codes to filter by nature of business.", "items": { "type": "string" }, "default": [] }, "max_companies": { "title": "Maximum Companies", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum normalized company profiles to save.", "default": 100 }, "max_pages_per_location": { "title": "Maximum Result Pages per Location", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum Companies House advanced-search result pages to fetch per selected location.", "default": 5 }, "include_officers": { "title": "Include Officers", "type": "boolean", "description": "Fetch director and secretary details from the People tab.", "default": true }, "include_psc": { "title": "Include PSC People", "type": "boolean", "description": "Fetch persons with significant control when available.", "default": true }, "extract_emails": { "title": "Extract Public Emails", "type": "boolean", "description": "Extract public email addresses if they appear on fetched Companies House pages.", "default": true }, "request_delay_millis": { "title": "Request Delay", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Delay between requests in milliseconds.", "default": 750 }, "browser_impersonation": { "title": "Browser Impersonation", "type": "string", "description": "curl_cffi browser impersonation profile.", "default": "chrome136" }, "custom_proxy_url": { "title": "Custom Proxy URL", "type": "string", "description": "Optional proxy URL.", "default": "" } } }, "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 } } }, "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 } } } } } } } } } }