{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Filings & XBRL Financials Scraper", "description": "10-K, 10-Q, 8-K, DEF 14A and other SEC filings plus XBRL financials (revenue, net income, EPS, assets) from the official SEC EDGAR APIs. Tickers, CIKs or names; optional full-text search and document text. Rate-limited; failed companies never charged.", "version": "0.1", "x-build-id": "rW6KibP7OLjSQqjdY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/signalclear~sec-edgar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-signalclear-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/signalclear~sec-edgar-scraper/runs": { "post": { "operationId": "runs-sync-signalclear-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/signalclear~sec-edgar-scraper/run-sync": { "post": { "operationId": "run-sync-signalclear-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": { "companies": { "title": "Companies", "type": "array", "description": "One company per line: a ticker (AAPL, BRK.B), a CIK (320193 or 0000320193) or a company name (exact or a unique prefix, e.g. Microsoft). Filers without a ticker need their CIK. Leave empty to let the full-text query pick the companies.", "items": { "type": "string" } }, "forms": { "title": "Form types", "type": "array", "description": "SEC form types to return, e.g. 10-K, 10-Q, 8-K, DEF 14A, S-1, 13F-HR, 4, 20-F. Leave empty for every form type. Form 4 (insider transactions) names the reporting officers and directors.", "default": [ "10-K", "10-Q", "8-K" ], "items": { "type": "string" } }, "includeAmendments": { "title": "Include amendments", "type": "boolean", "description": "Also return amended filings (10-K/A, 8-K/A ...) for the chosen form types.", "default": true }, "filedSince": { "title": "Filed on or after", "type": "string", "description": "Only filings filed on or after this date (YYYY-MM-DD). Leave empty for no lower bound." }, "filedUntil": { "title": "Filed on or before", "type": "string", "description": "Only filings filed on or before this date (YYYY-MM-DD). Leave empty for no upper bound." }, "fullTextQuery": { "title": "Full-text search query", "type": "string", "description": "Optional EDGAR full-text search (filings since 2001). Use quotes for a phrase, e.g. \"artificial intelligence\". With companies, only their filings that match are returned; without companies, the matching filers become the companies. Each filing lists the documents that matched in fullTextHits." }, "maxFilingsPerCompany": { "title": "Maximum filings per company", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Newest filings first. Set 0 to return only XBRL facts rows.", "default": 50 }, "includeCompanyFacts": { "title": "Add an XBRL financials summary", "type": "boolean", "description": "Adds up to 4 facts rows per company, one per latest fiscal period (10-K/10-Q): revenue, net income, basic and diluted EPS, total assets, total liabilities and shares outstanding where the company reported them in XBRL. One extra request per company. Each facts row is billed as a result.", "default": false }, "concepts": { "title": "Extra XBRL concepts", "type": "array", "description": "Optional us-gaap concept names to add to the facts rows, e.g. OperatingIncomeLoss, StockholdersEquity, NetCashProvidedByUsedInOperatingActivities. Prefix another taxonomy with a colon, e.g. dei:EntityPublicFloat. Concepts a company never reported are left out.", "items": { "type": "string" } }, "includeDocumentText": { "title": "Include document text", "type": "boolean", "description": "Download each filing's primary document and add its plain text (HTML stripped, inline XBRL header removed). One extra request per filing; PDFs and images are skipped.", "default": false }, "maxDocumentTextChars": { "title": "Maximum document text length", "minimum": 1000, "maximum": 2000000, "type": "integer", "description": "Cut the document text after this many characters (documentTextTruncated is then true). A full 10-K is often 300,000 to 600,000 characters.", "default": 200000 }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many dataset rows in total (filings plus facts rows).", "default": 1000 }, "userAgentContact": { "title": "Your contact for the SEC User-Agent", "type": "string", "description": "The SEC fair-access policy asks automated tools to identify who is making requests: put your name or company and an email address here, e.g. \"Jane Doe jane@example.com\". It is sent only to sec.gov in the User-Agent header.", "default": "Your Name your-email@example.com" }, "maxConcurrency": { "title": "Companies in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many companies are processed at once. All requests share one limiter at 8 per second, under the SEC limit of 10.", "default": 2 }, "maxAttempts": { "title": "Attempts per company", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many times a company is retried after rate limiting, server errors or timeouts before it is reported as failed. Work already fetched is kept between attempts.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout for each request to the SEC.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The SEC identifies tools by User-Agent, not IP, so a datacenter proxy is fine. Turn Apify Proxy off to connect directly.", "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 } } } } } } } } } }