{ "openapi": "3.0.1", "info": { "title": "New UK Companies (Companies House)", "description": "Newly incorporated UK companies from official Companies House data. Filter by date, SIC code or keyword, type, status, postcode and region. No API key, no personal names.", "version": "1.0", "x-build-id": "PJTnsLr5TG4NAcM07" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leadmagnet~uk-new-companies/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leadmagnet-uk-new-companies", "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/leadmagnet~uk-new-companies/runs": { "post": { "operationId": "runs-sync-leadmagnet-uk-new-companies", "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/leadmagnet~uk-new-companies/run-sync": { "post": { "operationId": "run-sync-leadmagnet-uk-new-companies", "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": { "daysBack": { "title": "Incorporated within the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Companies incorporated in the last N days, including today (1-3650). Companies House publishes new incorporations within about a day. Ignored if 'From date' is set.", "default": 7 }, "dateFrom": { "title": "From date (optional)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Incorporated on or after this date (YYYY-MM-DD). Overrides 'last N days'." }, "dateTo": { "title": "To date (optional)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Incorporated on or before this date (YYYY-MM-DD). Defaults to today." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "5-digit UK SIC 2007 codes (e.g. 62012 software, 56101 restaurants, 86230 dental). Shorter prefixes expand to every matching code (e.g. '62' = all IT/software, '4321' = electrical installation). Leave empty for all industries.", "items": { "type": "string" } }, "industryKeywords": { "title": "Industry keywords", "type": "array", "description": "Matched against official SIC code descriptions (e.g. 'restaurant', 'dental', 'software', 'construction', 'hairdressing'). Combined with SIC codes above.", "items": { "type": "string" } }, "excludeDormant": { "title": "Exclude dormant / non-trading companies", "type": "boolean", "description": "Skip companies whose only SIC code is 99999 (dormant) or 74990 (non-trading).", "default": true }, "companyTypes": { "title": "Company types", "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "ltd", "llp", "plc", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-limited-shares-section-30-exemption", "limited-partnership", "scottish-partnership", "private-unlimited", "private-unlimited-nsc", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "registered-society-non-jurisdictional", "uk-establishment", "oversea-company", "registered-overseas-entity", "protected-cell-company", "icvc" ], "enumTitles": [ "Private limited company (Ltd)", "Limited liability partnership (LLP)", "Public limited company (PLC)", "Private limited by guarantee (no share capital)", "Private limited by guarantee, 'Limited' exemption", "Private limited company, 'Limited' exemption", "Limited partnership", "Scottish qualifying partnership", "Private unlimited company", "Private unlimited (no share capital)", "Charitable incorporated organisation", "Scottish charitable incorporated organisation", "Registered society", "UK establishment of overseas company", "Overseas company", "Registered overseas entity", "Protected cell company", "Investment company with variable capital" ] }, "default": [ "ltd", "llp", "plc", "private-limited-guarant-nsc" ] }, "companyStatus": { "title": "Company status", "enum": [ "active", "any", "dissolved", "liquidation", "administration" ], "type": "string", "description": "Active is best for leads. Choose Any to include every status.", "default": "active" }, "postcodes": { "title": "Postcode areas / districts", "type": "array", "description": "Registered office postcode filter. Area ('M', 'LS', 'SW'), district ('SW1A', 'M1') or full/partial postcode ('EC2A 4'). 'M' matches Manchester only, not 'ME'.", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "ONS region / nation of the registered office (looked up from the postcode).", "items": { "type": "string", "enum": [ "London", "South East", "South West", "East of England", "West Midlands", "East Midlands", "Yorkshire and The Humber", "North West", "North East", "Scotland", "Wales", "Northern Ireland" ] } }, "addressContains": { "title": "Address contains", "type": "string", "description": "Case-insensitive text the registered office address must contain, e.g. a town ('Bristol')." }, "nameIncludes": { "title": "Company name contains any of", "type": "array", "description": "E.g. 'consulting', 'dental', 'property'.", "items": { "type": "string" } }, "nameExcludes": { "title": "Company name excludes", "type": "array", "description": "E.g. 'holdings', 'property'.", "items": { "type": "string" } }, "excludeFormationAgentAddresses": { "title": "Exclude formation-agent / virtual-office addresses", "type": "boolean", "description": "Skip companies registered at well-known mass-registration addresses (e.g. 71-75 Shelton Street, 128 City Road) or at an address shared by 10+ companies incorporated the same day. Every row is flagged either way.", "default": false }, "addLocation": { "title": "Add region, local authority and coordinates", "type": "boolean", "description": "Free lookup of the registered-office postcode in ONS open data (postcodes.io). No extra charge.", "default": true }, "addFilingDeadlines": { "title": "Add filing deadlines + full address (extra charge)", "type": "boolean", "description": "Fetches each company's public profile: first accounts made-up-to and due date, confirmation statement due date, full comma-separated registered office. Great for accountants. Charged as an extra 'company details' event per company and slower (~0.5 s per company).", "default": false }, "companiesHouseApiKey": { "title": "Companies House API key (optional)", "type": "string", "description": "Not required. If you have a free Companies House REST API key, filing deadlines are fetched from the official API (also adds 'hasCharges')." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many companies (newest first).", "default": 1000 }, "monitorMode": { "title": "Monitor mode: only companies not delivered before", "type": "boolean", "description": "Remembers company numbers delivered in previous runs (in a named key-value store) and only returns new ones. Schedule daily with 'last 2 days' for a fresh lead feed.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Use a different name per saved search so monitors don't share history.", "default": "uk-new-companies-monitor" } } }, "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 } } } } } } } } } }