{ "openapi": "3.0.1", "info": { "title": "SEC Filings & Insider Signals: 8-K, Form 4 & 10-Q API", "description": "One evidence-linked report per company from official SEC EDGAR data: 8-K events in plain English, Form 4 insider buys/sells, 10-Q/10-K revenue, margins, dilution and debt, buyback/guidance hits and a transparent score. $2 per 1,000 reports.", "version": "0.0", "x-build-id": "oKowYhWBk4oHf3pnu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dodiabak~sec-filings-insider-signals/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dodiabak-sec-filings-insider-signals", "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/dodiabak~sec-filings-insider-signals/runs": { "post": { "operationId": "runs-sync-dodiabak-sec-filings-insider-signals", "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/dodiabak~sec-filings-insider-signals/run-sync": { "post": { "operationId": "run-sync-dodiabak-sec-filings-insider-signals", "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 (tickers or CIKs)", "type": "array", "description": "Stock tickers (AAPL, BRK.B) or SEC CIK numbers (320193, CIK0000320193). One report per company. Leave empty if you use a scan mode.", "items": { "type": "string" } }, "scanMode": { "title": "Scan mode (find companies for you)", "enum": [ "none", "insider-buys", "buybacks", "guidance-raised", "full-text" ], "type": "string", "description": "Discover companies from recent filings with SEC full-text search, then build a full report for each (up to \"Max companies\").", "default": "none" }, "fullTextQuery": { "title": "Full-text query (scan mode \"Custom\")", "type": "string", "description": "SEC EDGAR full-text search syntax. Use quotes for phrases and OR between alternatives, e.g. \"strategic alternatives\" OR \"going private\"." }, "fullTextForms": { "title": "Forms for the custom scan", "type": "string", "description": "Comma-separated SEC form types, e.g. 8-K or 8-K,10-Q.", "default": "8-K" }, "scanDays": { "title": "Scan window (days)", "minimum": 1, "maximum": 30, "type": "integer", "description": "How far back the scan looks.", "default": 3 }, "maxScanFilings": { "title": "Max filings checked by the scan", "minimum": 10, "maximum": 2000, "type": "integer", "description": "Upper limit on filings read during discovery (insider-buys reads each Form 4 XML).", "default": 300 }, "maxCompanies": { "title": "Max companies (scan results)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of company reports to build from scan results. Each report is one charged event.", "default": 25 }, "lookbackDays": { "title": "Lookback for 8-K and Form 4 (days)", "minimum": 7, "maximum": 365, "type": "integer", "description": "8-K events and insider trades filed in this window are included.", "default": 90 }, "maxEightKsPerCompany": { "title": "Max 8-Ks per company", "minimum": 0, "maximum": 50, "type": "integer", "description": "Newest 8-K/8-K/A filings to label and scan.", "default": 8 }, "maxForm4PerCompany": { "title": "Max Form 4 filings per company", "minimum": 0, "maximum": 200, "type": "integer", "description": "Newest Form 4/4-A XML files to parse. Large caps file many; raise it for a full picture.", "default": 40 }, "scan8KText": { "title": "Scan 8-K text for buyback / guidance / dilution keywords", "type": "boolean", "description": "Reads the 8-K document and up to 2 EX-99 press releases for items 2.02, 7.01, 8.01, 1.01, 2.05, 3.02.", "default": true }, "includeFinancials": { "title": "Include 10-Q / 10-K key facts", "type": "boolean", "description": "Revenue, gross/operating/net margin, EPS, diluted shares, cash flow, buybacks, cash, debt and shares outstanding with QoQ and YoY changes, from XBRL company facts.", "default": true }, "quartersOfHistory": { "title": "Quarters of history per metric", "minimum": 2, "maximum": 20, "type": "integer", "description": "Length of each metric's history array.", "default": 8 }, "maxTransactionsInOutput": { "title": "Max insider transactions listed", "minimum": 0, "maximum": 500, "type": "integer", "description": "Open-market buys first, then sales, then other codes. The summary always counts all parsed transactions.", "default": 50 }, "outputDetail": { "title": "Output detail", "enum": [ "full", "compact" ], "type": "string", "description": "Compact drops history arrays and footnotes and keeps the top 10 insider transactions. Same price.", "default": "full" }, "includeErrorRows": { "title": "Add free error rows", "type": "boolean", "description": "Unknown tickers and failed lookups get a free row with an error code.", "default": true }, "contactEmail": { "title": "Contact email for the SEC User-Agent (optional)", "type": "string", "description": "SEC asks automated tools to identify themselves. Your email is used if valid; otherwise the Actor developer's contact is sent." }, "maxRequestsPerSecond": { "title": "Max SEC requests per second", "minimum": 1, "maximum": 9, "type": "integer", "description": "Shared across the whole run. SEC fair-access limit is 10/s; the Actor never exceeds 9.", "default": 5 }, "concurrency": { "title": "Companies in parallel", "minimum": 1, "maximum": 6, "type": "integer", "description": "The global rate limit still applies.", "default": 3 } } }, "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 } } } } } } } } } }