{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Filings & XBRL Financials", "description": "Get SEC EDGAR filings (10-K, 10-Q, 8-K, S-1...) and XBRL financial facts (revenue, net income, EPS, assets...) for US public companies by ticker or CIK, from the official data.sec.gov APIs. Fair-access compliant, clean JSON for analysts and AI agents.", "version": "1.0", "x-build-id": "lp7jM4mne4QkAF45W" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thriving_adder~sec-edgar-filings-xbrl/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thriving_adder-sec-edgar-filings-xbrl", "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/thriving_adder~sec-edgar-filings-xbrl/runs": { "post": { "operationId": "runs-sync-thriving_adder-sec-edgar-filings-xbrl", "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/thriving_adder~sec-edgar-filings-xbrl/run-sync": { "post": { "operationId": "run-sync-thriving_adder-sec-edgar-filings-xbrl", "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": [ "companies" ], "properties": { "companies": { "title": "Companies", "type": "array", "description": "Tickers (AAPL), CIKs (320193 or 0000320193) or exact SEC company names (Apple Inc.). Max 1,000 per run. Individual (insider) filers are skipped by default.", "items": { "type": "string" } }, "includeFilings": { "title": "Filings", "type": "boolean", "description": "Return filing records (charged per filing).", "default": true }, "formTypes": { "title": "Form types", "type": "array", "description": "Only these forms, e.g. 10-K, 10-Q, 8-K, S-1, DEF 14A, 20-F, 6-K, 13F-HR. Amendments (/A) are included. Empty = all forms.", "items": { "type": "string" } }, "filedFrom": { "title": "Filed from", "type": "string", "description": "Only filings made on or after this date (YYYY-MM-DD). Older filings beyond EDGAR's ~1,000 most recent are fetched automatically when needed." }, "filedTo": { "title": "Filed to", "type": "string", "description": "Only filings made on or before this date (YYYY-MM-DD)." }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Newest first.", "default": 20 }, "includeXbrlFacts": { "title": "XBRL financial facts", "type": "boolean", "description": "Return XBRL facts from the companyfacts API (charged per fact).", "default": false }, "xbrlConcepts": { "title": "Concepts", "type": "array", "description": "XBRL concept names (e.g. Revenues, NetIncomeLoss, Assets, EarningsPerShareDiluted). Empty = 21 key financials (revenue, costs, operating/net income, EPS, assets, liabilities, equity, cash, debt, operating cash flow, capex, shares). Use * for every concept (can be thousands of facts).", "items": { "type": "string" } }, "xbrlForms": { "title": "Fact source forms", "type": "array", "description": "Only facts reported in these forms (amendments included). Use 20-F/40-F for foreign private issuers. Empty = any form.", "default": [ "10-K", "10-Q" ], "items": { "type": "string" } }, "factsPeriodFrom": { "title": "Periods ending from", "type": "string", "description": "Only facts whose period ends on or after this date (YYYY-MM-DD). Recommended to keep runs small." }, "latestValueOnly": { "title": "Latest value per period only", "type": "boolean", "description": "Each period is repeated in later filings (comparatives). On: keep only the most recently filed value per concept, unit and period. Off: every reported value.", "default": true }, "maxFactsPerCompany": { "title": "Max facts per company", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Newest periods first.", "default": 500 }, "skipIndividualFilers": { "title": "Skip individual filers", "type": "boolean", "description": "Skip CIKs that belong to individuals (insiders filing Forms 3/4/5) rather than companies, to avoid collecting personal data. Skipped entries are free.", "default": true }, "contactEmail": { "title": "Contact e-mail for the SEC (recommended)", "type": "string", "description": "The SEC's fair-access policy asks automated tools to declare a contact in the User-Agent. By default the Actor declares its maintainer's contact address; enter your own e-mail to declare yourself instead (recommended for large runs). It is sent only to sec.gov in the User-Agent header and is not stored in the output." } } }, "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 } } } } } } } } } }