{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Scraper: 8-K, 10-K, Form 4 Filings", "description": "SEC EDGAR scraper for 8-K, 10-K, 10-Q and Form 4 filings by ticker, CIK or name. Each run returns only new filings (8-K items decoded), insider trades and XBRL financials (revenue, net income, EPS). Official SEC data, no API key.", "version": "0.6", "x-build-id": "KNX59TB86ylHefctX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/heaped_qualm~sec-edgar-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-heaped_qualm-sec-edgar-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/heaped_qualm~sec-edgar-monitor/runs": { "post": { "operationId": "runs-sync-heaped_qualm-sec-edgar-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/heaped_qualm~sec-edgar-monitor/run-sync": { "post": { "operationId": "run-sync-heaped_qualm-sec-edgar-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 (tickers, CIKs or names)", "type": "array", "description": "One per line: ticker (AAPL, BRK.B), numeric CIK (320193) or part of the company name (\"tesla\"). Names are matched against SEC's official company_tickers.json; the first, largest match wins, so prefer tickers or CIKs.", "default": [ "AAPL", "MSFT", "NVDA" ], "items": { "type": "string" } }, "formTypes": { "title": "Form types", "type": "array", "description": "Pick the forms to watch. Empty = all forms. Amendments (/A) are included unless switched off below.", "items": { "type": "string", "enum": [ "8-K", "10-K", "10-Q", "4", "3", "5", "S-1", "S-3", "S-4", "424B4", "SC 13D", "SC 13G", "13F-HR", "DEF 14A", "6-K", "20-F", "40-F", "11-K", "144", "D", "SD", "CORRESP" ] }, "default": [ "8-K", "10-K", "10-Q" ] }, "customFormTypes": { "title": "Other form types", "type": "array", "description": "Any form code not in the list above, e.g. N-PORT, 425, ARS.", "items": { "type": "string" } }, "eightKItems": { "title": "8-K item filter", "type": "array", "description": "Keep only 8-Ks that report at least one of these item codes, e.g. 2.02 (earnings), 5.02 (director or officer change), 1.01 (material agreement), 1.05 (cybersecurity incident). Format: digit, dot, two digits. Empty = all 8-Ks.", "items": { "type": "string" } }, "includeAmendments": { "title": "Include amendments (/A)", "type": "boolean", "description": "Also match 10-K/A, 8-K/A etc. when 10-K / 8-K is selected.", "default": true }, "lastDays": { "title": "Look back (days)", "minimum": 0, "maximum": 36500, "type": "integer", "description": "Only filings from the last N days. Ignored when 'Filed since' is set. 0 = no limit.", "default": 90 }, "filedSince": { "title": "Filed since", "type": "string", "description": "Earliest filing date (YYYY-MM-DD). When set, it replaces \"Look back (days)\"." }, "filedUntil": { "title": "Filed until", "type": "string", "description": "Latest filing date (YYYY-MM-DD). Leave empty for no upper limit." }, "includeFinancials": { "title": "Include key financials (XBRL)", "type": "boolean", "description": "Adds a \"financials\" row per company for the latest periodic report (10-K, 10-Q, 20-F, 40-F) from SEC's XBRL companyfacts API: revenue, gross profit, operating and net income, EPS (basic and diluted), operating cash flow, assets, liabilities, equity, cash, long-term debt and shares outstanding, with fiscal year, period and period dates. In monitor mode a row appears only when a new report is filed.", "default": true }, "financialPeriods": { "title": "Financial periods per company", "minimum": 1, "maximum": 12, "type": "integer", "description": "How many of the latest periodic reports (10-K/10-Q/20-F) to return figures for. 1 = latest only.", "default": 1 }, "includeInsiderTrades": { "title": "Include insider trades (Form 4)", "type": "boolean", "description": "Parses Form 4 XML filed in the look-back window into one row per transaction: insider name, role/title, transaction code (P buy, S sell, A grant, M exercise, F tax …), shares, price, value, shares owned after, direct/indirect, 10b5-1 plan flag. Monitor mode only parses Form 4s not seen before.", "default": true }, "maxInsiderFilingsPerCompany": { "title": "Max Form 4 filings per company", "minimum": 1, "maximum": 200, "type": "integer", "description": "Newest Form 4 filings to parse per company per run. Each one is one extra SEC request; the Actor stays at or below 5 requests per second.", "default": 10 }, "onlyNew": { "title": "Only new filings since last run", "type": "boolean", "description": "Monitor mode: return only filings, reports and Form 4s not seen before under the same monitor name. The first run returns everything in range as BASELINE. Switch off to return every match (already seen ones are marked SEEN). It starts switched off in the form, so a manual test run always shows results. Switch it on in the task you schedule. API calls that omit this field get monitor mode on.", "default": true }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Cap per company per run (newest first). Older history pages are fetched automatically when needed.", "default": 20 }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Name of this monitor's memory (letters, digits and dashes; other characters become dashes). Use a different name for each watchlist or schedule.", "default": "default" }, "contactEmail": { "title": "Your contact email (recommended)", "type": "string", "description": "Added to the User-Agent header, because SEC's fair-access policy asks automated tools to identify themselves. It is sent only to sec.gov and is not saved in the output." } } }, "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 } } } } } } } } } }