{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Filings Scraper: 10-K, 10-Q, 8-K, XBRL", "description": "SEC EDGAR API and 10-K scraper: get 10-K, 10-Q, 8-K and other filings by ticker or CIK from official SEC APIs, with document links, key XBRL financials, optional Risk Factors and MD&A text, and EDGAR full-text search.", "version": "0.1", "x-build-id": "hYfmXrKibCtSWaE6I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/smartmoney-data~sec-edgar-filings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-smartmoney-data-sec-edgar-filings", "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/smartmoney-data~sec-edgar-filings/runs": { "post": { "operationId": "runs-sync-smartmoney-data-sec-edgar-filings", "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/smartmoney-data~sec-edgar-filings/run-sync": { "post": { "operationId": "run-sync-smartmoney-data-sec-edgar-filings", "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": [ "userAgentContact" ], "properties": { "tickersOrCiks": { "title": "Tickers or CIKs", "type": "array", "description": "Company tickers (AAPL, BRK-B) and/or SEC CIKs, with or without leading zeros. Required unless you set a full-text search. The sample is two large filers so the first run stays small.", "items": { "type": "string" } }, "formTypes": { "title": "Form types", "type": "array", "description": "Forms to include, for example 10-K, 10-Q, 8-K, 4, 13F-HR, S-1, DEF 14A. Amendments match the root: 10-K also returns 10-K/A. Leave empty for all forms.", "items": { "type": "string" } }, "dateFrom": { "title": "Filed date from (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive lower bound on filing date. Leave empty for the recent list." }, "dateTo": { "title": "Filed date to (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive upper bound on filing date." }, "maxFilings": { "title": "Max filings (whole run)", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum rows for the whole run in filings mode, including full-text hits. In financialsTimeSeries mode this is the per-company fact limit when Max filings per company is empty.", "default": 25 }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap per ticker or CIK so one company does not use the whole run. In financialsTimeSeries mode: fact rows per company. The sample is 2 so the first run is a few filings." }, "mode": { "title": "Mode", "enum": [ "filings", "financialsTimeSeries" ], "type": "string", "description": "filings = one row per SEC filing. financialsTimeSeries = revenue, net income, EPS, and assets over time from company facts.", "default": "filings" }, "includeXbrlFinancials": { "title": "Include key XBRL financials", "type": "boolean", "description": "Attach revenue, net income, diluted EPS, and total assets from SEC company facts, matched to the accession number when possible. Not charged extra.", "default": true }, "extractSections": { "title": "Extract 10-K / 10-Q sections", "type": "boolean", "description": "Download the primary 10-K or 10-Q and extract Item 1A (Risk Factors), Item 7 (MD&A), and Item 8. Best effort, slower, not charged extra. Leave off for the first run.", "default": false }, "sectionMaxChars": { "title": "Max characters per section", "minimum": 1000, "maximum": 200000, "type": "integer", "description": "Truncate extracted section text to this many characters.", "default": 20000 }, "fullTextQuery": { "title": "Full-text search query (optional)", "type": "string", "description": "Optional EDGAR full-text phrase, for example \"supply chain disruption\". Up to 100 matching filings as fulltext_hit rows. Can be combined with tickers." }, "userAgentContact": { "title": "Your contact email (required by the SEC)", "type": "string", "description": "The SEC requires a real contact in the User-Agent. Replace the placeholder with your own email (you@yourcompany.com) or a URL where you can be reached. It is sent only to the SEC. A placeholder may be blocked." }, "maxRequestsPerSecond": { "title": "Max requests / second", "minimum": 0.5, "maximum": 8, "type": "number", "description": "Rate toward SEC servers. Capped at 8 (the SEC fair-access limit is 10).", "default": 8 } } }, "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 } } } } } } } } } }