{ "openapi": "3.0.1", "info": { "title": "UK Multi-Company Owners from Companies House", "description": "People who control 2 or more UK companies, by postcode area: one row per owner with how many companies they control and each company's name, status, activity, incorporation date and share band. From the official Companies House registers. No phone or email: the registers do not publish them.", "version": "1.0", "x-build-id": "SmYOdHdcqA4B0fE4R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wellbuilt_zythem~uk-company-owners/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wellbuilt_zythem-uk-company-owners", "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/wellbuilt_zythem~uk-company-owners/runs": { "post": { "operationId": "runs-sync-wellbuilt_zythem-uk-company-owners", "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/wellbuilt_zythem~uk-company-owners/run-sync": { "post": { "operationId": "run-sync-wellbuilt_zythem-uk-company-owners", "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": { "postcodeAreas": { "title": "Postcode areas", "type": "array", "description": "The 1 or 2 letters at the start of a UK postcode: M (Manchester), B (Birmingham), LS (Leeds), G (Glasgow), EH (Edinburgh), BT (Northern Ireland), SW, W, EC (London). Each owner is placed in the area of their service address. Leave empty for the whole UK.", "items": { "type": "string" } }, "minCompanies": { "title": "Minimum companies per owner", "minimum": 2, "type": "integer", "description": "Only people who control at least this many companies. 2 includes everyone with a second company; 5 or more finds serial owners.", "default": 3 }, "maxCompanies": { "title": "Maximum companies per owner", "minimum": 2, "type": "integer", "description": "Optional. People with hundreds of companies are usually company formation agents, nominees or mass registrations of dormant companies: 50 leaves them out." }, "onlyActiveCompanies": { "title": "Count only active companies", "type": "boolean", "description": "On: companies in liquidation, in administration or being struck off are left out of each portfolio and of the count.", "default": true }, "sicPrefixes": { "title": "Industry (SIC code starts with)", "type": "array", "description": "Optional. Keep owners with at least one company in these activities, by UK SIC 2007 code: 68 (real estate), 55 (hotels and holiday lets), 56 (restaurants and bars), 41 (building), 86 (health), 62 (software).", "items": { "type": "string" } }, "newCompanyWithinDays": { "title": "Started a company in the last N days", "minimum": 1, "type": "integer", "description": "Optional. Only owners with a company incorporated within this many days. For companies newer than the monthly company register, the date the person was registered as owner is used." }, "maxResults": { "title": "Maximum owners", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Owners with the most companies come first.", "default": 1000 }, "refreshCopy": { "title": "Refresh the data copy (Actor owner only)", "type": "boolean", "description": "Reserved for the Actor's scheduled monthly refresh. Ignored in every other run.", "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 } } } } } } } } } }