{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Filings API — Real-Time 8-K/10-K Filing Monitor", "description": "Real-time SEC EDGAR filing alerts (8-K/10-K/10-Q/Form 4) via the official data.sec.gov API — a fraction of the cost of $300+/mo commercial SEC data feeds. No API key.", "version": "0.1", "x-build-id": "FPWW8SVFE9FnqQcIY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mooseandraven~sec-edgar-filing-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mooseandraven-sec-edgar-filing-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/mooseandraven~sec-edgar-filing-monitor/runs": { "post": { "operationId": "runs-sync-mooseandraven-sec-edgar-filing-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/mooseandraven~sec-edgar-filing-monitor/run-sync": { "post": { "operationId": "run-sync-mooseandraven-sec-edgar-filing-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", "properties": { "companies": { "title": "Companies to watch (ticker or CIK)", "type": "array", "description": "Ticker symbols (e.g. \"AAPL\") or numeric CIK identifiers (e.g. \"320193\" or \"0000320193\") to watch. Tickers are resolved via SEC's own official ticker-to-CIK mapping. A ticker/CIK that doesn't resolve is reported as an explicit 'company-not-found' record, never silently skipped. Leave empty if you only want to run a full-text search via fullTextSearchQuery below — at least one of companies or fullTextSearchQuery must be set.", "default": [ "AAPL" ], "items": { "type": "string" } }, "formTypes": { "title": "Filing types to watch", "type": "array", "description": "SEC form types to include (e.g. \"10-K\", \"10-Q\", \"8-K\", \"4\" for Form 4 insider transactions). Leave empty to include all filing types on record for each company.", "default": [ "10-K", "10-Q", "8-K", "4" ], "items": { "type": "string" } }, "monitorMode": { "title": "Incremental monitor mode", "type": "boolean", "description": "When on, the actor remembers which filings (by accession number) it has already delivered per company (Apify key-value store) and only reports genuinely NEW filings on later runs. Designed for scheduled runs watching for new filings/insider transactions. Charges one monitor-run PPE event in addition to per-filing events.", "default": false }, "fullTextSearchQuery": { "title": "Full-text search query (optional)", "type": "string", "description": "Optional keyword/phrase to search across EDGAR's full-text search index (all companies, not just the ones in `companies`). Runs once per invocation as a one-shot search — not deduplicated across monitor runs. Leave empty to skip full-text search entirely." }, "fullTextSearchForms": { "title": "Full-text search: restrict to these form types", "type": "array", "description": "Optional form-type filter applied only to the full-text search (has no effect if fullTextSearchQuery is empty). Leave empty to search across all form types.", "default": [], "items": { "type": "string" } }, "maxSearchResults": { "title": "Full-text search: max results to fetch", "minimum": 1, "type": "integer", "description": "A broad full-text search query can match thousands of filings (EDGAR's own result count, not guessed). This caps how many are actually fetched (paginated automatically). If the real total exceeds this cap, the actor emits an explicit 'search-truncated' record with the true total — a capped search is never reported as if it were exhaustive.", "default": 1000 } } }, "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 } } }, "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 } } } } } } } } } }