{ "openapi": "3.0.1", "info": { "title": "UK New Companies Tracker by SIC Code & Region", "description": "Track the UK company register by SIC code, region and status. Get only the companies that are new, changed or removed since your last run, ready to schedule daily. Also works as a one-off search.", "version": "0.1", "x-build-id": "7iSmHG7VAUhB2fBzX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/belgair~companies-house-uk-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-belgair-companies-house-uk-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/belgair~companies-house-uk-watch/runs": { "post": { "operationId": "runs-sync-belgair-companies-house-uk-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/belgair~companies-house-uk-watch/run-sync": { "post": { "operationId": "run-sync-belgair-companies-house-uk-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": { "query": { "title": "Company name contains", "type": "string", "description": "Only companies whose name contains this text, e.g. bakery. Leave empty to search on the other filters only." }, "sicCodes": { "title": "SIC codes (nature of business)", "type": "array", "description": "UK SIC 2007 codes, 5 digits, e.g. 10710 (bakeries) or 62012 (software development). A company matches if it has any of these codes.", "items": { "type": "string" } }, "location": { "title": "Postcode or town", "type": "string", "description": "Text in the registered office address, e.g. London, Manchester or a postcode like M1. It is a text match: Cambridge also finds 2 Cambridge Road in Barking, so check the city and postalCode columns. Leave empty for the whole UK." }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Only companies incorporated on or after this date." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Only companies incorporated on or before this date." }, "status": { "title": "Company status", "type": "array", "description": "Only companies with one of these statuses. Leave empty for all statuses.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "administration", "receivership", "insolvency-proceedings", "voluntary-arrangement", "converted-closed", "open", "closed", "removed" ], "enumTitles": [ "Active", "Dissolved", "Liquidation", "In administration", "Receivership", "Insolvency proceedings", "Voluntary arrangement", "Converted / closed", "Open (overseas)", "Closed (overseas)", "Removed" ] }, "default": [] }, "onlyNew": { "title": "Only new or changed since the last run", "type": "boolean", "description": "Return only companies that are new, changed (name, status, address, SIC codes) or removed since the previous run with the same filters. The first run saves a baseline and returns nothing. Schedule this task daily to get a daily list of new companies; you only pay for the changes.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many companies. With tracking on: the most changes delivered per run; the rest follows in the next run. Companies House returns at most 10,000 per search. You only pay for companies that are saved.", "default": 100 }, "apiKey": { "title": "Your own Companies House API key (optional)", "type": "string", "description": "Not needed: leave empty to use ours. Heavy users can add their own free key from developer.company-information.service.gov.uk to get a separate rate limit and faster runs. Stored encrypted." } } }, "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 } } } } } } } } } }