{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR API — Filings, XBRL Financials & Full-Text Search", "description": "Query the SEC's official EDGAR APIs from one Actor: resolve any ticker, CIK or company name; list 10-K, 10-Q, 8-K and Form 4 filings by date; pull normalized XBRL income statement, balance sheet and cash flow by period; run full-text search across filings since 2001.", "version": "0.1", "x-build-id": "WQje7nnL4yh7gLah6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/insight.solutions~sec-edgar-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-insight.solutions-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/insight.solutions~sec-edgar-api/runs": { "post": { "operationId": "runs-sync-insight.solutions-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/insight.solutions~sec-edgar-api/run-sync": { "post": { "operationId": "run-sync-insight.solutions-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "company", "filings", "financials", "fullTextSearch" ], "type": "string", "description": "What to return. company = the entity record for each identifier. filings = filing history with form and date filters. financials = normalized XBRL income statement, balance sheet and cash flow by period; a company that files with the SEC but publishes no XBRL facts returns one company record with financials: null, billed as a company-record rather than a financial-period. fullTextSearch = EDGAR full-text search across filing documents (2001 onwards).", "default": "filings" }, "identifiers": { "title": "Companies", "type": "array", "description": "Tickers (AAPL), CIKs (320193 or 0000320193), or company names (Apple Inc.). Required for the company, filings and financials modes. In fullTextSearch mode these are optional and narrow the search to those companies. Multi-class tickers such as GOOG and GOOGL resolve to the same CIK and are returned once.", "items": { "type": "string" } }, "formTypes": { "title": "Form types", "type": "array", "description": "Filter to these EDGAR form types, e.g. 10-K, 10-Q, 8-K, 4, D. Amendments are included automatically: asking for 10-K also returns 10-K/A, flagged with isAmendment. Leave empty for all forms. Used by the filings and fullTextSearch modes.", "default": [], "items": { "type": "string" } }, "filedAfter": { "title": "Filed on or after", "type": "string", "description": "Only include filings filed on or after this date (YYYY-MM-DD)." }, "filedBefore": { "title": "Filed on or before", "type": "string", "description": "Only include filings filed on or before this date (YYYY-MM-DD)." }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum filings returned per company in filings mode, newest first. In fullTextSearch mode this caps the total number of search hits returned. Older filings beyond the most recent 1,000 are fetched automatically when this limit or the date range requires it.", "default": 50 }, "statements": { "title": "Statements", "type": "array", "description": "Which financial statements to return in financials mode. One dataset row is produced per statement per fiscal period.", "items": { "type": "string", "enum": [ "income", "balance", "cashflow" ], "enumTitles": [ "Income statement", "Balance sheet", "Cash flow statement" ] }, "default": [ "income", "balance", "cashflow" ] }, "periodType": { "title": "Period type", "enum": [ "annual", "quarterly", "both" ], "type": "string", "description": "Fiscal periods to return in financials mode. Year-to-date figures reported inside quarterly filings (six- and nine-month periods) are deliberately excluded so that quarterly rows are always single quarters.", "default": "annual" }, "maxPeriods": { "title": "Max periods", "minimum": 1, "maximum": 40, "type": "integer", "description": "Maximum fiscal periods returned per company in financials mode, most recent first. When period type is 'both', this limit applies separately to annual and to quarterly periods.", "default": 8 }, "query": { "title": "Full-text query", "type": "string", "description": "Search phrase for fullTextSearch mode. Wrap a phrase in double quotes for an exact match, e.g. \"material weakness\". EDGAR full-text search covers filings from 2001 onwards." }, "includeDocumentUrls": { "title": "Include document URLs", "type": "boolean", "description": "Include direct links to the primary filing document and to the filing index page on sec.gov.", "default": true }, "userAgentContact": { "title": "SEC User-Agent contact (required)", "type": "string", "description": "Your organisation and a working contact address, e.g. 'Acme Research data@acme.com'. The SEC requires every automated request to declare who is making it and how to reach them (sec.gov/os/accessing-edgar-data), and answers HTTP 403 without it. The pre-filled value is the publisher's own contact so the example run works out of the box; please replace it with yours for real use, so the SEC reaches you, not us, about your traffic." }, "maxRunSecs": { "title": "Maximum run time (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Wall-clock budget for the whole run. When it is reached the Actor stops requesting more data, keeps every row it has already written, and says so in the run status. Rows already written are still charged; nothing is charged for work that did not happen.", "default": 240 } } }, "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 } } } } } } } } } }