{ "openapi": "3.0.1", "info": { "title": "Companies House New Incorporations Scraper (UK)", "description": "Newly incorporated UK companies from the official Companies House API: filter by date, SIC code, type, status and location; optional directors.", "version": "0.1", "x-build-id": "0UztUREwZxszoj0uT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/knotty_mistveil~companies-house-new-incorporations/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-knotty_mistveil-companies-house-new-incorporations", "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/knotty_mistveil~companies-house-new-incorporations/runs": { "post": { "operationId": "runs-sync-knotty_mistveil-companies-house-new-incorporations", "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/knotty_mistveil~companies-house-new-incorporations/run-sync": { "post": { "operationId": "run-sync-knotty_mistveil-companies-house-new-incorporations", "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": [ "apiKey" ], "properties": { "apiKey": { "title": "Companies House API key", "type": "string", "description": "Your free Companies House REST API key. Sign in at https://developer.company-information.service.gov.uk/, create an application (live), then create a key. Stored as a secret; never shared." }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 366, "type": "integer", "description": "Look-back window in days for the incorporation date, used when dateFrom is empty. 1 = companies incorporated since yesterday. Roughly 2,000-4,000 companies are incorporated per working day.", "default": 1 }, "dateFrom": { "title": "Incorporated from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Earliest incorporation date (YYYY-MM-DD, inclusive). Overrides daysBack." }, "dateTo": { "title": "Incorporated to", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Latest incorporation date (YYYY-MM-DD, inclusive). Defaults to today." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Only companies with any of these UK SIC 2007 codes, e.g. 62012 (business and domestic software development), 41100 (development of building projects). Leave empty for all industries.", "default": [], "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. Leave empty for all types.", "default": [], "items": { "type": "string" } }, "companyStatus": { "title": "Company status", "enum": [ "active", "any", "dissolved", "liquidation", "receivership", "administration", "voluntary-arrangement", "insolvency-proceedings", "open", "closed", "converted-closed", "registered", "removed" ], "type": "string", "description": "Register status filter. New incorporations are almost always 'active'; choose 'any' to include companies already dissolved or in insolvency.", "default": "active" }, "location": { "title": "Location", "type": "string", "description": "Registered office location text as understood by Companies House, e.g. a town (Manchester), a postcode area (SW1A) or a country (Wales)." }, "nameIncludes": { "title": "Name includes", "type": "string", "description": "Only company names containing this text (matched server-side by Companies House)." }, "nameExcludes": { "title": "Name excludes", "type": "string", "description": "Skip company names containing this text (matched server-side by Companies House)." }, "keywords": { "title": "Keywords", "type": "array", "description": "Case-insensitive OR filter applied to the company name after download. Several words = any of them. Leave empty for no filter.", "default": [], "items": { "type": "string" } }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Also fetch the directors, secretaries and LLP members of each company (name, role, appointment date, nationality, country of residence, occupation, month and year of birth). One extra API request per company, throttled to stay within the Companies House rate limit; included in the per-result price.", "default": false }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many companies. You are charged per company returned.", "default": 500 } } }, "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 } } } } } } } } } }