{ "openapi": "3.0.1", "info": { "title": "UK Companies House New Incorporations Scraper", "description": "New UK companies from the official Companies House API: companies incorporated in a date range with SIC code, company type, status, locality and postcode filters. Number, name, SIC codes, registered office and daily new-company alerts.", "version": "0.1", "x-build-id": "LeRXWafxcs6yv7vkq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/komos_solutions~uk-companies-house-new-incorporations/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-komos_solutions-uk-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/komos_solutions~uk-companies-house-new-incorporations/runs": { "post": { "operationId": "runs-sync-komos_solutions-uk-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/komos_solutions~uk-companies-house-new-incorporations/run-sync": { "post": { "operationId": "run-sync-komos_solutions-uk-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", "properties": { "apiKey": { "title": "Companies House API key", "type": "string", "description": "Your free Companies House REST API key (developer.company-information.service.gov.uk > Your applications > Create an application > Live > Create new key > REST). Stored encrypted. Without a key the Actor only returns 3 labelled sample rows, free of charge." }, "daysBack": { "title": "Incorporated in the last N days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Used when 'Incorporated from' is empty: search companies incorporated from N days before 'Incorporated to' (or today). 0 = today only.", "default": 7 }, "incorporatedFrom": { "title": "Incorporated from (optional)", "type": "string", "description": "YYYY-MM-DD. Overrides 'last N days'." }, "incorporatedTo": { "title": "Incorporated to (optional)", "type": "string", "description": "YYYY-MM-DD. Empty = today." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "5-digit SIC 2007 codes (e.g. 62012 software development, 41100 development of building projects) or a 2-4 digit prefix such as 62 (all IT) or 4321. Empty = all industries.", "default": [], "items": { "type": "string" } }, "companyTypes": { "title": "Company types", "type": "array", "description": "Companies House company_type values, e.g. ltd, plc, llp. Empty = all types.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-limited-shares-section-30-exemption", "private-unlimited", "private-unlimited-nsc", "limited-partnership", "scottish-partnership", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "registered-society-non-jurisdictional", "uk-establishment", "registered-overseas-entity", "oversea-company", "northern-ireland", "other" ] }, "default": [] }, "companyStatus": { "title": "Company status", "type": "array", "description": "Companies House company_status values. Default: active. Empty = any status.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "receivership", "administration", "voluntary-arrangement", "insolvency-proceedings", "converted-closed", "open", "closed", "registered", "removed" ] }, "default": [ "active" ] }, "location": { "title": "Registered office location (API search)", "type": "string", "description": "Free-text location passed to the Companies House 'location' filter, matched against the registered office address, e.g. Leeds or Manchester." }, "localities": { "title": "Exact localities (town/city)", "type": "array", "description": "Optional strict filter on the registered office locality (case-insensitive exact match), e.g. London, Bristol.", "default": [], "items": { "type": "string" } }, "postcodePrefixes": { "title": "Postcode prefixes", "type": "array", "description": "Optional registered office postcode filter. Letters only = postcode area (M matches M1, M14 but not ME). With digits = prefix (SW1 matches SW1A, SW1P; 'LS1 4' = sector).", "default": [], "items": { "type": "string" } }, "companyNameIncludes": { "title": "Company name includes", "type": "string", "description": "Optional word(s) the company name must include, e.g. solar." }, "maxItems": { "title": "Max companies", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum companies to output (you pay per company). Ranges above 10,000 hits are split by date automatically.", "default": 20 }, "onlyNew": { "title": "Alert mode: only new companies", "type": "boolean", "description": "Only output companies not returned by previous runs that used the same state store. Ideal for a daily schedule.", "default": false }, "stateStoreName": { "title": "State store name (alert mode)", "type": "string", "description": "Named key-value store that remembers seen company numbers. Use a different name per saved search or schedule.", "default": "uk-ch-new-incorporations-seen" }, "includeOfficers": { "title": "Include officers (opt-in, personal data)", "type": "boolean", "description": "OFF by default. When on, adds activeOfficerCount and, for each active officer, ONLY: name, role, appointment date, nationality, month and year of birth (never the day) and correspondence address. Home/residential addresses and all other officer fields are never collected. Officers are personal data: you are responsible for UK GDPR and PECR compliance (see README). Uses one extra API request per company (slower), no extra charge.", "default": false } } }, "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 } } } } } } } } } }