{ "openapi": "3.0.1", "info": { "title": "EDGAR Intelligence — SEC Filings, AI Forecasts & Analysis", "description": "Monitor 30+ SEC filing types, forecast revenue with AI, and get plain-English analysis of material events. Built for VC, PE, hedge funds, corp dev, and family offices.", "version": "2.0", "x-build-id": "O6enhGAVQ0wCJHa69" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datasiphon~sec-edgar-poller/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datasiphon-sec-edgar-poller", "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/datasiphon~sec-edgar-poller/runs": { "post": { "operationId": "runs-sync-datasiphon-sec-edgar-poller", "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/datasiphon~sec-edgar-poller/run-sync": { "post": { "operationId": "run-sync-datasiphon-sec-edgar-poller", "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": [ "edgarIdentity" ], "properties": { "edgarIdentity": { "title": "SEC EDGAR Identity (REQUIRED)", "type": "string", "description": "Your name and email for SEC EDGAR compliance. Format: 'Your Name / your.email@domain.com'. Required by SEC policy — the Actor will not start without this." }, "mode": { "title": "Mode", "enum": [ "latest_feed", "company_search", "form_specific", "full_text_search" ], "type": "string", "description": "What to fetch. 'latest_feed' polls SEC for recent filings (default). 'company_search' fetches filings for specified companies (tickers/CIKs/name). 'form_specific' focuses on one form type. 'full_text_search' queries EDGAR's full-text index by keyword.", "default": "latest_feed" }, "formTypes": { "title": "Form Types (multi-select)", "type": "array", "description": "SEC form types to poll or search. Used in latest_feed and company_search modes.", "items": { "type": "string", "enum": [ "D", "D/A", "8-K", "8-K/A", "4", "4/A", "3", "3/A", "5", "5/A", "13F-HR", "13F-HR/A", "N-PORT", "N-PORT/A", "S-1", "S-1/A", "S-4", "S-4/A", "SC 13D", "SC 13D/A", "SC 13G", "SC 13G/A", "10-K", "10-K/A", "10-Q", "10-Q/A", "DEF 14A", "20-F", "20-F/A", "6-K" ] }, "default": [ "D", "8-K" ] }, "formType": { "title": "Form Type (single)", "enum": [ "4", "3", "5", "8-K", "13F-HR", "N-PORT", "D", "S-1", "S-4", "SC 13D", "SC 13G", "10-K", "10-Q", "DEF 14A", "20-F", "6-K" ], "type": "string", "description": "Single form type for form_specific mode.", "default": "4" }, "searchType": { "title": "Search By", "enum": [ "ticker", "cik", "companyName" ], "type": "string", "description": "How to identify companies in company_search mode.", "default": "ticker" }, "tickers": { "title": "Ticker Symbols", "type": "array", "description": "Stock ticker symbols for company_search mode (e.g., AAPL, MSFT, TSLA).", "items": { "type": "string" }, "default": [] }, "ciks": { "title": "CIK Numbers", "type": "array", "description": "SEC Central Index Key numbers (10-digit). Used in company_search mode.", "items": { "type": "string" }, "default": [] }, "companyName": { "title": "Company Name Search", "type": "string", "description": "Search by company name (partial match). Used in company_search mode.", "default": "" }, "searchQuery": { "title": "Full-Text Search Query", "type": "string", "description": "Keyword or phrase for full_text_search mode. Supports AND/OR/NOT and quotes.", "default": "" }, "datePreset": { "title": "Date Preset", "enum": [ "", "last7Days", "last30Days", "last90Days", "lastQuarter", "lastYear", "yearToDate" ], "type": "string", "description": "Quick date range selector. Overrides dateFrom/dateTo.", "default": "" }, "dateFrom": { "title": "Date From", "type": "string", "description": "Start date. Overridden by datePreset.", "default": "" }, "dateTo": { "title": "Date To", "type": "string", "description": "End date. Overridden by datePreset.", "default": "" }, "maxFilings": { "title": "Max Filings", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum number of filings to return. In company_search mode, this is per-company. Max 1000.", "default": 100 }, "includeFilingText": { "title": "Include Filing Text", "type": "boolean", "description": "Fetch and include the cleaned text of each filing.", "default": true }, "maxTextLength": { "title": "Max Text Length (chars)", "minimum": 1000, "maximum": 100000, "type": "integer", "description": "Maximum characters of filing text per record.", "default": 8000 }, "includeStructuredData": { "title": "Include Structured Data", "type": "boolean", "description": "Parse structured data via edgartools (typed objects per form type).", "default": true }, "outputFormat": { "title": "Output Format", "enum": [ "json", "csv", "xlsx" ], "type": "string", "description": "Preferred output format.", "default": "json" }, "incrementalMode": { "title": "Incremental Mode", "type": "boolean", "description": "Only return filings newer than the last run. Uses Apify KV Store.", "default": false }, "delaySeconds": { "title": "Delay Between Requests (seconds)", "minimum": 0.1, "maximum": 10, "type": "number", "description": "Seconds to wait between filing fetches. SEC recommends 1 req/100ms.", "default": 1 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. SEC EDGAR does not require proxies.", "default": { "useApifyProxy": false } }, "enablePredictiveForecast": { "title": "Enable Predictive Forecast (TimesFM)", "type": "boolean", "description": "[v2.0] Run Google TimesFM AI on 10-K/10-Q financial data to predict next 4 quarters of revenue. Requires timesfm[torch] to be installed (see README). Can use significant memory (~2 GB).", "default": false }, "forecastHorizon": { "title": "Forecast Horizon (quarters)", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of future quarters to forecast. TimesFM supports up to 256 periods, but 4 is standard for next-year outlook.", "default": 4 }, "groqApiKey": { "title": "Groq API Key (for semantic analysis)", "type": "string", "description": "[v2.0] Groq API key for AI-powered narrative analysis of filings (8-K summaries, Form D round classification, forecast commentary). Sourced from Apify Secrets if not provided here." }, "enableSemanticAnalysis": { "title": "Enable Semantic Analysis (Groq)", "type": "boolean", "description": "[v2.0] Generate narrative intelligence for filings using Groq Llama-3. Requires groqApiKey. Produces filing summaries, material impact assessments, and forecast commentary.", "default": false } } }, "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 } } } } } } } } } }