{ "openapi": "3.0.1", "info": { "title": "SEC Financial Statements Scraper: XBRL by Ticker", "description": "Income statement, balance sheet and cash flow of any SEC XBRL filer by ticker, CIK or name, from EDGAR, no login or API key: years, quarters, TTM or one line across all filers. Rows: line, value, period, fiscal year, XBRL concept, 10-K/10-Q accession, first reported value. JSON or CSV, pay per row.", "version": "0.1", "x-build-id": "taIHYkaxvWGd4nFIQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation_craft~sec-xbrl-financials-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation_craft-sec-xbrl-financials-scraper", "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/automation_craft~sec-xbrl-financials-scraper/runs": { "post": { "operationId": "runs-sync-automation_craft-sec-xbrl-financials-scraper", "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/automation_craft~sec-xbrl-financials-scraper/run-sync": { "post": { "operationId": "run-sync-automation_craft-sec-xbrl-financials-scraper", "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": { "tickers": { "title": "Tickers", "type": "array", "description": "Stock ticker symbols of SEC filers, for example AAPL, MSFT or BRK-B (a class share with a dash, a dot or a slash). Each is matched to its CIK through the SEC's own ticker file; a ticker it does not list gets a free status row.", "items": { "type": "string" } }, "ciks": { "title": "CIK numbers", "type": "array", "description": "SEC CIK numbers (up to 10 digits, leading zeros optional) or EDGAR company links. Use a CIK for a company the ticker file no longer lists (a delisted company, an old CIK after a reorganisation).", "items": { "type": "string" } }, "companyNames": { "title": "Company names", "type": "array", "description": "Company names as the SEC's ticker file lists them, for example \"Apple Inc.\" or \"Alphabet\". The exact name is looked up first, else every company whose name holds every word given (whole words, any order, case and punctuation aside). A name that matches several companies is never guessed: a free status row lists up to 10 candidates with their tickers and CIKs.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "companies", "frames" ], "type": "string", "description": "companies (default when left out): statements of the companies named above. frames: one line or concept for every SEC filer in a calendar period, narrowed by the companies named above when you give any." }, "layout": { "title": "Layout", "enum": [ "lines", "periods", "facts" ], "type": "string", "description": "lines (default): one row per company, line and period, with the concept, filing and first reported value of each figure (charged as a Statement line). periods: one row per company and period with every line as a column (charged as a Statement period). facts: every XBRL fact as the company reported it, all concepts (charged as an XBRL fact)." }, "periodType": { "title": "Periods", "enum": [ "annual", "quarterly", "both" ], "type": "string", "description": "annual (default): fiscal years from 10-K, 20-F and 40-F reports. quarterly: fiscal quarters from 10-Q reports, the fourth quarter and missing quarters of income and cash flow lines derived from the year to date figures (marked derived). both: years and quarters." }, "includeTtm": { "title": "Trailing twelve months", "type": "boolean", "description": "Add one trailing twelve months period per company: income and cash flow lines summed over the last four quarters (all four read from one concept), balance sheet lines at the latest quarter, EPS summed only when all four quarters are the company's own reported quarterly EPS, share counts not summed. Default false." }, "latestPeriods": { "title": "Latest periods", "minimum": 1, "maximum": 80, "type": "integer", "description": "The number of most recent periods per company and period type (default 5 when no fiscal year or period end range is given). For example 10 with annual periods gives ten fiscal years." }, "fiscalYearFrom": { "title": "Fiscal year from", "minimum": 1993, "maximum": 2100, "type": "integer", "description": "Only periods of this fiscal year or later, as the company labels its fiscal years (Apple's fiscal 2025 ended in September 2025)." }, "fiscalYearTo": { "title": "Fiscal year to", "minimum": 1993, "maximum": 2100, "type": "integer", "description": "Only periods of this fiscal year or earlier." }, "fiscalPeriods": { "title": "Fiscal periods", "type": "array", "description": "Only these fiscal periods, for example Q4 alone, or FY and TTM. Empty: every period of the period type chosen.", "items": { "type": "string", "enum": [ "FY", "Q1", "Q2", "Q3", "Q4", "TTM" ], "enumTitles": [ "Fiscal year", "First quarter", "Second quarter", "Third quarter", "Fourth quarter", "Trailing twelve months" ] } }, "periodEndFrom": { "title": "Period end from", "type": "string", "description": "Only periods that end on or after this date (YYYY-MM-DD). In the facts layout: facts whose period ends on or after it." }, "periodEndTo": { "title": "Period end to", "type": "string", "description": "Only periods that end on or before this date (YYYY-MM-DD)." }, "periodRowsBy": { "title": "Period rows (periods layout)", "enum": [ "period", "statement" ], "type": "string", "description": "period (default): one row per company and period with every line. statement: one row per company, statement and period (an income statement row, a balance sheet row, a cash flow row), each charged as a Statement period." }, "statements": { "title": "Statements", "type": "array", "description": "Which statements to deliver, every line of each: income, balance (balance sheet), cashflow, bank (interest income, net interest income, credit loss provision, deposits, loans) and ratios. Empty: income, balance, cashflow and bank. Give statements or lines, not both.", "items": { "type": "string", "enum": [ "income", "balance", "cashflow", "bank", "ratios" ], "enumTitles": [ "Income statement", "Balance sheet", "Cash flow statement", "Bank lines", "Ratios" ] } }, "lines": { "title": "Lines", "type": "array", "description": "Only these lines and ratios (instead of whole statements; give lines or statements, not both). Each line is read from a list of XBRL concepts in a fixed order, and every row names the concept it came from (a derived line: how it was computed).", "items": { "type": "string", "enum": [ "revenue", "cost_of_revenue", "gross_profit", "research_and_development", "sga", "operating_expenses", "operating_income", "ebitda", "interest_expense", "pretax_income", "income_tax", "net_income", "net_income_common", "eps_basic", "eps_diluted", "shares_basic", "shares_diluted", "cash", "short_term_investments", "receivables", "inventory", "current_assets", "ppe_net", "goodwill", "intangibles", "total_assets", "accounts_payable", "current_liabilities", "short_term_debt", "long_term_debt", "total_debt", "cash_and_short_term_investments", "shares_outstanding", "total_liabilities", "equity", "liabilities_and_equity", "operating_cash_flow", "capex", "free_cash_flow", "investing_cash_flow", "financing_cash_flow", "dividends_paid", "buybacks", "depreciation_amortization", "stock_based_compensation", "interest_income", "net_interest_income", "provision_for_credit_losses", "deposits", "loans", "gross_margin", "operating_margin", "net_margin", "free_cash_flow_margin", "return_on_equity", "return_on_assets", "return_on_invested_capital", "current_ratio", "quick_ratio", "debt_to_equity", "total_debt_to_equity", "payout_ratio", "book_value_per_share", "cash_per_share", "revenue_growth", "net_income_growth", "eps_diluted_growth", "revenue_cagr_3y", "revenue_cagr_5y", "eps_diluted_cagr_3y", "eps_diluted_cagr_5y" ], "enumTitles": [ "Revenue", "Cost of revenue", "Gross profit", "Research and development", "Selling, general and administrative", "Operating expenses", "Operating income", "EBITDA", "Interest expense", "Income before taxes", "Income tax expense", "Net income", "Net income to common shareholders", "EPS basic", "EPS diluted", "Weighted average shares basic", "Weighted average shares diluted", "Cash and cash equivalents", "Short term investments", "Receivables", "Inventory", "Total current assets", "Property, plant and equipment, net", "Goodwill", "Intangible assets (excluding goodwill)", "Total assets", "Accounts payable", "Total current liabilities", "Short term debt", "Long term debt", "Total debt", "Cash and short term investments", "Shares outstanding", "Total liabilities", "Shareholders' equity", "Total liabilities and equity", "Cash from operating activities", "Capital expenditure", "Free cash flow", "Cash from investing activities", "Cash from financing activities", "Dividends paid", "Share repurchases", "Depreciation and amortization", "Stock based compensation", "Interest income", "Net interest income", "Provision for credit losses", "Deposits", "Loans, net", "Gross margin", "Operating margin", "Net margin", "Free cash flow margin", "Return on equity", "Return on assets", "Return on invested capital", "Current ratio", "Quick ratio", "Long term debt to equity", "Total debt to equity", "Dividend payout ratio", "Book value per share", "Cash per share", "Revenue growth on the year before", "Net income growth on the year before", "EPS diluted growth on the year before", "Revenue growth per year over 3 years", "Revenue growth per year over 5 years", "EPS diluted growth per year over 3 years", "EPS diluted growth per year over 5 years" ] } }, "concepts": { "title": "Extra XBRL concepts", "type": "array", "description": "XBRL concepts to deliver beside the standard lines (or, in the facts layout, the only concepts to deliver), for example us-gaap:ResearchAndDevelopmentExpense, ifrs-full:Revenue or a bare us-gaap name such as AdvertisingExpense.", "items": { "type": "string" } }, "includeRatios": { "title": "Ratios", "type": "boolean", "description": "Add 21 ratios computed from the same period's lines: gross, operating, net and free cash flow margins; return on equity, assets and invested capital (fiscal years and TTM); current and quick ratios; long term and total debt to equity; payout ratio; book value and cash per share; growth of revenue, net income and diluted EPS on the year before; revenue and EPS growth per year over 3 and 5 years. Each is charged as a Statement line. Default false." }, "valueVersion": { "title": "Value version", "enum": [ "latest", "first_reported" ], "type": "string", "description": "latest (default): every figure as last reported (restated, split adjusted). first_reported: as first reported, before later restatements, with the filing that first reported it. Statement line rows carry both values either way; period rows list the other version of the columns that differ." }, "forms": { "title": "Report forms", "type": "array", "description": "Only figures from these report forms (their amendments included unless turned off below). Empty: 10-K, 10-KT, 20-F, 40-F, 10-Q and 10-QT.", "items": { "type": "string", "enum": [ "10-K", "10-KT", "20-F", "40-F", "10-Q", "10-QT" ], "enumTitles": [ "10-K", "10-KT", "20-F", "40-F", "10-Q", "10-QT" ] } }, "includeAmendments": { "title": "Amendments", "type": "boolean", "description": "Read figures from amended reports (10-K/A, 10-Q/A) as well. Default true." }, "filedFrom": { "title": "Filed from", "type": "string", "description": "Only figures filed on or after this date (YYYY-MM-DD), for example the figures of reports filed this month." }, "filedTo": { "title": "Filed to", "type": "string", "description": "Only figures filed on or before this date (YYYY-MM-DD)." }, "factVersions": { "title": "Fact versions (facts layout)", "enum": [ "latest", "all" ], "type": "string", "description": "latest (default): one row per fact (concept, unit and period), its latest filed value. all: one row per filing that reported it (comparatives and restatements included)." }, "taxonomies": { "title": "Taxonomies (facts layout)", "type": "array", "description": "Only facts of these taxonomies. Empty: all of them.", "items": { "type": "string", "enum": [ "us-gaap", "ifrs-full", "dei", "srt", "invest" ], "enumTitles": [ "US GAAP", "IFRS", "Document and entity (dei)", "SEC reporting (srt)", "Investments (invest)" ] } }, "includeCompanyProfile": { "title": "Company profile rows", "type": "boolean", "description": "Add one free row per company: its SEC filer record (SIC industry, filer category, fiscal year end, state of incorporation, EIN, exchanges, former names, business address and phone), what its XBRL file holds, and whether its latest report is in the SEC's XBRL API yet. Default true." }, "peerComparison": { "title": "Peer comparison", "type": "boolean", "description": "Add free rows that rank the companies of the run on every line and fiscal period they share (rank, percentile, median, mean, min, max), for runs of 2 to 200 companies. Default false." }, "includeSegments": { "title": "Segment figures (add-on)", "type": "boolean", "description": "Add one Segment figure row per line, period and member that the company broke down by product or service, business segment or geographic area in the XBRL of the filing behind the line's figure (for example Apple's revenue by iPhone, Mac and Services, by Americas and Europe, by country). Read from each filing on the SEC's archive, charged per row; lines layout only. Default false." }, "maxRowsPerCompany": { "title": "Max rows per company", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop each company after this many charged rows." }, "frameLines": { "title": "Lines (frames)", "type": "array", "description": "The lines to read (default revenue). Each line is read from its list of US GAAP concepts; a company is taken from the first concept it reported.", "items": { "type": "string", "enum": [ "revenue", "cost_of_revenue", "gross_profit", "research_and_development", "sga", "operating_expenses", "operating_income", "interest_expense", "pretax_income", "income_tax", "net_income", "net_income_common", "eps_basic", "eps_diluted", "shares_basic", "shares_diluted", "cash", "short_term_investments", "receivables", "inventory", "current_assets", "ppe_net", "goodwill", "intangibles", "total_assets", "accounts_payable", "current_liabilities", "short_term_debt", "long_term_debt", "cash_and_short_term_investments", "shares_outstanding", "total_liabilities", "equity", "liabilities_and_equity", "operating_cash_flow", "capex", "investing_cash_flow", "financing_cash_flow", "dividends_paid", "buybacks", "depreciation_amortization", "stock_based_compensation", "interest_income", "net_interest_income", "provision_for_credit_losses", "deposits", "loans" ], "enumTitles": [ "Revenue", "Cost of revenue", "Gross profit", "Research and development", "Selling, general and administrative", "Operating expenses", "Operating income", "Interest expense", "Income before taxes", "Income tax expense", "Net income", "Net income to common shareholders", "EPS basic", "EPS diluted", "Weighted average shares basic", "Weighted average shares diluted", "Cash and cash equivalents", "Short term investments", "Receivables", "Inventory", "Total current assets", "Property, plant and equipment, net", "Goodwill", "Intangible assets (excluding goodwill)", "Total assets", "Accounts payable", "Total current liabilities", "Short term debt", "Long term debt", "Cash and short term investments", "Shares outstanding", "Total liabilities", "Shareholders' equity", "Total liabilities and equity", "Cash from operating activities", "Capital expenditure", "Cash from investing activities", "Cash from financing activities", "Dividends paid", "Share repurchases", "Depreciation and amortization", "Stock based compensation", "Interest income", "Net interest income", "Provision for credit losses", "Deposits", "Loans, net" ] } }, "frameConcepts": { "title": "XBRL concepts (frames)", "type": "array", "description": "XBRL concepts to read across all companies instead of lines, for example us-gaap:AdvertisingExpense or dei:EntityCommonStockSharesOutstanding.", "items": { "type": "string" } }, "frameUnit": { "title": "Unit (frames)", "type": "string", "description": "The unit of the concepts above: USD (default), shares, USD/shares, pure." }, "calendarPeriod": { "title": "Calendar period", "type": "string", "description": "CY2024 for a calendar year, CY2024Q3 for a quarter (default: the last calendar year). The SEC places each company's fiscal year in the calendar year it overlaps most. Balance sheet lines are read at the period's end." }, "minValue": { "title": "Minimum value", "type": "number", "description": "Only companies whose figure is at least this value (one line or concept only), for example 1000000000 for revenue of a billion dollars or more." }, "maxValue": { "title": "Maximum value", "type": "number", "description": "Only companies whose figure is at most this value (one line or concept only)." }, "exchanges": { "title": "Exchanges", "type": "array", "description": "Only companies listed on these exchanges (as the SEC's ticker file names them). Empty: every company, listed or not.", "items": { "type": "string", "enum": [ "Nasdaq", "NYSE", "OTC", "CBOE", "TXSE" ], "enumTitles": [ "Nasdaq", "NYSE", "OTC", "CBOE", "Texas Stock Exchange" ] } }, "locations": { "title": "Locations", "type": "array", "description": "Only companies the SEC places in these locations: a two letter country code (US, CA, GB, CN) or US and a state (US-CA, US-NY). Empty: everywhere.", "items": { "type": "string" } }, "excludeLocations": { "title": "Exclude locations", "type": "array", "description": "Leave out companies the SEC places in these locations, for example US to keep every company outside the United States, or US-CA. A company without a location is left out too.", "items": { "type": "string" } }, "sortOrder": { "title": "Sort", "enum": [ "desc", "asc", "none" ], "type": "string", "description": "desc (default): largest figure first. asc: smallest first. none: as the SEC lists them." }, "outputProfile": { "title": "Output profile", "enum": [ "full", "compact" ], "type": "string", "description": "full (default): every field. compact: the figure, its period, concept, source filing and (for a derived figure) its derivation, without operand lists, alternative concepts, labels or links, for spreadsheets." }, "maxItems": { "title": "Max charged rows", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "The run stops after this many charged rows (default 5000). Status, company, peer comparison and summary rows are free and not counted." }, "maxRunSeconds": { "title": "Max run time (seconds)", "minimum": 30, "maximum": 86400, "type": "integer", "description": "Stop reading after this many seconds; the rows read so far are delivered and the summary says what was not." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed: the SEC answers the run's own address, and one Apify datacenter proxy session is the single fallback when it refuses. Turn on Apify Proxy to send every request through that session." } } }, "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 } } } } } } } } } }