{ "openapi": "3.0.1", "info": { "title": "SEC Form 8-K Material Event Scraper: Cyber, Bankruptcy, Exec", "description": "Material corporate events from official SEC EDGAR Form 8-K filings via the EDGAR daily index: cybersecurity incidents (1.05), bankruptcy (1.03), impairments (2.06), accountant changes (4.01) and executive changes (5.02), with cleaned item text. Filter by item code, date, ticker or CIK, and keyword.", "version": "0.1", "x-build-id": "gDHeREVkXNtpiXhdw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/groundplanes~sec-edgar-8k-material-event-radar/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-groundplanes-sec-edgar-8k-material-event-radar", "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/groundplanes~sec-edgar-8k-material-event-radar/runs": { "post": { "operationId": "runs-sync-groundplanes-sec-edgar-8k-material-event-radar", "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/groundplanes~sec-edgar-8k-material-event-radar/run-sync": { "post": { "operationId": "run-sync-groundplanes-sec-edgar-8k-material-event-radar", "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": [ "customSecUserAgent" ], "properties": { "customSecUserAgent": { "title": "SEC User-Agent (required)", "type": "string", "description": "Required by SEC fair-access rules: a truthful User-Agent naming the operator with a real contact email, in the format 'Sample Company AdminContact@example.com'. Replace that sample with your own company name and real contact email before running: placeholder domains (example, sample, or yourdomain in any form, at any TLD) are rejected. A run without it fails before any request is made." }, "dateFrom": { "title": "Date From (YYYY-MM-DD)", "type": "string", "description": "Earliest filing date in YYYY-MM-DD format. Leave empty for the run date minus 7 days." }, "dateTo": { "title": "Date To (YYYY-MM-DD)", "type": "string", "description": "Latest filing date in YYYY-MM-DD format. Leave empty for the run date." }, "extractCleanEventText": { "title": "Extract Clean Event Text", "type": "boolean", "description": "When true, the triggered item sections are sliced and cleaned from the primary filing document and shipped as extractedItemText. When a section cannot be isolated, the full cleaned body is returned capped at 15,000 characters and flagged as unsliced.", "default": true }, "itemCodesFilter": { "title": "Item Codes Filter", "type": "array", "description": "Form 8-K item codes to keep (e.g. 1.05 material cybersecurity incidents, 1.03 bankruptcy, 2.06 material impairments, 4.01 accountant change, 5.02 officer or director change). Empty keeps all items.", "items": { "type": "string" }, "default": [ "1.05", "1.03", "2.06", "4.01", "5.02" ] }, "keywordInFilingText": { "title": "Keyword in Filing Text (optional)", "type": "string", "description": "Optional case-insensitive keyword that must appear in the full filing text.", "default": "" }, "maxItems": { "title": "Maximum Items", "minimum": 1, "type": "integer", "description": "Maximum number of filing records to return. When the cap truncates the matched set, the run ends PARTIAL stating the matched and delivered counts.", "default": 200 }, "tickersOrCiks": { "title": "Tickers or CIKs (optional)", "type": "array", "description": "Optional ticker symbols (e.g. AAPL) or CIKs. When non-empty, discovery switches to the per-CIK submissions path for those filers only. Empty scans the whole market through the daily index.", "items": { "type": "string" }, "default": [] } } }, "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 } } } } } } } } } }