{ "openapi": "3.0.1", "info": { "title": "Companies House Filing Monitor - UK Company Changes", "description": "Monitor filings for explicit UK company watchlists. Export filing dates, types, descriptions and document links, with saved new or changed observations. No API key.", "version": "1.0", "x-build-id": "ZrNh3Etu0KgI2PbO1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maydit~companies-house-filing-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maydit-companies-house-filing-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/maydit~companies-house-filing-monitor/runs": { "post": { "operationId": "runs-sync-maydit-companies-house-filing-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/maydit~companies-house-filing-monitor/run-sync": { "post": { "operationId": "run-sync-maydit-companies-house-filing-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", "properties": { "companyNumbers": { "title": "UK company numbers", "type": "array", "description": "Explicit watchlist of at most 20 Companies House numbers, including leading zeros or a two-letter prefix. Empty input uses Tesco 00445790. No bulk company discovery.", "items": { "type": "string" } }, "filingTypes": { "title": "Filing type codes", "type": "array", "description": "Optional exact published codes, such as AA, CS01 or SH03. Match is case insensitive; multiple codes are ORed.", "items": { "type": "string" } }, "filedFrom": { "title": "Filed on or after", "type": "string", "description": "Optional inclusive YYYY-MM-DD bound on the date filed at Companies House, not the effective date mentioned in a document." }, "filedTo": { "title": "Filed on or before", "type": "string", "description": "Optional inclusive YYYY-MM-DD filed-date upper bound. Only the selected source pages are inspected." }, "maxSourcePages": { "title": "Maximum pages per company", "minimum": 1, "maximum": 3, "type": "integer", "description": "Read 1–3 official filing-history pages per company. The chosen window is validated before output; additional older pages are not inferred or searched.", "default": 1 }, "maxResults": { "title": "Maximum saved filings", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper bound on paid saved rows. Unchanged observations skipped by onlyChanges do not consume this limit.", "default": 5 }, "comparePrevious": { "title": "Compare with saved observations", "type": "boolean", "description": "Compare within this exact configured watchlist/scope. The first run reports new observations; history advances only after confirmed saved output.", "default": false }, "onlyChanges": { "title": "Only new or changed observations", "type": "boolean", "description": "Enables comparison and skips unchanged observations. First observations are emitted. A valid no-change run has zero results and a warning.", "default": false }, "snapshotName": { "title": "Snapshot name", "type": "string", "description": "1–80 letters, numbers, underscores or hyphens. Use one writer per name/scope. Concurrent modification is checked before saving, but the store is not an atomic lock.", "default": "default" }, "maxRunSeconds": { "title": "Run time budget (seconds)", "minimum": 30, "maximum": 900, "type": "integer", "description": "Own wall-clock deadline, also bounded by the platform deadline with a 25-second safety reserve. Network requests and retry delays stay within it.", "default": 240 } } }, "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 } } } } } } } } } }