{ "openapi": "3.0.1", "info": { "title": "SEC 8-K Event Signals: Cyber, Exec Changes, M&A", "description": "Real-time feed of material corporate events from SEC EDGAR Form 8-K item codes (1.05 cyber incident, 5.02 executive change, 1.01/2.01 M&A, 4.02 restatement, 1.03 bankruptcy...). Ticker mapping, industry/state filters, 'only new' monitoring, optional AI summary. Official EDGAR API, public domain.", "version": "0.1", "x-build-id": "QojunMPNYoA4zPJDg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tendoyo~sec-8k-event-signals/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tendoyo-sec-8k-event-signals", "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/tendoyo~sec-8k-event-signals/runs": { "post": { "operationId": "runs-sync-tendoyo-sec-8k-event-signals", "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/tendoyo~sec-8k-event-signals/run-sync": { "post": { "operationId": "run-sync-tendoyo-sec-8k-event-signals", "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": { "signals": { "title": "Signals", "type": "array", "description": "Event groups mapped to 8-K item codes, e.g. cyber (1.05), executiveChange (5.02), mna (1.01/2.01/5.01), restatement (4.02).", "items": { "type": "string", "enum": [ "cyberIncident", "executiveChange", "mergersAcquisitions", "restatement", "auditorChange", "bankruptcy", "delisting", "layoffsRestructuring", "impairment", "debtDefault", "earnings" ], "enumTitles": [ "Cyber incident (1.05)", "Executive / director change (5.02)", "M&A (1.01, 2.01, 5.01)", "Restatement (4.02)", "Auditor change (4.01)", "Bankruptcy (1.03)", "Delisting notice (3.01)", "Layoffs / restructuring (2.05)", "Impairment (2.06)", "Debt acceleration (2.04)", "Earnings (2.02)" ] } }, "items": { "title": "Extra raw 8-K item codes", "type": "array", "description": "e.g. 8.01, 7.01", "items": { "type": "string" } }, "query": { "title": "Full-text keyword / phrase", "type": "string", "description": "Optional, e.g. ransomware or \"artificial intelligence\"" }, "tickers": { "title": "Tickers or CIKs", "type": "array", "description": "Empty = all companies.", "items": { "type": "string" } }, "states": { "title": "Business location (US state codes)", "type": "array", "description": "e.g. CA, NY, TX", "items": { "type": "string" } }, "sicPrefixes": { "title": "SIC industry prefixes", "type": "array", "description": "e.g. 73 (software/IT services), 28 (pharma), 60 (banks)", "items": { "type": "string" } }, "daysBack": { "title": "Days back", "minimum": 0, "maximum": 3650, "type": "integer", "description": "How many days back to look, counting from today (UTC).", "default": 7 }, "filedSince": { "title": "Filed since (overrides days back)", "type": "string", "description": "ISO date (YYYY-MM-DD). Overrides \"Days back\"." }, "filedUntil": { "title": "Filed until", "type": "string", "description": "ISO date (YYYY-MM-DD). Defaults to today." }, "includeAmendments": { "title": "Include 8-K/A amendments", "type": "boolean", "description": "Also include 8-K/A amendment filings.", "default": false }, "maxItems": { "title": "Max filings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of filing signals to output (and charge for). Rare high-severity signals are filled first.", "default": 100 }, "maxScanDocuments": { "title": "Max documents to scan", "minimum": 100, "maximum": 50000, "type": "integer", "description": "EDGAR indexes every document of a filing (8-K body + exhibits). Item matching is done client-side over all 8-K documents in the date window, so wider windows need more scanning (~1,500 documents per week of filings, 100 per request).", "default": 5000 }, "onlyNew": { "title": "Only filings not delivered in previous runs", "type": "boolean", "description": "Skip items already delivered by previous runs of this Actor (state kept in a named key-value store). Ideal for daily schedules.", "default": false }, "includeDocumentText": { "title": "Include text excerpt of the 8-K", "type": "boolean", "description": "Add a ~4,000-character excerpt of the 8-K starting at the first \"Item x.xx\".", "default": false }, "llmEnrichment": { "title": "AI summary per filing (bring your own key)", "type": "boolean", "description": "Optional AI summary per filing (headline, key facts, impact, sales trigger). Requires your own OpenAI-compatible key.", "default": false }, "llmApiKey": { "title": "OpenAI-compatible API key", "type": "string", "description": "Your API key for any OpenAI-compatible endpoint. Stored encrypted; only used when the AI option is on." }, "llmBaseUrl": { "title": "API base URL", "type": "string", "description": "Base URL of an OpenAI-compatible API, e.g. https://api.openai.com/v1." }, "llmModel": { "title": "Model", "type": "string", "description": "Model name passed to the OpenAI-compatible endpoint." }, "contactEmail": { "title": "Contact e-mail for SEC User-Agent", "type": "string", "description": "SEC asks automated clients to identify themselves." } } }, "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 } } } } } } } } } }