{ "openapi": "3.0.1", "info": { "title": "UK Company Watch — Companies House Changes on Your List, No Key", "description": "Companies House company data, no API key: paste UK company numbers; each month get only the ones that changed (strike-off, liquidation, overdue accounts, new charges, name, address), with from and to values. No officers. Unofficial: not affiliated with or endorsed by Companies House.", "version": "0.4", "x-build-id": "8IeEbcReEF2xBSIeo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rein8~uk-company-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rein8-uk-company-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/rein8~uk-company-watch/runs": { "post": { "operationId": "runs-sync-rein8-uk-company-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/rein8~uk-company-watch/run-sync": { "post": { "operationId": "run-sync-rein8-uk-company-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", "required": [ "companyNumbers" ], "properties": { "companyNumbers": { "title": "Company numbers to watch", "minLength": 5, "type": "string", "description": "Company numbers, one per line or separated by commas, tabs or spaces. Leading zeros are optional: 445790 = 00445790, SC12345 = SC012345. A number pasted next to its company name is read too (the name is ignored). A number that is not in the live-companies snapshot (a company no longer live, or a typo) is missing from the first run; a watched company that later disappears from the snapshot comes back once as \"No longer on the live snapshot\"." }, "watchFields": { "title": "What counts as a change", "uniqueItems": true, "type": "array", "description": "Leave empty to watch everything below. Pick fields to narrow the watch, e.g. only status and overdue filings. Rows come back only when one of the watched fields differs from the previous run.", "items": { "type": "string", "enum": [ "companyStatus", "accountsOverdue", "confirmationOverdue", "accountsNextDue", "confirmationStatementNextDue", "accountsLastMadeUp", "accountsCategory", "chargesOutstanding", "chargesTotal", "companyName", "previousName", "companyCategory", "sicCodes", "addressLine1", "addressLine2", "postTown", "county", "postalCode" ], "enumTitles": [ "Status (proposal to strike off, liquidation, administration…)", "Accounts overdue (yes/no on the snapshot date)", "Confirmation statement overdue (yes/no)", "Accounts next due date", "Confirmation statement next due date", "Accounts last made up to (they filed)", "Accounts type (dormant → trading, micro → small…)", "Charges outstanding (new borrowing)", "Charges registered in total", "Company name", "Previous name", "Company type", "SIC codes", "Registered office, line 1", "Registered office, line 2", "Post town", "County", "Postcode" ] } }, "incremental": { "title": "Only what changed since the last run", "type": "boolean", "description": "Off (default): every run returns the whole list with its current register facts. On (turn it on for a monthly watch, and save the input as a Task): the first run returns every company (the baseline); each later run returns only the companies whose watched fields changed, with a changes list. If the monthly file has not changed since your last complete run, the run ends at once and nothing is charged.", "default": false }, "stateKey": { "title": "Watch name", "type": "string", "description": "The memory this watch uses to remember the previous run. Left as \"customers\", every saved Task gets its own memory automatically (and a run started by hand remembers per list). Type a name to share one memory between runs on purpose (e.g. \"suppliers-north\"). Changing the name starts a new baseline.", "default": "customers" }, "allowStateFallback": { "title": "Run without memory if the memory cannot be opened", "type": "boolean", "description": "Only matters if a run stops with \"state store unavailable\". Off (default): such a run stops before anything is charged. On: the run continues without memory, i.e. it delivers and charges the whole list again.", "default": false }, "maxItems": { "title": "Max rows", "minimum": 1, "type": "integer", "description": "Maximum rows per run: companies on the first run, changed companies afterwards. 5,000 covers the largest list.", "default": 5000 }, "preview": { "title": "Preview (3 companies, free)", "type": "boolean", "description": "Return 3 companies from your list without any charge, to check the format. A preview does not set the baseline.", "default": false } } }, "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 } } } } } } } } } }