{ "openapi": "3.0.1", "info": { "title": "Companies House Registry Watch (UK companies, officers, PSC)", "description": "Search UK companies by SIC code, postcode and incorporation date via the official Companies House API. Officers and PSC included. Monitor new incorporations. Pay per result, no API key needed.", "version": "0.1", "x-build-id": "yTlPhu3b9A4ab0jLT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/registry-watch-data~companies-house-registry-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-registry-watch-data-companies-house-registry-watch", "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/registry-watch-data~companies-house-registry-watch/runs": { "post": { "operationId": "runs-sync-registry-watch-data-companies-house-registry-watch", "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/registry-watch-data~companies-house-registry-watch/run-sync": { "post": { "operationId": "run-sync-registry-watch-data-companies-house-registry-watch", "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": { "searchQueries": { "title": "Company name search", "type": "array", "description": "Free-text company name queries (Companies House search). Example: [\"bakery\", \"solar\"].", "items": { "type": "string" } }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Exact company numbers to fetch, e.g. [\"00000006\", \"SC000001\"].", "default": [], "items": { "type": "string" } }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Filter by SIC code(s), e.g. [\"62012\"] (business and domestic software development). Uses the advanced search.", "default": [], "items": { "type": "string" } }, "postcodePrefix": { "title": "Postcode / location", "type": "string", "description": "Registered office location filter, e.g. \"SW1A\" or \"Manchester\" (advanced search)." }, "incorporatedFrom": { "title": "Incorporated from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only companies incorporated on or after this date (YYYY-MM-DD)." }, "incorporatedTo": { "title": "Incorporated to", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only companies incorporated on or before this date (YYYY-MM-DD)." }, "status": { "title": "Company status", "enum": [ "any", "active", "dissolved", "liquidation", "administration" ], "type": "string", "description": "Filter by status.", "default": "active" }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Fetch current and resigned officers for each company (charged per officer).", "default": false }, "includePSC": { "title": "Include persons with significant control", "type": "boolean", "description": "Fetch PSC for each company (charged per PSC).", "default": false }, "monitorMode": { "title": "Monitor mode (only new companies since last run)", "type": "boolean", "description": "Remembers company numbers already seen in previous runs of this task and outputs only new ones, with isNew = true. Charged per delta instead of per company.", "default": false }, "maxItems": { "title": "Max companies", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many companies (across all queries).", "default": 20 } } }, "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 } } } } } } } } } }