{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Scraper: Filings, Form 4, 13F, XBRL", "description": "SEC EDGAR scraper for structured filings: 10-K/10-Q/8-K sections as Markdown, parsed Form 4 insider trades, 13F holdings, Form D and XBRL financials as clean rows. Watchlist monitor with Slack alerts. Official endpoints, pay per filing from $0.001.", "version": "0.1", "x-build-id": "RZq14rFGvWAHNuScr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tiger19935~sec-edgar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tiger19935-sec-edgar-scraper", "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/tiger19935~sec-edgar-scraper/runs": { "post": { "operationId": "runs-sync-tiger19935-sec-edgar-scraper", "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/tiger19935~sec-edgar-scraper/run-sync": { "post": { "operationId": "run-sync-tiger19935-sec-edgar-scraper", "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": { "contactEmail": { "title": "Contact email (required by SEC)", "type": "string", "description": "SEC requires every automated client to declare a contact in the User-Agent header. Use your own email. The placeholder works but triggers a warning and may get throttled.", "default": "you@example.com" }, "mode": { "title": "What to pull", "enum": [ "filings", "parse", "markdown", "financials", "monitor", "search", "latest" ], "type": "string", "description": "filings = filing index rows; parse = parsed Form 4 / 13F-HR / Form D; markdown = 10-K/10-Q/8-K split by Item into Markdown; financials = XBRL statements; monitor = only filings new since the last run (+ optional webhook); search = EDGAR full-text search; latest = newest filings feed.", "default": "filings" }, "companies": { "title": "Tickers or CIKs", "type": "array", "description": "Tickers (AAPL, MSFT) or CIK numbers (320193). For 13F, pass the institution CIK (e.g. 1067983). Needed for every mode except search and latest.", "items": { "type": "string" } }, "formTypes": { "title": "Form types", "type": "array", "description": "Filter by form: 10-K, 10-Q, 8-K, 4, 13F-HR, D, S-1, DEF 14A... parse supports 4, 13F-HR, D; markdown supports 10-K, 10-Q, 8-K. In search mode leave empty for all forms.", "items": { "type": "string" } }, "includeAmendments": { "title": "Include amendments (/A)", "type": "boolean", "description": "Also return amended filings such as 10-K/A or 4/A.", "default": false }, "dateFrom": { "title": "Filed from (YYYY-MM-DD)", "type": "string", "description": "Only filings filed on or after this date. Leave empty for no lower bound." }, "dateTo": { "title": "Filed until (YYYY-MM-DD)", "type": "string", "description": "Only filings filed on or before this date. Leave empty for no upper bound." }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Newest first. Applies to filings, parse, markdown (monitor always checks the latest 100).", "default": 10 }, "maxItems": { "title": "Max results (total)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Hard cap on billed results for the whole run. 0 means no cap (the free plan is still capped at 25).", "default": 50 }, "searchQuery": { "title": "Full-text search query", "type": "string", "description": "Used by mode search. Supports EDGAR syntax, for example \"going concern\" or \"supply chain\" AND tariff. Covers filings from 2001 on." }, "sections": { "title": "Only these Items (markdown mode)", "type": "array", "description": "Item codes to keep, e.g. 1A (Risk Factors), 7 (MD&A), 2.02 for 8-K. Empty keeps all sections.", "items": { "type": "string" } }, "maxTokensPerSection": { "title": "Token budget per section", "minimum": 0, "maximum": 200000, "type": "integer", "description": "Truncate each Markdown section to about this many tokens (4 characters per token). 0 keeps full text. Useful for LLM context windows.", "default": 0 }, "includeFullMarkdown": { "title": "Also return one combined Markdown string", "type": "boolean", "description": "Adds a single markdown field with all kept sections joined, besides the sections array.", "default": false }, "flattenRows": { "title": "Flatten to one row per transaction / holding / fact", "type": "boolean", "description": "parse: one dataset row per Form 4 transaction or 13F holding. financials: one row per fact. Billing is unchanged (one event per filing or company).", "default": false }, "maxHoldingsPerFiling": { "title": "Max holdings per 13F", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Keep only the N largest holdings by value in each 13F-HR (0 = all). Totals still cover the full table.", "default": 0 }, "statements": { "title": "Financial statements", "type": "array", "description": "financials mode: income, balance, cashflow.", "items": { "type": "string", "enum": [ "income", "balance", "cashflow" ] }, "default": [ "income", "balance", "cashflow" ] }, "periods": { "title": "Periods", "enum": [ "annual", "quarterly", "both" ], "type": "string", "description": "financials mode: annual (10-K), quarterly (10-Q) or both.", "default": "both" }, "yearsBack": { "title": "Years of history", "minimum": 1, "maximum": 40, "type": "integer", "description": "financials mode: how many fiscal years back to include.", "default": 5 }, "deriveQ4": { "title": "Derive Q4 (flow items)", "type": "boolean", "description": "10-K files carry no stand-alone Q4. When on, Q4 = full year minus Q1 to Q3 (marked derived = true).", "default": true }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Namespace for saved state, so you can run several watchlists with different settings.", "default": "default" }, "stateStoreName": { "title": "State key-value store name", "type": "string", "description": "Named key-value store that remembers the filings already seen (persists between runs).", "default": "sec-edgar-monitor-state" }, "lookbackDaysFirstRun": { "title": "First-run lookback (days)", "minimum": 0, "maximum": 365, "type": "integer", "description": "monitor mode: on the first run for a company, report filings from the last N days (0 = just set the baseline, report nothing).", "default": 3 }, "webhookUrl": { "title": "Webhook URL (Slack or any HTTPS endpoint)", "type": "string", "description": "monitor mode: POST of {text, filings} when new filings are found. Works with Slack incoming webhooks. Not billed." }, "resetState": { "title": "Reset monitor state", "type": "boolean", "description": "Forget previously seen filings for this monitor name and start from a fresh baseline.", "default": false }, "maxRequestsPerSecond": { "title": "Max requests per second", "minimum": 1, "maximum": 8, "type": "integer", "description": "Request rate towards SEC. SEC allows 10 per second; the actor never exceeds 8.", "default": 8 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Off by default: SEC endpoints are public and need no proxy. Enable only if your IP range gets HTTP 403 or 429 from SEC.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }