{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Scraper: Filings, Full-Text Search & XBRL Financials", "description": "Get SEC EDGAR filings (10-K, 10-Q, 8-K, S-1, 13F, Form 4...) for any company by ticker, CIK or name, search the full text of every filing since 2001, pull XBRL financials (revenue, net income, EPS, assets) and optional filing text. Official SEC data, no API key. $0.30 per 1,000 filings.", "version": "1.0", "x-build-id": "s2HoEuKunr5t3H5jF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/best_apis~sec-edgar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-best_apis-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/best_apis~sec-edgar-scraper/runs": { "post": { "operationId": "runs-sync-best_apis-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/best_apis~sec-edgar-scraper/run-sync": { "post": { "operationId": "run-sync-best_apis-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 (ticker, CIK or name)", "type": "array", "description": "Get the filing history of these registrants: stock tickers (AAPL, BRK-B), CIK numbers (320193 or 0000320193) or company names (Tesla). Newest filings first.", "items": { "type": "string" } }, "searchQueries": { "title": "Full-text search", "type": "array", "description": "Search the full text of all EDGAR filings and exhibits since 2001, like efts.sec.gov. Use quotes for exact phrases (\"going concern\"), OR, and - to exclude. One row per matching filing, most relevant first.", "items": { "type": "string" } }, "forms": { "title": "Form types", "type": "array", "description": "Only these form types, for example 10-K, 10-Q, 8-K, S-1, DEF 14A, 13F-HR, 4, SC 13D. Leave empty for all forms.", "items": { "type": "string" } }, "dateFrom": { "title": "Filed from", "type": "string", "description": "Only filings filed on or after this date (YYYY-MM-DD)." }, "dateTo": { "title": "Filed to", "type": "string", "description": "Only filings filed on or before this date (YYYY-MM-DD)." }, "maxFilingsPerQuery": { "title": "Max filings per company or search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many filings for each company or search query.", "default": 100 }, "includeFinancials": { "title": "Include XBRL financials", "type": "boolean", "description": "Also output reported financial facts for each company (one row per metric and period), from the SEC's de-duplicated XBRL data. Charged per fact.", "default": false }, "financialConcepts": { "title": "Financial metrics (XBRL concepts)", "type": "array", "description": "US-GAAP or DEI concept names, for example Revenues, NetIncomeLoss, EarningsPerShareDiluted, Assets. Leave empty for 16 key metrics; use * for every reported concept.", "items": { "type": "string" } }, "financialPeriods": { "title": "Financial periods", "enum": [ "annual", "quarterly", "all" ], "type": "string", "description": "Which reporting periods to output.", "default": "annual" }, "financialYears": { "title": "Years of financials", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many past calendar years of financial facts to include.", "default": 5 }, "includeText": { "title": "Include filing text", "type": "boolean", "description": "Download each filing's main document (or the matched document for searches) and add its plain text. Charged per document.", "default": false }, "maxTextChars": { "title": "Max text characters", "minimum": 1000, "type": "integer", "description": "Truncate filing text to this many characters (the full length is in textLength).", "default": 50000 }, "maxItems": { "title": "Max records in total", "minimum": 1, "type": "integer", "description": "Stop after this many records (filings plus financial facts). Cost control.", "default": 1000 } } }, "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 } } } } } } } } } }