{ "openapi": "3.0.1", "info": { "title": "UK Insolvency Notice Alerts: Gazette Winding-Up Petitions", "description": "Every new UK corporate insolvency notice in The Gazette: winding-up petitions and orders, administrations, liquidations, by type, keyword or company number. Monitor The Gazette for winding up petitions: only-new alerts to Slack, Discord or Telegram, or UK administration notices to Google Sheets.", "version": "1.0", "x-build-id": "2Y1btKzH9ZEoHVy4D" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~uk-insolvency-notice-alerts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-uk-insolvency-notice-alerts", "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/accountable_eel~uk-insolvency-notice-alerts/runs": { "post": { "operationId": "runs-sync-accountable_eel-uk-insolvency-notice-alerts", "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/accountable_eel~uk-insolvency-notice-alerts/run-sync": { "post": { "operationId": "run-sync-accountable_eel-uk-insolvency-notice-alerts", "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": { "companyNumbers": { "title": "Company numbers to watch (optional)", "type": "array", "description": "Optional. One Companies House number per line (8 characters, e.g. 08706800 or SC123456). Leave empty to watch every corporate notice of the chosen type. Accepted formats: 08706800, SC123456. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "noticeTypes": { "title": "Notice type", "enum": [ "all-corporate", "winding-up-petition", "winding-up-order", "administration", "liquidation" ], "type": "string", "description": "Personal insolvency (bankruptcy orders, IVAs) is never returned. Receivership and moratorium notices are not offered yet: their Gazette codes were not in the sample this actor was built from.", "default": "all-corporate" }, "keywords": { "title": "Keywords (optional)", "type": "array", "description": "Optional. One per line. A notice is kept when its company name or notice text contains any of them (case-insensitive).", "items": { "type": "string" } }, "sinceDays": { "title": "Published in the last N days", "type": "integer", "description": "1 to 60. The Gazette publishes insolvency notices every working day; the window is counted back from today.", "default": 3 }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit." }, "onlyNewSinceLastRun": { "title": "Only return notices that are new since the last run", "type": "boolean", "description": "Turns this actor into an insolvency alert. A notice counts as new when its Gazette notice ID has not been returned for this watchlist before. Already-seen notices are dropped before you are billed. The first run returns up to your cap and remembers the rest of the window.", "default": false }, "deltaName": { "title": "Watchlist name (optional)", "type": "string", "description": "Leave empty and the memory is kept per notice type, keywords and company numbers. Type your own name to keep two schedules apart.", "default": "" }, "quietRunOutput": { "title": "What a quiet monitoring run writes to the dataset", "enum": [ "summary", "none" ], "type": "string", "description": "A quiet run is a search with no new notices. 'Nothing' writes zero items, so an integration never has to skip rows.", "default": "summary" }, "notifyUrl": { "title": "Send alerts to (Discord or Slack webhook, Telegram bot link, or any URL)", "type": "string", "description": "Optional, needs monitoring on. After the notices are billed, each new notice is posted here as one message: headline, date, link and summary. Discord or Slack: paste the channel's webhook URL. Telegram: https://api.telegram.org/bot/sendMessage?chat_id=. Any other URL receives JSON. Messages are free, and a message that fails never fails the run (the row's notifyErrors says why). Stored encrypted, never logged or written to the results." }, "notifyFormat": { "title": "Message format", "enum": [ "auto", "discord", "slack", "telegram", "json" ], "type": "string", "description": "Leave on \"Detect from the link\": discord.com links get Discord messages, hooks.slack.com Slack, api.telegram.org Telegram, anything else JSON.", "default": "auto" }, "maxNotificationsPerRun": { "title": "Most alert messages per run", "type": "integer", "description": "Up to 100. Above this, one \"+N more\" message says how many more notices are in the run's dataset.", "default": 20 }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "searchSummary", "noticeCount", "notices", "noticeId", "title", "noticeCode", "noticeType", "sourceName", "companyName", "companyNumber", "publishedAt", "summary", "petitionHearingDate", "courtOrInsolvencyPractitioner", "url", "companiesHouseUrl", "isNew", "firstSeenAt" ], "enumTitles": [ "Search run", "Notices returned", "All notices (full list)", "Gazette notice ID", "Headline", "Gazette notice code", "Notice type", "Notice label (as published)", "Company name", "Company number", "Published", "Notice summary", "Hearing date", "Court", "Gazette notice", "Companies House page", "Is this notice new?", "First seen on a run" ] }, "default": [ "searchSummary", "noticeCount", "notices", "noticeId", "title", "noticeCode", "noticeType", "sourceName", "companyName", "companyNumber", "publishedAt", "summary", "petitionHearingDate", "courtOrInsolvencyPractitioner", "url", "companiesHouseUrl", "isNew", "firstSeenAt" ] }, "expandRows": { "title": "One row per notice (recommended) — turn off for one row per notice instead", "type": "boolean", "description": "When on, each notice found gets its own row instead of being grouped under its notice. You're still only charged once per notice, no matter how many rows it produces.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 5 } } }, "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 } } } } } } } } } }