{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Scraper — Filings, Companies & XBRL", "description": "Scrape SEC EDGAR filings (10-K, 10-Q, 8-K, S-1), full-text search, XBRL company facts, and CIK/ticker lookup via SEC's official public JSON APIs. No auth, no captcha. Built-in 10 req/s throttle. For fintech, ESG, research, and compliance.", "version": "0.1", "x-build-id": "ORuCsw7J3a7ga6A6D" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/openclawmara~sec-edgar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-openclawmara-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/openclawmara~sec-edgar-scraper/runs": { "post": { "operationId": "runs-sync-openclawmara-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/openclawmara~sec-edgar-scraper/run-sync": { "post": { "operationId": "run-sync-openclawmara-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": "Scraping Mode", "enum": [ "company", "filings", "fulltext", "xbrl_facts", "company_lookup" ], "type": "string", "description": "What to fetch from SEC EDGAR", "default": "filings" }, "cik": { "title": "CIK", "type": "string", "description": "SEC Central Index Key. Numeric or zero-padded. Used for modes: company, filings, xbrl_facts. Use either CIK or ticker." }, "ticker": { "title": "Ticker", "type": "string", "description": "Stock ticker (e.g. AAPL, MSFT, NVDA). Resolved to a CIK via SEC's company-tickers index. Used for modes: company, filings, xbrl_facts." }, "forms": { "title": "Form Filter", "type": "array", "description": "Restrict by SEC form types, e.g. 10-K, 10-Q, 8-K, S-1, DEF 14A. Comma-separated string or array. Used for modes: filings, fulltext.", "default": [], "items": { "type": "string" } }, "date_from": { "title": "Date from", "type": "string", "description": "ISO date (YYYY-MM-DD), inclusive. Used for modes: filings, fulltext." }, "date_to": { "title": "Date to", "type": "string", "description": "ISO date (YYYY-MM-DD), inclusive. Used for modes: filings, fulltext." }, "query": { "title": "Search query", "type": "string", "description": "Full-text query string for mode=fulltext (EDGAR EFTS syntax) or substring filter for mode=company_lookup." }, "concepts": { "title": "XBRL Concepts", "type": "array", "description": "Restrict mode=xbrl_facts to specific GAAP concepts, e.g. Revenues, NetIncomeLoss, Assets. Comma-separated string or array.", "default": [], "items": { "type": "string" } }, "limit": { "title": "Limit", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum items to push. Applies per-mode (filings: per company, fulltext: total results, company_lookup: total matches).", "default": 50 }, "user_agent": { "title": "User-Agent (optional override)", "type": "string", "description": "SEC requires a descriptive User-Agent with contact info. Defaults to 'openclawmara apify-sec-edgar-scraper'. Set your own for high-volume use." } } }, "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 } } }, "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 } } } } } } } } } }