{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR API · Filings, Full-Text Search & Financials", "description": "Query SEC EDGAR: company filings (10-K, 10-Q, 8-K, Form 4…), full-text search across all filings, and XBRL financial statements. Official US government data, no API key.", "version": "1.0", "x-build-id": "OC0cyNwqL0rK47Bi3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sauliusautomatesit~sec-edgar-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sauliusautomatesit-sec-edgar-api", "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/sauliusautomatesit~sec-edgar-api/runs": { "post": { "operationId": "runs-sync-sauliusautomatesit-sec-edgar-api", "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/sauliusautomatesit~sec-edgar-api/run-sync": { "post": { "operationId": "run-sync-sauliusautomatesit-sec-edgar-api", "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": { "dataType": { "title": "Data type", "enum": [ "filings", "search", "financials", "company" ], "type": "string", "description": "What to fetch. `filings` = a company's filings list; `search` = full-text search across ALL EDGAR filings; `financials` = XBRL financial statement line-items over time; `company` = company profile & metadata.", "default": "filings" }, "companies": { "title": "Companies (tickers or CIKs)", "type": "array", "description": "Ticker symbols or CIK numbers for filings / financials / company (e.g. `AAPL`, `TSLA`, `0000320193`). Tickers are resolved to CIKs automatically.", "items": { "type": "string" } }, "searchQuery": { "title": "Full-text search query", "type": "string", "description": "Text to search across all EDGAR filings when `dataType: search` (supports quotes for exact phrases, e.g. `\"climate risk\"`). Covers filings from 2001 to today." }, "forms": { "title": "Form types filter", "type": "array", "description": "Restrict to these form types (e.g. `10-K`, `10-Q`, `8-K`, `4`, `S-1`, `13F-HR`, `DEF 14A`). Empty = all forms. Applies to filings and search.", "items": { "type": "string" } }, "startDate": { "title": "Start date (YYYY-MM-DD)", "type": "string", "description": "Only include filings on or after this date." }, "endDate": { "title": "End date (YYYY-MM-DD)", "type": "string", "description": "Only include filings on or before this date." }, "concepts": { "title": "Financial concepts", "type": "array", "description": "For `financials`: which line-items to pull (each returns a time series of annual & quarterly values from XBRL).", "items": { "type": "string", "enum": [ "revenue", "netIncome", "grossProfit", "operatingIncome", "eps", "assets", "liabilities", "stockholdersEquity", "cash", "operatingCashFlow", "researchDevelopment", "sharesOutstanding" ], "enumTitles": [ "Revenue", "Net income", "Gross profit", "Operating income", "EPS", "Total assets", "Total liabilities", "Shareholders' equity", "Cash & equivalents", "Operating cash flow", "R&D expense", "Shares outstanding" ] }, "default": [ "revenue", "netIncome", "assets", "stockholdersEquity" ] }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap filings returned per company (most recent first).", "default": 40 }, "maxSearchResults": { "title": "Max search results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap total results for full-text search.", "default": 100 }, "dedupAcrossRuns": { "title": "Only return NEW filings (monitoring)", "type": "boolean", "description": "Skip filings/records already returned by previous runs sharing the dedup store below. Ideal for scheduled monitoring of new filings.", "default": false }, "dedupStoreName": { "title": "Dedup store name", "type": "string", "description": "Named storage remembering records across runs. Use one per watchlist.", "default": "sec-edgar-dedup" }, "userAgentContact": { "title": "Contact (for SEC User-Agent)", "type": "string", "description": "SEC's fair-access policy asks requests to identify a contact (e.g. your name & email, `Jane Doe jane@acme.com`). Optional — a default is used if blank." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. Apify Proxy recommended.", "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 } } }, "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 } } } } } } } } } }