{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Scraper — Filings, Full-Text Search & Financials", "description": "SEC EDGAR scraper: list 10-K, 10-Q, 8-K, S-1, 20-F and other filings by ticker or CIK, run full-text search across all filings, and pull XBRL financials (revenue, net income, assets). Official data, no API key. From US$1.00 per 1,000 filings.", "version": "0.1", "x-build-id": "RfZdRhjWTe74FrKpN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fabrikit~sec-edgar-filings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fabrikit-sec-edgar-filings-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/fabrikit~sec-edgar-filings-scraper/runs": { "post": { "operationId": "runs-sync-fabrikit-sec-edgar-filings-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/fabrikit~sec-edgar-filings-scraper/run-sync": { "post": { "operationId": "run-sync-fabrikit-sec-edgar-filings-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": { "mode": { "title": "Mode", "enum": [ "filings", "search", "financials" ], "type": "string", "description": "filings = list filings of companies; search = full-text search across all filings; financials = XBRL financial facts (revenue, net income, assets...).", "default": "filings" }, "companies": { "title": "Companies (filings & financials modes)", "type": "array", "description": "Tickers (AAPL), CIK numbers (320193) or company names (Microsoft). Non-listed filers: use the CIK.", "default": [ "AAPL", "MSFT" ], "items": { "type": "string" } }, "formTypes": { "title": "Form types (filings mode)", "type": "array", "description": "Company forms to keep, e.g. 10-K, 10-Q, 8-K, S-1, 20-F, DEF 14A, 13F-HR, 424B5. Leave empty for all company forms. Insider forms (3, 4, 5, 144, Schedule 13D/G) are never returned.", "default": [ "10-K", "10-Q", "8-K" ], "items": { "type": "string" } }, "includeAmendments": { "title": "Include amendments (/A)", "type": "boolean", "description": "Also return amended versions such as 10-K/A when their base form is selected.", "default": false }, "startDate": { "title": "From date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Filing date, YYYY-MM-DD (filings and search modes)." }, "endDate": { "title": "To date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Filing date, YYYY-MM-DD (filings and search modes)." }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Newest first. Applies to filings mode.", "default": 25 }, "searchQuery": { "title": "Search query (search mode)", "type": "string", "description": "Full-text search over the text of all filings since 2001. Use quotes for exact phrases, e.g. \"going concern\" OR \"supply chain\"." }, "searchForms": { "title": "Form types filter (search mode)", "type": "array", "description": "Only search inside these forms, e.g. 10-K, 8-K. Empty = all company forms.", "items": { "type": "string" } }, "searchCompanies": { "title": "Limit search to companies", "type": "array", "description": "Optional tickers / CIKs / names to restrict full-text search.", "items": { "type": "string" } }, "concepts": { "title": "XBRL concepts (financials mode)", "type": "array", "description": "US-GAAP / IFRS / dei tag names, e.g. Revenues, RevenueFromContractWithCustomerExcludingAssessedTax, NetIncomeLoss, Assets, Liabilities, StockholdersEquity, OperatingIncomeLoss, EarningsPerShareDiluted, CashAndCashEquivalentsAtCarryingValue, EntityCommonStockSharesOutstanding.", "default": [ "Revenues", "RevenueFromContractWithCustomerExcludingAssessedTax", "NetIncomeLoss", "Assets", "Liabilities", "StockholdersEquity" ], "items": { "type": "string" } }, "periods": { "title": "Periods (financials mode)", "enum": [ "annual", "quarterly", "all" ], "type": "string", "description": "annual = full fiscal years (10-K/20-F/40-F); quarterly = interim periods; all = everything reported.", "default": "annual" }, "fromFiscalYear": { "title": "From fiscal year", "minimum": 1990, "maximum": 2100, "type": "integer", "description": "Financials mode, e.g. 2020." }, "toFiscalYear": { "title": "To fiscal year", "minimum": 1990, "maximum": 2100, "type": "integer", "description": "Financials mode." }, "latestValueOnly": { "title": "Latest reported value only", "type": "boolean", "description": "Keep one row per concept and period (the most recently filed, i.e. restated, value). Turn off to get every filing's value.", "default": true }, "frame": { "title": "Frame (cross-company snapshot)", "type": "string", "description": "Financials mode: instead of companies, get one concept for ALL filers in a period, e.g. CY2023 (annual), CY2023Q4I (balance-sheet date), CY2023Q4. Largest values first." }, "frameConcept": { "title": "Frame concept", "type": "string", "description": "Concept used with a frame, e.g. Assets, Revenues, NetIncomeLoss.", "default": "Assets" }, "frameUnit": { "title": "Frame unit", "type": "string", "description": "USD, shares, USD-per-shares, pure...", "default": "USD" }, "maxItems": { "title": "Max records", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Total records saved (each is charged). Default run is 50.", "default": 50 }, "userAgent": { "title": "User-Agent (with your contact e-mail)", "type": "string", "description": "The SEC asks automated clients to identify themselves, ideally with a contact e-mail. Requests without an e-mail-like contact are rejected.", "default": "Fabrikit SEC actor (apify.com/fabrikit) flippystudios1990@gmail.com" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The SEC API is open and rate-limited to 10 requests/second per IP; the Actor paces itself at 8/s. Proxy is only used as a fallback if the SEC throttles the IP.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }