{ "openapi": "3.0.1", "info": { "title": "SEC 8-K Alerts: Executive Changes, M&A & Material Events", "description": "Get new SEC 8-K filings by item code for a list of tickers, an industry or all companies: executive changes (CFO and CEO appointments), material agreements, acquisitions (M&A), bankruptcy, cyber incidents, delisting. Alerts to Slack, Discord or Telegram. Export 8-K filings to Google Sheets or n8n.", "version": "1.0", "x-build-id": "oXKdOPkfo4nqphPIy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~sec-8k-event-alerts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-sec-8k-event-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~sec-8k-event-alerts/runs": { "post": { "operationId": "runs-sync-accountable_eel-sec-8k-event-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~sec-8k-event-alerts/run-sync": { "post": { "operationId": "run-sync-accountable_eel-sec-8k-event-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": { "itemCodes": { "title": "8-K item codes to alert on (optional)", "type": "array", "description": "Optional. 8-K item numbers, one per line, e.g. 5.02 for executive departures and appointments. Leave empty to get every 8-K filed in the date window. See the README for what each item means. Accepted formats: 5.02, 1.01, 2.01. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "sinceDays": { "title": "8-Ks filed in the last N days", "type": "integer", "description": "How far back to search, in days (up to 30). 2 covers the most recent filing days; on a Monday, use 4 to cover the weekend. The date window is a search bound; \"Stop after this many filings\" is what caps how many you get and pay for.", "default": 2 }, "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 filings", "type": "integer", "description": "Up to 1,000. The real cost control: each returned 8-K is billed. A run stops reading the index once this many filings match.", "default": 100 }, "excludeExhibitOnly": { "title": "Skip filings that only attach exhibits (9.01 alone)", "type": "boolean", "description": "Many 8-Ks report only Item 9.01 (financial statements and exhibits) and say nothing new about the company. On by default, those are dropped before you are billed.", "default": true }, "tickers": { "title": "Only these company tickers", "type": "array", "description": "Optional. Ticker symbols, e.g. AAPL. Matched against the ticker SEC shows on each filer's name. Leave empty to keep every company.", "items": { "type": "string" } }, "sicCodes": { "title": "Only these SIC industry codes", "type": "array", "description": "Optional. Four-digit SIC codes, e.g. 7372 (prepackaged software). Matched against the filer's SIC code. Leave empty to keep every industry.", "items": { "type": "string" } }, "states": { "title": "Only these US states (business location)", "type": "array", "description": "Optional. Two-letter US state codes (e.g. CA, NY, TX), matched against the company's business address. Leave empty to keep every state.", "items": { "type": "string" } }, "includeSummary": { "title": "Include an excerpt of the matched item", "type": "boolean", "description": "Off by default. On, the run also reads each returned 8-K's main document and adds the first ~600 characters under the matched item heading, so an alert can say what the company actually reported. Costs two extra SEC requests per filing, no extra charge.", "default": false }, "onlyNewSinceLastRun": { "title": "Only return filings that are new since the last run", "type": "boolean", "description": "Turns this into an alert: a filing counts as new when this watchlist has not returned it before. Filings already seen are dropped before you are billed, so a quiet run returns one summary row and costs only the start fee. A filing is forgotten 90 days after its filing date.", "default": false }, "deltaName": { "title": "Watchlist name (optional)", "type": "string", "description": "Leave empty to use the one shared watchlist for this account — changing your item codes or filters between runs still narrows the SAME watchlist. Type a name to keep two separate schedules (e.g. one for executive changes, one for bankruptcies) from marking each other's filings as seen.", "default": "" }, "notifyUrl": { "title": "Send alerts to (Discord or Slack webhook, Telegram bot link, or any URL)", "type": "string", "description": "Optional. After the filings are billed, each NEW 8-K is posted here as one message: company, ticker, the item(s) and what they mean, the filing date and a link to the SEC filing. 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. Pick one only to override that.", "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 filings are in the run's dataset, so a busy run never floods the channel. 0 sends only that one summary message.", "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": [ "filingCount", "companyName", "ticker", "cik", "filedAt", "matchedItems", "itemLabels", "items", "sic", "state", "accessionNumber", "filingUrl", "summary", "isAmendment", "isNew", "firstSeenAt", "notifyErrors" ], "enumTitles": [ "8-K filings returned", "Company", "Ticker", "SEC CIK", "Filed on", "8-K item(s) matched", "What the item means", "All items in the filing", "SIC industry code", "Business state", "Accession number", "SEC filing page", "Excerpt of the matched item", "Is this an amended 8-K (8-K/A)?", "Is this new since the last run?", "First seen by this watchlist", "Alert delivery problems" ] }, "default": [ "filingCount", "companyName", "ticker", "cik", "filedAt", "matchedItems", "itemLabels", "items", "sic", "state", "accessionNumber", "filingUrl", "summary", "isAmendment", "isNew", "firstSeenAt", "notifyErrors" ] }, "expandRows": { "title": "One row per filing (recommended) — turn off for one row per 8-K filing instead", "type": "boolean", "description": "When on, each filing found gets its own row instead of being grouped under its 8-K filing. You're still only charged once per 8-K filing, 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 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy config. Residential recommended for anti-bot-sensitive targets.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }