{ "openapi": "3.0.1", "info": { "title": "UK Companies House Monitor - Filings, Officers & Charges", "description": "Change feed on UK companies from the official Companies House register: new filings, director appointments and resignations, status changes, registered charges, and new incorporations by SIC code. Watch a list of company numbers, or find newly incorporated leads. Bring your own free API key.", "version": "0.1", "x-build-id": "6nbf1w0IJ7LdgTUdu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datadeltas~uk-companies-house-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datadeltas-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/datadeltas~uk-companies-house-monitor/runs": { "post": { "operationId": "runs-sync-datadeltas-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/datadeltas~uk-companies-house-monitor/run-sync": { "post": { "operationId": "run-sync-datadeltas-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": [ "apiKey" ], "properties": { "apiKey": { "title": "Companies House API key (required)", "type": "string", "description": "YOUR OWN free Companies House REST API key — the run uses your quota and your 600-requests-per-5-minutes rate limit, not a shared one. Get one in about five minutes: sign in at developer.company-information.service.gov.uk → 'Create an application' (choose the Live environment) → 'Create new key' → pick 'REST' (NOT 'Streaming') and leave the IP restriction empty. Paste it here." }, "companyNumbers": { "title": "Watch-list company numbers", "type": "array", "description": "Companies House numbers to monitor, e.g. 00445790 (Tesco PLC), SC900284, OC301540. All-digit numbers are zero-padded to 8 characters for you, so '445790' also works. Leave empty to run lead-gen mode only.", "items": { "type": "string" } }, "events": { "title": "Events to report", "type": "array", "description": "Which kinds of change produce a dataset record. Fewer events means fewer API requests per company, so a big watch list runs faster.", "items": { "type": "string", "enum": [ "filings", "officers", "status", "charges", "incorporations" ], "enumTitles": [ "Filings — any new document on the filing history (accounts, confirmation statements, capital changes, strike-off notices)", "Officers — director/secretary appointments and resignations", "Status — active → dissolved, liquidation, administration, strike-off", "Charges — new registered charges and satisfaction of existing ones", "Incorporations — new companies matching the filter below (lead-gen mode)" ] }, "default": [ "filings", "officers", "status", "charges" ] }, "incorporationFilter": { "title": "New-incorporation filter (lead-gen mode)", "type": "object", "description": "Only used when 'incorporations' is selected above. Finds companies newly registered at Companies House matching these SIC codes within the window — a lead list of brand-new UK businesses in your sector." }, "maxItems": { "title": "Max changes per run", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Cap on change records emitted in a single run (cost control). The cap is shared fairly across watched companies, so one noisy company cannot crowd out the rest; anything over the cap is emitted on the next run.", "default": 500 } } }, "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 } } } } } } } } } }