{ "openapi": "3.0.1", "info": { "title": "Companies House Monitor — filings, officers, PSC changes", "description": "Know the moment a UK company you care about files at Companies House, changes a director, changes a PSC, changes its name or is dissolved. Give it company numbers or names; it watches filing history, officers, PSCs and the profile, and emits only what changed — with the previous value.", "version": "0.1", "x-build-id": "PSqX5E46TFNm4NyBr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/multiplex~companies-house-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-multiplex-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/multiplex~companies-house-monitor/runs": { "post": { "operationId": "runs-sync-multiplex-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/multiplex~companies-house-monitor/run-sync": { "post": { "operationId": "run-sync-multiplex-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": [ "apiKey", "companies" ], "properties": { "apiKey": { "title": "Companies House API key", "type": "string", "description": "Free REST API key from the Companies House developer hub. Sign in at https://developer.company-information.service.gov.uk/, open **Manage applications**, create an application, then create a **REST API key** for it. A stream key or an OAuth web client will NOT authenticate these endpoints. The key is sent as the HTTP Basic username with a blank password, exactly as Companies House documents." }, "companies": { "title": "Companies to watch", "type": "array", "description": "One per line. A company number (`00445790`, `445790`, `SC123456`) is used as typed — short numbers are zero-padded to the register's eight characters. Anything else is treated as a name and resolved through the official company search; the match is written to the log, so check it. Supply numbers when you need certainty.", "items": { "type": "string" } }, "track": { "title": "What to track", "enum": [ "all", "filings", "officers", "psc", "profile" ], "type": "string", "description": "Which part of the register to watch. `all` is one profile call plus three per company.", "default": "all" }, "changesOnly": { "title": "Changes only (monitor mode)", "type": "boolean", "description": "Emit only what is new, changed or gone since the previous run of this actor on the same company. State is kept in the named key-value store `companies-house-state`. Changed rows carry `changedFields`, `previousStatus` and `previousDescription`. The first run emits everything once as the baseline. Filings are never reported as removed — the filing history is append-only.", "default": false }, "maxCompanies": { "title": "Max companies per run", "minimum": 1, "type": "integer", "description": "Caps how many companies one run touches, so a long watchlist cannot walk into the API's 600-requests-per-5-minutes limit. `track: all` costs 4 requests per company.", "default": 25 }, "maxFilings": { "title": "Max filings per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "How far back into the filing history each run looks. 25 is plenty for a nightly monitor; raise it for a first-run backfill.", "default": 25 } } }, "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 } } } } } } } } } }