{ "openapi": "3.0.1", "info": { "title": "SEC 8-K Material Events — item codes, exhibits, severity", "description": "Pull every 8-K on EDGAR in your date window with the SEC's own item codes (2.02 earnings, 5.02 officer changes, 1.05 cyber, 4.02 restatement), typed exhibit links, event vs filed date, category, severity and tickers. No browser, no proxy, no paid data.", "version": "0.1", "x-build-id": "OjGUg6tVKgqgdAg0t" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/johnveds15~sec-8k-material-events/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-johnveds15-sec-8k-material-events", "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/johnveds15~sec-8k-material-events/runs": { "post": { "operationId": "runs-sync-johnveds15-sec-8k-material-events", "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/johnveds15~sec-8k-material-events/run-sync": { "post": { "operationId": "run-sync-johnveds15-sec-8k-material-events", "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": [ "secContactEmail" ], "properties": { "secContactEmail": { "title": "Your contact email (required by the SEC)", "type": "string", "description": "The SEC's fair-access policy requires every automated request to identify its sender. This address is placed in the User-Agent header and is sent ONLY to sec.gov — never stored, never shared. EDGAR returns 403 without it. Defaults to the Actor owner's address so the platform's automated daily test can run; replace it with your own when you run this yourself.", "default": "john.vedovinoii@gmail.com" }, "lookbackDays": { "title": "Lookback (days)", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many calendar days of EDGAR daily indices to sweep, counting back from End date. EDGAR publishes no index on weekends or federal holidays; those days are skipped. Default 5 guarantees at least one business day even across a long weekend.", "default": 5 }, "endDate": { "title": "End date (YYYY-MM-DD)", "type": "string", "description": "Last day of the window. Defaults to today." }, "tickers": { "title": "Only these tickers", "type": "array", "description": "Restrict to issuers whose ticker (per the SEC's company_tickers.json) is in this list. Empty = every filer.", "default": [], "items": { "type": "string" } }, "items": { "title": "Only these 8-K items", "type": "array", "description": "8-K item codes to keep, e.g. 2.02 (earnings), 5.02 (officer/director changes), 1.05 (cybersecurity incident), 4.02 (restatement), 1.01 (material agreement). Empty = all items.", "default": [], "items": { "type": "string" } }, "categories": { "title": "Only these categories", "type": "array", "description": "earnings · leadership · deal · distress · cyber · capital · governance · disclosure · other. Derived from the most severe item in the filing. Empty = all.", "default": [], "items": { "type": "string" } }, "minSeverity": { "title": "Minimum severity (0–5)", "minimum": 0, "maximum": 5, "type": "integer", "description": "5 = bankruptcy / restatement; 4 = cyber incident, default triggers, delisting notice, change of control; 3 = acquisitions, impairments, officer changes, auditor change; 2 = earnings, agreements, financing; 1 = governance and Reg FD; 0 = everything.", "default": 0 }, "includeAmendments": { "title": "Include 8-K/A amendments", "type": "boolean", "description": "Also return amended filings (form 8-K/A). Each record carries isAmendment so you can tell them apart.", "default": true }, "includeExhibits": { "title": "Include the exhibit inventory", "type": "boolean", "description": "Fetch each filing's index page to list its exhibits (type, description, URL) and the press-release link. One extra request per filing.", "default": true }, "maxFilings": { "title": "Maximum filings to parse", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on filings fetched this run (newest first). Bounds runtime and pay-per-event cost. Default 100 costs at most $0.20 (100 filings + 100 records at $0.001 each) and finishes in about a minute on the platform, well inside the 5-minute automated-test window. Raise it for a full business day (typically 150–400 8-Ks).", "default": 100 } } }, "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 } } } } } } } } } }