{ "openapi": "3.0.1", "info": { "title": "Companies House Monitor - UK Filing, Director & PSC Alerts", "description": "Watch UK companies and officers on Companies House. Get one row, webhook or Slack message per change: new filings, director moves, PSC, charges, status, address, name. $0.02 per alert.", "version": "0.1", "x-build-id": "7r6Whx8Jvptfd1kxh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/skillmerc~companies-house-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-skillmerc-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/skillmerc~companies-house-monitor/runs": { "post": { "operationId": "runs-sync-skillmerc-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/skillmerc~companies-house-monitor/run-sync": { "post": { "operationId": "run-sync-skillmerc-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": "Company numbers", "type": "array", "description": "Companies House company numbers to watch, e.g. 00102498 (BP), 00445790 (Tesco). Up to a few hundred per watchlist.", "items": { "type": "string" } }, "officerIds": { "title": "Officer IDs (optional)", "type": "array", "description": "Companies House officer IDs (the part after /officers/ in a Companies House URL). Alerts when that person takes or leaves an appointment at any company.", "items": { "type": "string" } }, "watch": { "title": "Changes to watch", "type": "array", "description": "Which kinds of change raise an alert. Leave all selected to watch everything.", "items": { "type": "string", "enum": [ "new_filings", "officers", "psc", "status", "registered_office", "charges", "name_change" ], "enumTitles": [ "New filings", "Officer appointments and resignations", "Persons with significant control", "Company status (liquidation, dissolution, administration)", "Registered office address", "Charges (mortgages, debentures)", "Company name" ] }, "default": [ "new_filings", "officers", "psc", "status", "registered_office", "charges", "name_change" ] }, "initialLookbackDays": { "title": "Initial lookback (days)", "minimum": 0, "maximum": 3650, "type": "integer", "description": "On the very first run for a watchlist, also report changes dated within this many days. 0 means the first run only saves a baseline and reports nothing. Use 30 to see recent activity immediately.", "default": 0 }, "watchlistName": { "title": "Watchlist name", "type": "string", "description": "Name for this watchlist. The actor keeps its last snapshot in a key-value store named companies-house-monitor-. If left empty, the name is derived from the list of company numbers, so changing the list starts a fresh baseline." }, "webhookUrl": { "title": "Webhook URL (optional)", "pattern": "^https?://.+", "type": "string", "description": "HTTPS endpoint that receives one POST per run with the run summary and the list of alerts as JSON." }, "slackWebhookUrl": { "title": "Slack incoming webhook URL (optional)", "pattern": "^https://hooks\\.slack\\.com/.+", "type": "string", "description": "Slack incoming webhook. One message per run listing the changes." }, "maxAlertsPerRun": { "title": "Max alerts per run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Cap on alert rows delivered (and charged) in one run. Extra changes are counted in the run summary but not delivered.", "default": 500 }, "apiKey": { "title": "Companies House API key (optional)", "type": "string", "description": "Leave blank to use the built-in key. Provide your own free key from developer.company-information.service.gov.uk if you want your own rate limit." } } }, "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 } } } } } } } } } }