{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Scraper: Filings, Full-Text Search & XBRL Facts", "description": "Pull SEC filings, EDGAR full-text search results, XBRL financial facts and company profiles straight from the SEC's official APIs. Look companies up by ticker or CIK. No key, no login, no scraping.", "version": "0.0", "x-build-id": "N0Q0CqV7SwVaKYQzg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/winterlock~sec-edgar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-winterlock-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/winterlock~sec-edgar-scraper/runs": { "post": { "operationId": "runs-sync-winterlock-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/winterlock~sec-edgar-scraper/run-sync": { "post": { "operationId": "run-sync-winterlock-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", "required": [ "mode" ], "properties": { "mode": { "title": "What to collect", "enum": [ "companyFilings", "fullTextSearch", "companyFacts", "companyProfile" ], "type": "string", "description": "Filings for specific companies, an EDGAR full-text search, XBRL financial facts, or company profiles.", "default": "companyFilings" }, "contactEmail": { "title": "Contact email (recommended)", "type": "string", "description": "Strongly recommended. The SEC asks every automated client to name a contact address and can refuse undeclared traffic with HTTP 403. Use an address you monitor; it is sent only to sec.gov, in the User-Agent header. Left empty, the Actor identifies itself by name and Store page instead." }, "companies": { "title": "Companies", "type": "array", "description": "Ticker symbols (AAPL, MSFT) or CIK numbers (320193, CIK0000320193). Tickers are resolved through the SEC's own company list.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "For Full-text search. Wrap a phrase in double quotes to match it exactly, for example \"material weakness\". EDGAR full-text search covers 2001 onwards.", "items": { "type": "string" } }, "formTypes": { "title": "Form types", "type": "array", "description": "Limit to these forms, such as 10-K, 10-Q, 8-K, S-1, 4, 13F-HR, DEF 14A. Leave empty for every form.", "items": { "type": "string" } }, "dateFrom": { "title": "Filed on or after", "type": "string", "description": "YYYY-MM-DD. Leave empty for no lower bound." }, "dateTo": { "title": "Filed on or before", "type": "string", "description": "YYYY-MM-DD. Leave empty for no upper bound." }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Applies to Company filings. The submissions file holds at least the most recent 1,000 filings.", "default": 100 }, "includeOlderFilings": { "title": "Include the full filing history", "type": "boolean", "description": "Fetches the SEC's extra archive files so you get every filing ever made, not just the recent set. Costs one extra request per archive file.", "default": false }, "maxResultsPerQuery": { "title": "Max results per search query", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Applies to Full-text search. EDGAR pages 10 hits at a time and will not return results past the 10,000th.", "default": 100 }, "xbrlTags": { "title": "XBRL tags", "type": "array", "description": "Specific tags to pull, such as Revenues, NetIncomeLoss, Assets, EarningsPerShareDiluted. Leave empty to download every fact the company has filed, which is a large file.", "items": { "type": "string" } }, "xbrlTaxonomy": { "title": "XBRL taxonomy", "type": "string", "description": "Usually us-gaap. Other options include dei, ifrs-full and srt.", "default": "us-gaap" }, "maxFactsPerCompany": { "title": "Max facts per company", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Facts are sorted newest first, so a low number gives you the most recent figures. When you name tags, the limit applies to each tag.", "default": 500 }, "maxItems": { "title": "Max items in total", "minimum": 1, "type": "integer", "description": "Stop the run after saving this many items. Leave empty for no limit." }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "The SEC asks clients to stay under 10 requests per second. Leave this at 2 unless you know you need more; going high risks a temporary block of the IP.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed. The SEC's APIs are open to datacenter traffic that identifies itself and respects the rate limit.", "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 } } } } } } } } } }