{ "openapi": "3.0.1", "info": { "title": "UK New Companies Feed: Companies House New Incorporations", "description": "Daily list of newly incorporated UK companies from Companies House: company number, name, type, status, incorporation date, SIC codes and registered office. Filter by SIC code, location and postcode; 'only new' mode for lead alerts.", "version": "0.1", "x-build-id": "zs0hkK8KShVW1PHAW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datatoolsuk~uk-new-companies-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datatoolsuk-uk-new-companies-feed", "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/datatoolsuk~uk-new-companies-feed/runs": { "post": { "operationId": "runs-sync-datatoolsuk-uk-new-companies-feed", "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/datatoolsuk~uk-new-companies-feed/run-sync": { "post": { "operationId": "run-sync-datatoolsuk-uk-new-companies-feed", "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": "Days back", "minimum": 1, "maximum": 92, "type": "integer", "description": "Companies incorporated in the last N days (including today). Ignored when 'Incorporated from' is set.", "default": 3 }, "dateFrom": { "title": "Incorporated from", "type": "string", "description": "YYYY-MM-DD. Max 92 days per run." }, "dateTo": { "title": "Incorporated to", "type": "string", "description": "YYYY-MM-DD (defaults to today)." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "5-digit SIC 2007 codes, e.g. 62012 (software), 56101 (restaurants), 41100 (property development), 47910 (online retail).", "items": { "type": "string" } }, "location": { "title": "Registered office location contains", "type": "string", "description": "Town, city or area in the registered office address, e.g. Manchester." }, "postcodePrefixes": { "title": "Postcode prefixes", "type": "array", "description": "Registered office postcode prefixes, e.g. M, LS1, SW19. 'B' does not match 'BS'.", "items": { "type": "string" } }, "companyTypes": { "title": "Company types", "type": "array", "description": "Companies House type codes, e.g. ltd, llp, plc, private-limited-guarant-nsc, limited-partnership.", "items": { "type": "string" } }, "companyStatuses": { "title": "Company status", "type": "array", "description": "e.g. active. New companies are almost always active.", "items": { "type": "string" } }, "companyNameIncludes": { "title": "Company name contains", "type": "string", "description": "e.g. 'tech', 'property'." }, "onlyNew": { "title": "Only new since last run (alerts mode)", "type": "boolean", "description": "Remembers company numbers already returned for the same filters (named key-value store 'uk-new-companies-feed-state') and outputs only new ones. Schedule daily.", "default": false }, "stateKey": { "title": "Alert name (optional)", "type": "string", "description": "Name for the 'only new' memory. Defaults to a hash of your filters." }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "0 = no limit (about 2,000-4,000 companies are incorporated per working day).", "default": 1000 }, "source": { "title": "Data route", "enum": [ "auto", "api", "csv" ], "type": "string", "description": "Both are official Companies House services. The keyless route returns up to 5,000 companies per day.", "default": "auto" }, "companiesHouseApiKey": { "title": "Companies House API key (optional)", "type": "string", "description": "Free key from developer.company-information.service.gov.uk. Needed for officer names and gives richer addresses." }, "includeOfficers": { "title": "Include current officer names (opt-in, personal data)", "type": "boolean", "description": "Adds current officers' names, roles and appointment dates. These are personal data under UK GDPR: only enable this if you have a lawful basis (for example legitimate interests for B2B outreach) and comply with UK GDPR and PECR. Needs an API key. Persons with significant control are never output.", "default": false }, "maxOfficerLookups": { "title": "Max officer lookups", "minimum": 0, "type": "integer", "description": "One API request per company; Companies House allows 600 requests per 5 minutes.", "default": 100 } } }, "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 } } } } } } } } } }