{ "openapi": "3.0.1", "info": { "title": "Companies House Bulk Data: UK Companies + Monthly Changes", "description": "UK companies from the official Companies House bulk file, no API key: number, name, status, SIC codes, registered office. Monthly feed of new, dissolved and changed companies. From $1.50 per 1,000. No personal data.", "version": "0.1", "x-build-id": "chokzD3WleOCerhrr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wrtcom~uk-company-registry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wrtcom-uk-company-registry", "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/wrtcom~uk-company-registry/runs": { "post": { "operationId": "runs-sync-wrtcom-uk-company-registry", "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/wrtcom~uk-company-registry/run-sync": { "post": { "operationId": "run-sync-wrtcom-uk-company-registry", "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": { "mode": { "title": "Mode", "enum": [ "changes", "snapshot" ], "type": "string", "description": "'changes' = companies that are new, gone (dissolved / struck off) or changed since your previous run with the same filters. The FIRST run only builds the baseline and reports companies incorporated between 'Incorporated from' and 'Incorporated to' (default: the last 31 days) as new. 'snapshot' = one record per live company that matches the filters.", "default": "snapshot" }, "sicPrefixes": { "title": "SIC code prefixes", "type": "array", "description": "Keep companies with at least one SIC code starting with any of these (e.g. '62' = IT, '6201' = programming, '56101' = restaurants). Empty = all. Changes mode needs filters: it tracks up to ~380,000 companies at the default 1 GB memory (about 1.6 million at 4 GB); the whole register is ~5.7 million.", "items": { "type": "string" } }, "postcodePrefixes": { "title": "Postcode prefixes", "type": "array", "description": "Registered office postcode starts with any of these, spaces ignored (e.g. 'SW1', 'EC1A', 'M'). End a value with a space for an exact outward code: 'E1 ' matches E1 but not E14. Empty = all.", "items": { "type": "string" } }, "companyStatus": { "title": "Company status", "type": "array", "description": "Exact status, case-insensitive: e.g. 'Active', 'Active - Proposal to Strike off', 'Liquidation', 'In Administration', 'Voluntary Arrangement'. Empty = all (the file holds live companies only).", "items": { "type": "string" } }, "companyCategory": { "title": "Company type", "type": "array", "description": "Exact type, case-insensitive: e.g. 'Private Limited Company', 'Public Limited Company', 'Limited Liability Partnership', 'Community Interest Company', 'Charitable Incorporated Organisation', 'Overseas Entity'. Empty = all.", "items": { "type": "string" } }, "dateFrom": { "title": "Incorporated from", "type": "string", "description": "Only companies incorporated on or after this date (YYYY-MM-DD). Changes mode, first run: also the start of the window of companies reported as new (default 31 days before 'Incorporated to')." }, "dateTo": { "title": "Incorporated to", "type": "string", "description": "Only companies incorporated on or before this date (YYYY-MM-DD). Default: no limit (first-run window ends today)." }, "keywords": { "title": "Name keywords", "type": "array", "description": "Keep only companies whose name contains any of these words (case-insensitive). Empty = all.", "items": { "type": "string" } }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Stop after this many results (you pay per result). The form starts at 50 for a quick test; default without a value is 1000. Changes mode: a run that stops early saves no new state, so the next run (with 'Only new') continues where it stopped.", "default": 1000 }, "onlyNew": { "title": "Only new since last run", "type": "boolean", "description": "Skip records already returned by earlier runs on your account. Recommended for the change feed with a monthly schedule.", "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 } } } } } } } } } }