{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Filings Monitor (8-K, 10-K, 10-Q, Form 4)", "description": "Track SEC EDGAR filings (8-K, 10-K, 10-Q, Form 4, 13D/G and more) for any tickers or CIKs from the official SEC API. Monitor mode delivers only new filings, so scheduled runs cost almost nothing when nothing new is filed.", "version": "0.1", "x-build-id": "zjVy4jmrYocF3Q25b" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/unrealevents22~sec-edgar-filings-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-unrealevents22-sec-edgar-filings-monitor", "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/unrealevents22~sec-edgar-filings-monitor/runs": { "post": { "operationId": "runs-sync-unrealevents22-sec-edgar-filings-monitor", "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/unrealevents22~sec-edgar-filings-monitor/run-sync": { "post": { "operationId": "run-sync-unrealevents22-sec-edgar-filings-monitor", "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": [ "companies" ], "properties": { "companies": { "title": "Companies (tickers or CIKs)", "type": "array", "description": "Tickers (AAPL, BRK.B) or SEC CIK numbers (320193 or 0000320193). Tickers are resolved with SEC's company_tickers.json.", "items": { "type": "string" } }, "forms": { "title": "Form types", "type": "array", "description": "e.g. 8-K, 10-K, 10-Q, 4, S-1, SC 13D, SC 13G, DEF 14A. Default: 8-K, 10-K, 10-Q. Form 4 (insider trades, very high volume) is not included by default; add '4' to get it. An empty list means all forms. A base form also matches its amendments (8-K matches 8-K/A) unless you turn off 'Include amendments'. Write 8-K/A to get only amendments. SC 13D / SC 13G also match the newer SCHEDULE 13D / SCHEDULE 13G names.", "default": [ "8-K", "10-K", "10-Q" ], "items": { "type": "string" } }, "includeAmendments": { "title": "Include amendments (/A)", "type": "boolean", "description": "When a base form like 8-K is listed, also return its amendments (8-K/A).", "default": true }, "items8K": { "title": "8-K items (optional)", "type": "array", "description": "Keep only 8-Ks reporting at least one of these items, e.g. 2.02 (results), 5.02 (officer/director changes), 1.05 (cybersecurity incident), 1.01 (material agreement). Other forms are not affected.", "items": { "type": "string" } }, "dateFrom": { "title": "Filed on or after", "type": "string", "description": "YYYY-MM-DD, or relative: 30d, 12w, 1y. Older filing pages are fetched only when needed." }, "dateTo": { "title": "Filed on or before", "type": "string", "description": "YYYY-MM-DD or relative (30d, 12w, 1y)." }, "onlyNewSinceLastRun": { "title": "Monitor mode: only filings not delivered before", "type": "boolean", "description": "Each run delivers only matching filings this monitor hasn't delivered before (changeType = 'new'). Schedule it (e.g. every 15 minutes). State lives in the named key-value store 'sec-edgar-filings-monitor-state'.", "default": false }, "stateKey": { "title": "Monitor name (state key)", "type": "string", "description": "Use a different name per schedule/watchlist. Letters, digits, '-' and '_'.", "default": "default" }, "skipExistingOnFirstRun": { "title": "Start silently (skip existing filings on the first run)", "type": "boolean", "description": "Monitor mode only. The first run records existing filings without delivering (or charging for) them; later runs deliver only new ones.", "default": false }, "maxItemsPerCompany": { "title": "Max filings per company", "minimum": 1, "type": "integer", "description": "Newest N matching filings per company per run.", "default": 100 }, "maxItems": { "title": "Max filings per run", "minimum": 1, "type": "integer", "description": "Hard cap on results in this run (one result = one filing = one dataset row). Leave empty for no cap beyond your spending limit." }, "userAgent": { "title": "SEC User-Agent (optional)", "type": "string", "description": "SEC asks automated tools to identify themselves with a name and contact email, e.g. 'Your Name your@email.com'. Heavy users should supply their own. If empty, the Actor's default ('BrainBait unrealevents22@gmail.com') is used." } } }, "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 } } } } } } } } } }