{ "openapi": "3.0.1", "info": { "title": "UK Fresh Companies + Beneficial Owners (Companies House)", "description": "Daily feed of newly-incorporated UK companies from the official Companies House API, enriched with directors and PSC (beneficial owners). Filter by SIC industry and status. For B2B prospecting, KYB and AML onboarding. Bring your own free API key.", "version": "0.1", "x-build-id": "sGoWGNBKJZZtGLguJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/akeeml~uk-fresh-companies-psc/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-akeeml-uk-fresh-companies-psc", "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/akeeml~uk-fresh-companies-psc/runs": { "post": { "operationId": "runs-sync-akeeml-uk-fresh-companies-psc", "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/akeeml~uk-fresh-companies-psc/run-sync": { "post": { "operationId": "run-sync-akeeml-uk-fresh-companies-psc", "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 own free Companies House Public Data API key. Get one at developer.company-information.service.gov.uk → register an application → 'Live'/Public Data API key. Stored securely." }, "lastNDays": { "title": "Look-back window (days)", "minimum": 1, "maximum": 90, "type": "integer", "description": "Include companies incorporated in the last N days. Ignored if 'Incorporated from' is set. For a daily schedule, use 1–2.", "default": 7 }, "incorporatedFrom": { "title": "Incorporated from (YYYY-MM-DD)", "type": "string", "description": "Only companies incorporated on/after this date. Overrides the look-back window." }, "sicCodes": { "title": "SIC industry codes", "type": "array", "description": "Filter to these SIC industry codes, e.g. 62012 (business software), 56101 (restaurants). Empty = all industries.", "items": { "type": "string" } }, "companyStatus": { "title": "Company status", "type": "array", "description": "Company statuses to include. Default: active.", "default": [ "active" ], "items": { "type": "string" } }, "includeOfficers": { "title": "Include officers (directors)", "type": "boolean", "description": "Fetch each company's officers (directors / secretaries). Adds one API call per company.", "default": true }, "includePsc": { "title": "Include PSC (beneficial owners)", "type": "boolean", "description": "Fetch each company's Persons with Significant Control — the beneficial owners, for KYB/AML. Adds one API call per company.", "default": true }, "maxResults": { "title": "Max companies", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum companies per run. Keep modest: with officers + PSC on, each company uses ~3 API calls, and Companies House allows 600 calls / 5 min per key.", "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 } } }, "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 } } } } } } } } } }