{ "openapi": "3.0.1", "info": { "title": "UK Company Lookup and Filing Monitor", "description": "Look up UK companies and get alerts on new filings from the official Companies House API. Search by name, pull full records with officers and controllers, or monitor companies for new filings. Needs your own free Companies House API key. Pay per row.", "version": "0.0", "x-build-id": "Tj5McAjizKEY4voTz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/texxupport~uk-company-filing-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-texxupport-uk-company-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/texxupport~uk-company-filing-monitor/runs": { "post": { "operationId": "runs-sync-texxupport-uk-company-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/texxupport~uk-company-filing-monitor/run-sync": { "post": { "operationId": "run-sync-texxupport-uk-company-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": { "companiesHouseApiKey": { "title": "Companies House API key", "type": "string", "description": "Required unless the Actor's owner has set one. Free: register on the Companies House developer hub, create an application and add a REST key (do not restrict it to particular IP addresses). Keys are limited to 600 requests per 5 minutes." }, "mode": { "title": "What to do", "enum": [ "search", "lookup", "monitor" ], "type": "string", "description": "Search finds companies by name. Lookup returns the full record for company numbers you give. Monitor returns new filings for company numbers you give.", "default": "lookup" }, "searchTerms": { "title": "Company names to search (search mode)", "type": "array", "description": "A company name or part of one. Each term is a separate search.", "items": { "type": "string" } }, "activeOnly": { "title": "Active companies only (search mode)", "type": "boolean", "description": "Leave out dissolved and closed companies.", "default": true }, "companyNumbers": { "title": "Company numbers (lookup and monitor modes)", "type": "array", "description": "Companies House numbers such as 00000006 or SC123456. A number without its leading zeros is padded automatically.", "items": { "type": "string" } }, "includeOfficers": { "title": "Include officers (lookup mode)", "type": "boolean", "description": "Add the company's directors and secretaries. Costs one extra request per company.", "default": false }, "includeResignedOfficers": { "title": "Include resigned officers", "type": "boolean", "description": "With officers on, also list people who have resigned.", "default": false }, "includePersonsWithSignificantControl": { "title": "Include persons with significant control (lookup mode)", "type": "boolean", "description": "Add the people and companies recorded as controlling this company. Costs one extra request per company.", "default": false }, "categories": { "title": "Filing categories (monitor mode)", "type": "array", "description": "Only these kinds of filing. Leave empty for all.", "items": { "type": "string", "enum": [ "accounts", "address", "annual-return", "capital", "change-of-name", "confirmation-statement", "incorporation", "insolvency", "liquidation", "miscellaneous", "mortgage", "officers", "resolution", "persons-with-significant-control", "gazette", "other" ], "enumTitles": [ "Accounts", "Registered office address", "Annual return", "Share capital", "Change of name", "Confirmation statement", "Incorporation", "Insolvency", "Liquidation", "Miscellaneous", "Charges (mortgages)", "Officers", "Resolutions", "Persons with significant control", "Gazette notices", "Other" ] } }, "daysBack": { "title": "Days back (monitor mode)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "How far back to look for filings, counted from today. Ignored when you fill in a start date.", "default": 30 }, "dateFrom": { "title": "Start date (monitor mode, optional)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "First filing date to include, written YYYY-MM-DD." }, "onlyNew": { "title": "Only filings not delivered before (monitor mode)", "type": "boolean", "description": "Turn this on and run the Actor on a schedule to get an alert-style feed. The Actor remembers which filings it delivered for each company.", "default": true }, "maxResults": { "title": "Maximum rows", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many rows. You pay per row delivered, so this also caps your cost.", "default": 100 }, "maxRequests": { "title": "Maximum requests to Companies House", "minimum": 1, "maximum": 1500, "type": "integer", "description": "Safety limit per run. The Actor also paces itself to stay under 600 requests per 5 minutes.", "default": 300 } } }, "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 } } } } } } } } } }