{ "openapi": "3.0.1", "info": { "title": "UK Companies House Monitor: Filings, Director & Status Changes", "description": "Watch a list of UK companies on the official Companies House API and get only what changed: new filings, director appointments and departures, PSC (owner) changes, liquidation, strike-off or dissolution, name, address and SIC changes, overdue accounts and new charges.", "version": "1.0", "x-build-id": "a3WbOK0Ecjsj3JOZa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mercury_ops~uk-companies-house-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mercury_ops-uk-companies-house-monitor", "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/mercury_ops~uk-companies-house-monitor/runs": { "post": { "operationId": "runs-sync-mercury_ops-uk-companies-house-monitor", "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/mercury_ops~uk-companies-house-monitor/run-sync": { "post": { "operationId": "run-sync-mercury_ops-uk-companies-house-monitor", "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": [ "companyNumbers" ], "properties": { "companyNumbers": { "title": "Watchlist: company numbers", "type": "array", "description": "One per line: company numbers (00445790, SC002934, OC301234) or Companies House URLs. Up to 500 on the Actor's shared key, 5,000 with your own key.", "items": { "type": "string" } }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Snapshots are saved per monitor name and company in a key-value store named 'uk-companies-house-monitor-state' in your account. Use different names for separate watchlists.", "default": "default" }, "firstRunLookbackDays": { "title": "First-run lookback (days)", "minimum": 0, "maximum": 365, "type": "integer", "description": "On the first run for a company, also report filings, director appointments and PSC notifications from the last N days, so you get useful output straight away. 0 = baseline only.", "default": 14 }, "watchFilings": { "title": "New filings", "type": "boolean", "description": "Accounts, confirmation statements, appointments/terminations, share allotments, charges, insolvency and strike-off notices, address changes.", "default": true }, "watchOfficers": { "title": "Director/secretary changes", "type": "boolean", "description": "New appointments and officers who are no longer active.", "default": true }, "watchPscs": { "title": "Owner (PSC) changes", "type": "boolean", "description": "New persons with significant control and ceased PSCs.", "default": true }, "watchCharges": { "title": "Charges (lending)", "type": "boolean", "description": "New charges and charges satisfied (one extra API call per company).", "default": false }, "includeBirthMonthYear": { "title": "Include officer/PSC birth month and year", "type": "boolean", "description": "Public on the register, but personal data: only switch on if you have a lawful basis. Off by default.", "default": false }, "apiKey": { "title": "Your Companies House API key (optional)", "type": "string", "description": "Optional. Runs use the Actor's own key by default (shared, fair-use paced). For big watchlists add your own free REST API key from developer.company-information.service.gov.uk. Stored encrypted; never logged or output." } } }, "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 } } } } } } } } } }