{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Filings & Financials API - 10-K, 10-Q, 8-K, XBRL", "description": "Get SEC EDGAR filings (10-K, 10-Q, 8-K, Form 4, S-1, 13F...) by ticker or CIK with direct document links, plus clean XBRL financials: standardised revenue, net income, EPS, assets and cash flow as annual or quarterly time series. Official SEC APIs, new-filings-only monitoring.", "version": "0.1", "x-build-id": "rjABuSJnUetJcOYv8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/olsols4~sec-edgar-filings-financials/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-olsols4-sec-edgar-filings-financials", "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/olsols4~sec-edgar-filings-financials/runs": { "post": { "operationId": "runs-sync-olsols4-sec-edgar-filings-financials", "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/olsols4~sec-edgar-filings-financials/run-sync": { "post": { "operationId": "run-sync-olsols4-sec-edgar-filings-financials", "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": { "companies": { "title": "Companies", "type": "array", "description": "Tickers (AAPL), CIK numbers (320193) or exact company names (Apple Inc.). Any company or person that files with the SEC, including those without a ticker (use the CIK).", "items": { "type": "string" } }, "formTypes": { "title": "Form types", "type": "array", "description": "Only keep these forms, e.g. 10-K, 10-Q, 8-K, 4, S-1, DEF 14A, 13F-HR, 20-F. Leave empty for every form.", "items": { "type": "string" } }, "includeAmendments": { "title": "Include amendments", "type": "boolean", "description": "Also keep amended versions of the chosen forms (10-K/A for 10-K).", "default": true }, "filedFrom": { "title": "Filed from", "type": "string", "description": "Only filings made on or after this date (YYYY-MM-DD)." }, "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": 0, "maximum": 100000, "type": "integer", "description": "Newest first. Set 0 to skip filings and only get financials. History goes back to 1994; older pages are loaded only when needed.", "default": 100 }, "onlyNewFilings": { "title": "Only new filings since last run", "type": "boolean", "description": "For monitoring: remembers filings already returned for the same companies and form types, and saves only new ones next time. The first run returns everything (that is the baseline). Schedule it hourly or daily.", "default": false }, "includeCompanyProfile": { "title": "Include company profile", "type": "boolean", "description": "One row per company: industry (SIC), exchanges, fiscal year end, state of incorporation, address, website, former names.", "default": true }, "financials": { "title": "Financial data (XBRL)", "enum": [ "none", "key", "all" ], "type": "string", "description": "Adds financial facts from the SEC's XBRL company facts. 'Key financials' maps 16 standard metrics across tag changes so you get one clean series per metric.", "default": "none" }, "customConcepts": { "title": "Extra XBRL concepts", "type": "array", "description": "Optional. Extra XBRL tags to include, e.g. InventoryNet, us-gaap:AccountsReceivableNetCurrent, dei:EntityPublicFloat.", "items": { "type": "string" } }, "financialsPeriod": { "title": "Financial periods", "enum": [ "annual", "quarterly", "all" ], "type": "string", "description": "Which reporting periods to keep for financial facts. Balance-sheet values are point-in-time and follow the filing's period.", "default": "annual" }, "financialsFromYear": { "title": "Financials from year", "minimum": 1990, "maximum": 2100, "type": "integer", "description": "Only financial values for periods ending in or after this year." }, "dedupeFacts": { "title": "One value per period", "type": "boolean", "description": "The same number is repeated in later filings (prior-year comparisons). Keep only the latest-filed value for each metric and period. Turn off to get every reported instance.", "default": true }, "frames": { "title": "XBRL frames (cross-company)", "type": "array", "description": "Optional. One value per company for a concept and calendar period, across all filers: taxonomy/concept/unit/period, e.g. us-gaap/Revenues/USD/CY2024, us-gaap/Assets/USD/CY2024Q4I (I = instant). Each company is one row.", "items": { "type": "string" } }, "maxFrameRows": { "title": "Max rows per frame", "minimum": 0, "type": "integer", "description": "Keep only the N largest values per frame (e.g. top 500 by revenue). 0 = all companies.", "default": 0 } } }, "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 } } } } } } } } } }