{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper: New Companies & Directors", "description": "Search the UK Companies House register by incorporation date, SIC code, location, name, status and company type. Get registered address, SIC descriptions, accounts and confirmation-statement due dates and active directors. Daily new-company lead lists.", "version": "0.1", "x-build-id": "sq7Tlg13BNuK9dvje" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapemint~uk-companies-house-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapemint-uk-companies-house-scraper", "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/scrapemint~uk-companies-house-scraper/runs": { "post": { "operationId": "runs-sync-scrapemint-uk-companies-house-scraper", "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/scrapemint~uk-companies-house-scraper/run-sync": { "post": { "operationId": "run-sync-scrapemint-uk-companies-house-scraper", "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": { "incorporatedInLastDays": { "title": "Incorporated in the last N days", "minimum": 0, "type": "integer", "description": "New companies registered in the last N days, today included. Overrides the date fields below. 0 = use the dates below.", "default": 0 }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Earliest incorporation date, YYYY-MM-DD." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Latest incorporation date, YYYY-MM-DD." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Nature of business codes, e.g. 62012 (software development), 56101 (restaurants), 68100 (buying and selling property), 43210 (electricians), 70229 (management consultancy). Each code runs as its own search; companies are not repeated.", "items": { "type": "string" } }, "location": { "title": "Registered office location", "type": "string", "description": "Town, city or postcode in the registered office address, e.g. Manchester or SW1A." }, "nameIncludes": { "title": "Company name includes", "type": "string", "description": "Word or phrase in the company name, e.g. coffee." }, "nameExcludes": { "title": "Company name excludes", "type": "string", "description": "Skip companies whose name contains this." }, "status": { "title": "Company status", "type": "array", "description": "Empty = any status.", "items": { "type": "string", "enum": [ "active", "dissolved", "open", "closed", "converted-closed", "receivership", "liquidation", "administration", "insolvency-proceedings", "voluntary-arrangement" ], "enumTitles": [ "Active", "Dissolved", "Open", "Closed", "Converted / closed", "Receivership", "Liquidation", "Administration", "Insolvency proceedings", "Voluntary arrangement" ] }, "default": [ "active" ] }, "companyTypes": { "title": "Company types", "type": "array", "description": "Empty = any type.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "private-unlimited", "private-limited-guarant-nsc", "limited-partnership", "charitable-incorporated-organisation", "registered-overseas-entity", "uk-establishment" ], "enumTitles": [ "Private limited (Ltd)", "Public limited (PLC)", "LLP", "Private unlimited", "Limited by guarantee", "Limited partnership", "Charitable incorporated organisation", "Registered overseas entity", "UK establishment of overseas company" ] }, "default": [] }, "companyNumbers": { "title": "Or look up company numbers", "type": "array", "description": "Company numbers such as 00445790 or SC906865. When given, the search filters above are ignored.", "items": { "type": "string" } }, "includeDetails": { "title": "Add profile details and officers", "type": "boolean", "description": "Reads each company's page: accounts and confirmation-statement due dates, overdue flags, previous names and active directors and secretaries (name, role, appointed date, nationality, country of residence). Two extra page reads per company, billed as a detailed company.", "default": false }, "maxResults": { "title": "Maximum companies", "minimum": 1, "type": "integer", "description": "Stop after this many companies.", "default": 1000 } } }, "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 } } } } } } } } } }