{ "openapi": "3.0.1", "info": { "title": "SEC XBRL Financials API: Revenue, Net Income, EPS by Ticker", "description": "Returns financial statement values (revenue, net income, EPS, assets, cash flow or any us-gaap tag) from SEC XBRL data, one row per company, concept and fiscal period from 10-K and 10-Q, or one value per company across all filers. Supports onlyNew.", "version": "0.1", "x-build-id": "jDfIOdui3UBJUc6qM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nightwave-owner~sec-xbrl-financials/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nightwave-owner-sec-xbrl-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/nightwave-owner~sec-xbrl-financials/runs": { "post": { "operationId": "runs-sync-nightwave-owner-sec-xbrl-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/nightwave-owner~sec-xbrl-financials/run-sync": { "post": { "operationId": "run-sync-nightwave-owner-sec-xbrl-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": { "mode": { "title": "Mode", "enum": [ "companies", "frames" ], "type": "string", "description": "\"companies\" returns the history of each company in the list (SEC companyfacts). \"frames\" returns one value per company for a whole calendar period across all filers (SEC frames), for example revenue of every company in 2024. Defaults to \"companies\".", "default": "companies" }, "companies": { "title": "Companies", "type": "array", "description": "Tickers (AAPL, msft, BRK.B) or CIK numbers (320193 or 0000320193), for example [\"AAPL\", \"MSFT\"]. 1 to 200 per run. Defaults to AAPL in companies mode. In frames mode the list filters the result, and an empty list returns every company.", "items": { "type": "string" } }, "concepts": { "title": "Concepts", "type": "array", "description": "Common names or XBRL tags, for example [\"revenue\", \"netIncome\", \"eps\"]. Common names: revenue, costOfRevenue, grossProfit, researchAndDevelopment, operatingIncome, incomeTax, netIncome, eps, epsDiluted, dilutedShares, dividendsPerShare, assets, currentAssets, liabilities, currentLiabilities, equity, cash, longTermDebt, operatingCashFlow, capex. Any other us-gaap tag works too (AccountsPayableCurrent), and other taxonomies with a prefix (ifrs-full:Revenue). Defaults to revenue, netIncome, eps and assets.", "items": { "type": "string" } }, "forms": { "title": "Forms", "type": "array", "description": "Reports to read values from in companies mode, for example [\"10-K\", \"10-Q\"]. 10-K gives annual values, 10-Q gives quarters, 20-F and 40-F are annual reports of foreign companies. Amendments are always read and replace the original value. Defaults to 10-K.", "items": { "type": "string", "enum": [ "10-K", "10-Q", "20-F", "40-F" ] }, "default": [ "10-K" ] }, "fiscalYearFrom": { "title": "Fiscal year from", "minimum": 2005, "maximum": 2100, "type": "integer", "description": "First fiscal year, for example 2020. In frames mode this is a calendar year. Defaults to four years before the end year, so the default covers five years." }, "fiscalYearTo": { "title": "Fiscal year to", "minimum": 2005, "maximum": 2100, "type": "integer", "description": "Last fiscal year (inclusive), for example 2026. In frames mode this is a calendar year. Defaults to the current year." }, "includeYearToDate": { "title": "Include year to date values", "type": "boolean", "description": "Companies mode with 10-Q: also return six and nine month year to date values next to the three month quarter, for example true. Cash flow statements in a 10-Q are often reported only year to date. Defaults to false.", "default": false }, "framePeriod": { "title": "Frame period", "enum": [ "annual", "quarterly" ], "type": "string", "description": "Frames mode only: \"annual\" (CY2024, or the year-end balance CY2024Q4I) or \"quarterly\" (CY2024Q1 to CY2024Q4). Defaults to \"annual\".", "default": "annual" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of facts to return in total, for example 50. Each fact (one value for one company, concept and period) is one billable result. Defaults to 50.", "default": 50 }, "onlyNew": { "title": "Only new facts", "type": "boolean", "description": "For scheduled runs. When true, facts that an earlier run with the same input already delivered are skipped and not charged, so a daily run returns only values from new or amended reports. The first run returns everything. Defaults to false.", "default": false } } }, "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 } } } } } } } } } }