AgentMarketMCP / SKILL 资产档案馆

目录 / akkrudata

MCP 鉴权未知 未评级 已上架

akkrudata

SEC filings, financial statements, metrics, insider and institutional holdings as structured data

该来源不提供完整文件导出（国内平台多为平台内托管），仅存元数据与原链
模型生成摘要（rules/v1 · 2026-09-27 16:42）：SEC filings, financial statements, metrics, insider and institutional holdings as structured data
这是模型对公开材料的总结，不是官方声明，请以原链内容为准。

接入信息

传输形态
http
鉴权方式
鉴权未知
端点
https://akkrudata--akkrudata.run.tools
鉴权方式未标注，请核对官方文档后再接入——不要直接使用以下片段
{
  "mcpServers": {
    "akkrudata": {
      "url": "https://akkrudata--akkrudata.run.tools"
    }
  }
}

能力清单

工具说明
lookup_companyResolve one company and return its identity plus a coverage summary (which form_types × fiscal_years × quarters we have on file). Use this as the entry point when you only know a company name/ticker and need to discover what filings exist before calling get_filing_facts, query_line_items, get_filing_statement, etc. Provide exactly one of: ticker (e.g. "AAPL" for US, "000100" for Korea, "1332" for Japan, "VIRI_F" for Europe, "600519_CN" for China A-share), cik (numeric string, US-only, e.g. "0000320193"), dart_corp_code (numeric string, Korea-only, e.g. "00145109"), or edinet_code (e.g. "E00014", Japan-only). Response includes jurisdiction ("US", "KR", "JP", "EU", or "CN") and the corresponding registrant id + filings-list URL. Coverage keys: US uses the SEC form names ("10-K" / "10-Q" / "20-F" / "40-F"); Korea, Japan, and Europe use jurisdiction-neutral labels ("annual" / "quarterly") rather than SEC names — Korean (사업보고서 / 분기보고서 to DART) and Japanese (有価証券報告書 / 四半期報告書 to EDINET) filings are not SEC 10-K/10-Q. Every entry also carries an explicit `normalized_form` matching the KR/JP keys so callers can iterate uniformly across jurisdictions. Downstream tools' form_type parameter continues to accept "10-K" / "10-Q" as aliases for either jurisdiction. The `coverage` map may be truncated by your plan's history window — check `_warnings`. Companies outside your plan's coverage scope return 403 PLAN_TIER_INSUFFICIENT_COVERAGE. Returns identity and coverage only — not facts or statements; follow up with list_filings and the data/metric tools to read a filing. Same as POST /api/v1/data/company; 8 credits. See FINANCIAL_API_DOCUMENTATION.md.
list_companiesDiscovery: return every company covered. Optional jurisdiction parameter filters by market: "US", "KR", "JP", "EU", "CN", or "all". When omitted, returns everything the caller's plan includes. Each row includes ticker, jurisdiction, cik (US-listed), dart_corp_code (Korean), edinet_code (Japanese), lei (European), and uscc (China A-share). Cache the result locally and refresh at most once per day — the list changes only when new issuers are added. Results are silently filtered to your plan's coverage scope; `_warnings` is populated when filtered. Pro+ responses add a per-company `classification` block (canonical sector(s) + source scheme/code/url); omitted for sub-Pro. Same as GET /api/v1/data/company/list; 175 credits. FINANCIAL_API_DOCUMENTATION.md.
list_filingsList available SEC filings for one company and fiscal year (rows, ids, fact counts, and an amendment note on filings that absorbed an amendment). Use this first when you need filing_id or to see which quarters/forms exist before calling get_filing_facts, query_line_items, get_filing_statement, compare_line_items, compare_facts, or get_filing_excel. Arguments: ticker, fiscal_year; optional form_type, quarter. form_type accepts US forms (10-K, 10-Q) and foreign-issuer annual forms (20-F for US-listed foreign companies, 40-F for Canadian filers); Korean (DART) filings use 10-K (annual) / 10-Q (quarterly). Results may be truncated by your plan's history window or coverage scope — check `_warnings`. Companies outside your plan's coverage scope return 403 PLAN_TIER_INSUFFICIENT_COVERAGE. Same behavior and credits as POST /api/v1/data/filings; field details in FINANCIAL_API_DOCUMENTATION.md.
get_filing_factsFetch specific XBRL facts for a single filing by fact_id. For line-item-name queries (revenue, net income, etc.) use the query_line_items tool instead. Identify the filing with filing_id, OR with ticker + fiscal_year (+ optional quarter). fact_ids: required non-empty list of fact ids. form_type defaults to 10-K — for foreign issuers pass 20-F or 40-F; Korean (DART) filings use 10-K / 10-Q. light_weight_mode=true (bool, default false) omits results[*].dimensional_breakdowns — saves context when you already know exactly what you need. Charged identically. Same as POST /api/v1/data/facts; see FINANCIAL_API_DOCUMENTATION.md for tiers and limits.
query_line_itemsFetch XBRL facts for a single filing by line-item name (e.g. revenue, net income, operating expenses). Identify the filing with filing_id, OR with ticker + fiscal_year (+ optional quarter). line_items: non-empty list of names; resolved through L0-L3 tiers. Each result carries `_resolution_level` ("L0"-"L3") showing which tier matched and set its credit cost. form_type defaults to 10-K — for foreign issuers pass 20-F or 40-F; Korean (DART) filings use 10-K / 10-Q. Returns consolidated totals only — dimension slices (a single product line, segment, or region) are not served here, even when a printed statement row carries that name. By default each result lists its dimensional_breakdowns and a _warnings entry names the results that have them. To get slice values: get_dimensional_breakdown_by_fact_id (from the total's fact_id) / get_dimensional_breakdown_by_line_item, or get_filing_statement to read the full statement table. light_weight_mode=true (bool, default false) omits results[*].dimensional_breakdowns — saves context when you already know exactly what you need. Charged identically. A result may appear at multiple positions in the source filing; fact_ids lists every position as {fact_id, source_locator} pairs. If unsure of a line item name or fact_id, use list_filing_statements / get_filing_statement to read the whole statement. Multi-concept matches come pre-ordered (Akkru smart ranking); the order is a recommendation only — review all returned results and judge which one you need. To fetch by fact_id use get_filing_facts. POST /api/v1/data/line-items; see FINANCIAL_API_DOCUMENTATION.md.
get_filing_statementReturn extracted financial statement block(s) for a filing. Two lookup modes (mutually exclusive — pass exactly one): (1) role_label — the filer's original XBRL role string (e.g. 'CONSOLIDATED STATEMENTS OF OPERATIONS' for AAPL; varies per filer); tiered 28/48 credits. (2) statement_type — canonical statement name (e.g. 'Income Statement', 'Balance Sheet', 'Comprehensive Income', 'Stockholders Equity', 'Cash Flow Statement'), 28 credits; available for SEC filings only (other jurisdictions coming soon — use role_label for those). The 5 main statements also have dedicated tools: get_income_statement, get_comprehensive_income, get_balance_sheet, get_cash_flow_statement, get_equity_statement. Use list_filing_statements first to discover what statement_type / role_label values a particular filing actually has. Scope the filing with filing_id OR ticker + fiscal_year (+ optional quarter); form_type defaults to 10-K — pass 20-F or 40-F for foreign issuers; Korean (DART) filings use 10-K / 10-Q. Response shape: {matches: [{block_index, role_label, statement_type, matched_via, block}, ...]}; matches is length 1 for role_label mode, 0..N for statement_type mode (0 → 404). light_weight_mode=true omits block.child_components and a few verbose per-fact fields — saves context when you already know exactly what you need. Charged identically. POST /api/v1/data/statement; FINANCIAL_API_DOCUMENTATION.md.
get_income_statementReturn the filing's Income Statement (Statement of Operations) — its extracted line items with values and periods. Identify the filing with filing_id, or ticker + fiscal_year (+ optional quarter). A fixed shortcut for get_filing_statement(statement_type='Income Statement'); it does not take role_label or statement_type, and returns 404 when the filing has no income statement. Available for SEC filings only — other jurisdictions coming soon. 28 credits, debited even when the filing is missing, has no such statement, or is not an SEC filing; set light_weight_mode=true for a leaner payload. POST /api/v1/data/income-statement; FINANCIAL_API_DOCUMENTATION.md.
get_comprehensive_incomeReturn the filing's Statement of Comprehensive Income — its extracted line items with values and periods. Identify the filing with filing_id, or ticker + fiscal_year (+ optional quarter). A fixed shortcut for get_filing_statement(statement_type='Comprehensive Income'); it does not take role_label or statement_type, and returns 404 when the filing has no comprehensive-income statement. Available for SEC filings only — other jurisdictions coming soon. 28 credits, debited even when the filing is missing, has no such statement, or is not an SEC filing; set light_weight_mode=true for a leaner payload. POST /api/v1/data/comprehensive-income; FINANCIAL_API_DOCUMENTATION.md.
get_balance_sheetReturn the filing's Balance Sheet — its extracted line items with values and periods. Identify the filing with filing_id, or ticker + fiscal_year (+ optional quarter). A fixed shortcut for get_filing_statement(statement_type='Balance Sheet'); it does not take role_label or statement_type, and returns 404 when the filing has no balance sheet. Available for SEC filings only — other jurisdictions coming soon. 28 credits, debited even when the filing is missing, has no such statement, or is not an SEC filing; set light_weight_mode=true for a leaner payload. POST /api/v1/data/balance-sheet; FINANCIAL_API_DOCUMENTATION.md.
get_cash_flow_statementReturn the filing's Cash Flow Statement — its extracted line items with values and periods. Identify the filing with filing_id, or ticker + fiscal_year (+ optional quarter). A fixed shortcut for get_filing_statement(statement_type='Cash Flow Statement'); it does not take role_label or statement_type, and returns 404 when the filing has no cash flow statement. Available for SEC filings only — other jurisdictions coming soon. 28 credits, debited even when the filing is missing, has no such statement, or is not an SEC filing; set light_weight_mode=true for a leaner payload. POST /api/v1/data/cash-flow-statement; FINANCIAL_API_DOCUMENTATION.md.
get_equity_statementReturn the filing's Statement of Stockholders' (or Shareholders') Equity — its extracted line items with values and periods. Identify the filing with filing_id, or ticker + fiscal_year (+ optional quarter). A fixed shortcut for get_filing_statement(statement_type='Stockholders Equity'); it does not take role_label or statement_type, and returns 404 when the filing has no equity statement. Available for SEC filings only — other jurisdictions coming soon. 28 credits, debited even when the filing is missing, has no such statement, or is not an SEC filing; set light_weight_mode=true for a leaner payload. POST /api/v1/data/equity-statement; FINANCIAL_API_DOCUMENTATION.md.
list_filing_statementsDiscovery: list every statement block for one filing with its block_index, statement_type (list of canonical statement names; more than one when the block combines several statements; null for non-financial header blocks) and role_label (filer-specific XBRL string). Scope: filing_id OR ticker + fiscal_year (+ optional quarter). 10 credits flat. Follow with get_filing_statement to see the exact row labels a statement uses. POST /api/v1/data/filing-statements; FINANCIAL_API_DOCUMENTATION.md.
get_dimensional_breakdown_by_fact_idReturn one consolidated fact plus every slice fact it breaks down into. Slice facts are grouped by the set of XBRL axes their dimensions sit on. Scope: filing_id OR ticker + fiscal_year (+ optional quarter). recursive defaults to true; set recursive=false to return only the immediate children. Pricing: ceil((1+N)/5)×10 where N = returned slice facts (the root counts as one fact in the same batch). Returns 404 (still charged 10 credits) when fact_id is not in this filing. POST /api/v1/data/facts/dimensional-breakdown; FINANCIAL_API_DOCUMENTATION.md.
get_dimensional_breakdown_by_line_itemResolve a line-item name (e.g. 'revenue', 'net income') and return the dimensional breakdown of every consolidated fact that matches. Each match is one root with axis-grouped slice facts. Multi-concept matches come pre-ordered (Akkru smart ranking); the order is a recommendation only — review all matches and judge which one you need. duplicate_root_fact_ids lists other fact_id values that resolved to the same logical fact as root. Scope: filing_id OR ticker + fiscal_year (+ optional quarter). recursive defaults to true. Pricing: tier credit (10–50 by match tier) + ceil(N/5)×10 for returned slice facts across roots; partial billing applies. POST /api/v1/data/line-items/dimensional-breakdown; FINANCIAL_API_DOCUMENTATION.md.
compare_line_itemsCompare the same set of line-item names (revenue, net income, etc.) across multiple filings. filings: array of identity rows — each uses filing_id OR ticker + form_type + fiscal_year (+ optional quarter). form_type per row accepts 10-K / 10-Q / 20-F / 40-F, so peer comparisons can mix US and foreign issuers. line_items: required non-empty list; resolved through L0–L3 (per-item tier × number of filings pricing). Each fact in every row carries `_resolution_level` ("L0"-"L3") indicating which tier matched. Returns consolidated totals only — same as query_line_items; for dimension slice values use the dimensional-breakdown tools or get_filing_statement per filing. light_weight_mode=true omits results[*].facts[*].dimensional_breakdowns across every row — saves context when you already know exactly what you need. Charged identically. Good for YoY or peer period alignment by named line items. If unsure what a filing calls a line item, list_filing_statements + get_filing_statement show its exact row labels. Multi-concept matches come pre-ordered (Akkru smart ranking); the order is a recommendation only — review all returned results and judge which one you need. Each results[i] may include a `caveat` field; per-row caveats are auto-aggregated and deduplicated into top-level `_warnings` — read either, and surface to the user when present. Pro+ responses add a per-result `classification` block (canonical sector(s) + source); omitted for sub-Pro. POST /api/v1/data/compare/line-items; FINANCIAL_API_DOCUMENTATION.md.
compare_factsCompare specific XBRL fact_ids across multiple filings. Each row supplies its own fact_ids list, so different filings can compare different ids (e.g. when concept tagging changed between years). filings: array of rows — each uses filing_id OR ticker + form_type + fiscal_year (+ optional quarter), plus a required non-empty fact_ids list. Pricing: ceil(total_deduped_fact_ids / 5) × 10 across the whole request. light_weight_mode=true drops dimensional_breakdowns from all results — saves context when you already know exactly what you need. Each results[i] may include a `caveat` field; per-row caveats are auto-aggregated and deduplicated into top-level `_warnings` — read either, and surface to the user when present. Pro+ responses add a per-result `classification` block (canonical sector(s) + source); omitted for sub-Pro. POST /api/v1/data/compare/facts; FINANCIAL_API_DOCUMENTATION.md.
get_filing_excelObtain a short-lived download URL for the SEC-derived Excel attachment for one filing. 300 credits; only use when the user explicitly needs the spreadsheet. Requires filing_id; prefer checking has_excel from list_filings first. GET /api/v1/data/filings/{filing_id}/excel; FINANCIAL_API_DOCUMENTATION.md.
list_metric_snapshotsDiscover computed metric snapshots for a ticker: returns metric_group_id entries (and filing metadata) you feed into get_metrics_bundle or get_metrics_subset. Required: ticker. You must supply at least one of fiscal_year or a valid as_of_date (YYYY-MM-DD). Optional: form_types (list — accepts 10-K / 10-Q / 20-F / 40-F; omit to include every form for the ticker), quarter. Use this when the user wants metrics but you only know ticker/year or as-of date. Results may be truncated by your plan's history window or coverage scope — check `_warnings`. Companies outside your plan's coverage scope return 403 PLAN_TIER_INSUFFICIENT_COVERAGE. Computed metrics exist for US (SEC) companies only; other jurisdictions fail fast (400 METRICS_UNSUPPORTED_FOR_<jurisdiction>) with no credits charged. 10 credits. POST /api/v1/metric/filings; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
get_metrics_bundleReturn the full metrics bundle for one metric_group_id (all computed ratios and line-backed metrics for that filing-period snapshot). These are precomputed metrics, not XBRL facts — for individual line-item values use query_line_items or get_filing_facts. The response always includes both a filing-date price block and a realtime price block; the realtime block returns a hint when current_price is omitted. If you only need the filing-date computation, call get_metrics_bundle_filing_date instead. Call list_metric_snapshots first to obtain metric_group_id. Optional: accept_suggested_formula and formula_override for user-formula metrics (per API rules), as_of_date, current_price (USD; supply to compute realtime price-sensitive ratios; must be > 0, ≤ 10,000,000, ≤ 4 decimal places; omit to receive a hint in the realtime block instead), current_fx_rate (optional fallback FX rate used only when an up-to-date conversion rate is temporarily unavailable on foreign-issuer filings; > 0, ≤ 1,000,000, ≤ 6 decimal places), light_weight_mode (bool, default false; strip per-metric audit fields to reduce payload size). 148 credits. POST /api/v1/metric/all; see FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
get_metrics_bundle_filing_dateLike get_metrics_bundle but returns only the filing-date price-sensitive block — no realtime computation. **current_price / current_fx_rate are not accepted on this endpoint**; if you include them you'll get a warning in the response and they'll be ignored — call get_metrics_bundle (regular /metric/all) instead when you need realtime metrics. Same 148 credits. Use this when you don't need today's market price (analyzing historical filings, batch loads, or any case where current stock price is irrelevant). Optional: accept_suggested_formula, formula_override, as_of_date, light_weight_mode (bool, default false; strip per-metric audit fields to reduce payload size). POST /api/v1/metric/all/filing-date; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
get_metrics_subsetFetch a subset of computed metrics for one metric_group_id (same 148 credits as get_metrics_bundle; use it to keep the response small when you already know the names). metric_names must be ids from the metric catalog (e.g. gross_margin — not /data/facts labels like Revenue). Partial success: valid names are returned; unknown or unavailable names are listed in _metric_name_errors with _supported_metric_names (comma-separated, 9 ids per line) when anything failed to match. Same optional flags as get_metrics_bundle, plus light_weight_mode (bool, default false; strip per-metric audit fields to reduce payload size). POST /api/v1/metric/items; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
get_profitability_metricsMargins and return ratios (16 metrics): gross_margin, operating_margin, net_margin, ebitda_margin, return_on_equity, return_on_assets, return_on_invested_capital, return_on_tangible_equity, fcf_margin, nopat, nopat_reported_oi_proxy, nopat_margin, return_on_net_operating_assets, owner_earnings_estimate, owner_earnings_cash_proxy, owner_earnings_per_share. Flat 148-credit cost. Use when the user asks about profitability without naming a specific metric. POST /api/v1/metric/profitability; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
get_growth_metricsGrowth rates (15 metrics): revenue_growth_yoy, revenue_growth_qoq, revenue_growth_qoq_single_quarter, eps_growth_yoy, net_income_growth_yoy, fcf_growth_yoy, revenue_cagr_3y, revenue_cagr_5y, revenue_cagr_10y, diluted_eps_cagr_3y, diluted_eps_cagr_5y, diluted_eps_cagr_10y, shares_outstanding_cagr_3y, shares_outstanding_cagr_5y, shares_outstanding_cagr_10y. Flat 148-credit cost. POST /api/v1/metric/growth; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
get_financial_health_metricsLeverage and liquidity ratios (11 metrics): debt_to_equity, debt_to_assets, debt_to_ebitda, interest_coverage, current_ratio, quick_ratio, cash_ratio, net_debt, net_debt_to_ebitda, net_financial_obligations, net_financial_expense_after_tax. Flat 148-credit cost. POST /api/v1/metric/financial-health; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
get_efficiency_metricsTurnover ratios and working-capital days (10 metrics): asset_turnover, inventory_turnover, receivables_turnover, days_inventory, days_receivable, days_payable, cash_conversion_cycle, payables_turnover, net_operating_assets, net_operating_asset_turnover. Flat 148-credit cost. POST /api/v1/metric/efficiency; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
get_cash_flow_metricsCash-flow metrics (18 metrics): free_cash_flow, fcf_margin, payout_ratio, free_cash_flow_per_share, free_cash_flow_after_sbc, fcf_ex_sbc_addback, free_cash_flow_cagr_3y, free_cash_flow_cagr_5y, free_cash_flow_cagr_10y, free_cash_flow_per_share_cagr_3y, free_cash_flow_per_share_cagr_5y, free_cash_flow_per_share_cagr_10y, cfo_to_net_income, fcf_to_net_income, cash_distributions_to_fcf, common_dividend_burden_on_group_fcf, sbc_to_revenue, sbc_to_fcf. fcf_margin also appears in get_profitability_metrics. Flat 148-credit cost. POST /api/v1/metric/cash-flow; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
get_valuation_metricsAll 13 price-sensitive valuation ratios: market_cap, enterprise_value, pe_ratio, price_to_book, price_to_sales, price_to_cash_flow, ev_to_ebitda, ev_to_revenue, ev_to_fcf, fcf_yield, dividend_yield, buyback_yield, owner_earnings_yield. Returns both realtime (from optional current_price) and filing-date price blocks. Same 148-credit flat cost. For the filing-date block only, use get_valuation_metrics_filing_date instead. POST /api/v1/metric/valuation; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
get_valuation_metrics_filing_dateSame 13 valuation ratios as get_valuation_metrics but **filing-date only** — no realtime computation, no current_price / current_fx_rate accepted. Use when you only need the historical filing-date snapshot (analyzing past filings, batch loads). Same 148-credit flat cost. Optional: light_weight_mode (bool, default false; strip per-metric audit fields to reduce payload size). POST /api/v1/metric/valuation/filing-date; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
get_metrics_timeseriesTime series of metrics for a ticker across many periods (quarterly or annual). Use for trends like gross margin or revenue over time, with paging. Required: ticker. period_type is quarterly or annual (default quarterly). period_type=annual covers 10-K plus foreign-issuer annual forms (20-F, 40-F); period_type=quarterly covers 10-Q (foreign issuers have no quarterly counterpart); Korean (DART) filings use the same form types (annual = 10-K, quarterly = 10-Q). Optional: start_period_start, end_period_end, metric_names, as_of_date, accept_suggested_formula, formula_override, sort (period_end_asc|period_end_desc), page, page_size (1–5), light_weight_mode (bool, default false; strip per-metric audit fields to reduce payload size). Results may be truncated by your plan's history window or coverage scope — check `_warnings`. Companies outside your plan's coverage scope return 403 PLAN_TIER_INSUFFICIENT_COVERAGE. Computed metrics exist for US (SEC) companies only; other jurisdictions fail fast (400 METRICS_UNSUPPORTED_FOR_<jurisdiction>) with no credits charged. POST /api/v1/metric/historical; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
search_stocksScreen companies by a filter DSL over the 82-metric catalog. Required: where={filter:{...}, sort_by?, sort_order?}. Filter supports leaves {metric, op, value, for_latest|for_consecutive|for_at_least?} and composites and/or/not. Operators: >, >=, <, <=, between. Temporal modifiers (mutex per leaf): for_latest N (latest N pass), for_consecutive N (any N adjacent pass), for_at_least N (>= N within lookback pass). Optional: as_of_date, lookback (1-120), include_quarterly, tickers (whitelist, <=100), exclude_tickers, usd_only, sectors (Pro+ — filter the universe to canonical sector buckets; names from list_screener_filters.sectors), include_metrics_using_filing_date_price (gates 13 valuation ratios), exclude_derivations, include_metrics (<=10 extra columns), group_by_ticker (default true), page, page_size (<=100; page*page_size <=500). Dynamic credit cost per request (89-1825). Pre-run list_screener_filters once to discover supported metric ids + operators. `lookback` is auto-clamped to your plan's history window so you are only billed for the portion you can access; when clamped, `_warnings` is populated. Companies outside your plan's coverage scope are also silently excluded; `_warnings` is populated when this happens. Pro+ results carry a per-row `classification` block (canonical sector(s) + source). POST /api/v1/screener/metrics; FINANCIAL_API_DOCUMENTATION.md. Requires the Pro plan or higher.
list_screener_filtersCatalog of supported screener inputs: 82 metric names (with unit + price_sensitive flag), operators, temporal modifiers, form types, derivations, plus one complete example_request. Run this before constructing a search_stocks call to discover legal metric ids. Pro+ responses also include a `sectors` list (the 12 canonical sector buckets the search_stocks `sectors` filter accepts). 10 credits per call. GET /api/v1/screener/metrics/filters; FINANCIAL_API_DOCUMENTATION.md. Requires the Pro plan or higher.
list_insider_transactionsInsider-trade filings and their transactions, nested filing -> transactions. Requires ticker and/or insider_cik; for unanchored screening use search_insider_trades. Each filing carries issuer_cik (compare it with the company CIK from list_insider_tickers to confirm the filing belongs to that company), insiders, footnotes and source_url_prefix. Read direction from each transaction's acquired_disposed_code (A/D), never from transaction_code. A transaction carries a split_adjusted block only when its filed shares/price are not on the current per-share basis; use that block to compare across a corporate action. data_quality_flags appears only on rows that fail a consistency check; rows that fail one are withheld unless include_anomalies=true, and anomalies_excluded_on_page says how many this page withheld (page-scoped, unlike the whole-range anomalies_excluded_count on get_insider_stats). Joint filings name several insiders with no per-transaction attribution and are reported in _warnings. Results are limited to your plan's history window, which _warnings reports. A ticker outside your plan's company coverage returns 403 PLAN_TIER_INSUFFICIENT_COVERAGE and is still charged; an insider_cik-only query filters those companies out and says so in _warnings. 30 credits per page. POST /api/v1/ownership/transactions; FINANCIAL_API_DOCUMENTATION.md.
get_insider_statsTotals over one company and/or one insider, plus transaction_ids for every contributing row (feed those to get_insider_transactions_by_id for the detail; transaction_ids is paged by ids_page / ids_page_size — 200 per page by default, 1000 max — while ids_total and ids_has_more describe the whole set, and get_insider_transactions_by_id accepts at most 100 ids per call). Requires ticker and/or insider_cik. Key names inside stats follow method: acquired/disposed for "ad", bought/sold for "ps". Value totals count transactions with no cash price as 0. Share totals and average prices use the adjusted basis and exclude rows whose shares field holds a debt principal amount. corporate_action_crossing is true when the window spans a corporate action. corporate_actions is returned only when anchored on a ticker that has corporate actions on file. Whenever transactions were excluded, skipped or have no cash value, _warnings states the count and the parameter that changes it — read _warnings before using any total. start_date_applied / as_of_date_applied echo the window actually used; results are limited to your plan's history window. A ticker outside your plan's company coverage returns 403 PLAN_TIER_INSUFFICIENT_COVERAGE and is still charged. 40 credits + 5 per 1000 participating transactions. POST /api/v1/ownership/stats; FINANCIAL_API_DOCUMENTATION.md.
get_insider_transactions_by_idDetail companion to get_insider_stats: pass the transaction_ids it returned and get the same filing-nested shape as list_insider_transactions. Duplicate ids are removed and reported in _warnings; ids that do not exist come back in missing_ids and the call still succeeds unless every id is missing. Ids that exist but fall outside your plan's scope come back in restricted_ids (403 when that is true of every id found). Both are charged for. ceil(n/5) x 10 credits on the deduplicated id count (max 200). POST /api/v1/ownership/transaction-ids; FINANCIAL_API_DOCUMENTATION.md.
search_insider_tradesScreen insider trades across the whole library: trade-level conditions in trade_filters plus company-level gates in aggregate_filters. Operators for both: >, >=, <, <=, between ([lo, hi]). Returns the matching transactions themselves — grouped by ticker (default) or flat. In grouped mode txn_count is the company's full hit count, not the page's. Every row carries issuer_cik, accession_number, filing_date, source_url_prefix, insiders and a computed block (shares_owned_before, own_pct_change) whose entries state value, status and the inputs used. Filter on split_adjusted_shares / split_adjusted_price rather than the filed shares / price_per_share when the window spans a corporate action. page x page_size <= 500. Dynamic credit cost 65-920, charged even when the result set is empty and on a 504 timeout. Requires the Pro plan or higher; results are limited to your plan's history window and company coverage. POST /api/v1/screener/ownership; FINANCIAL_API_DOCUMENTATION.md.
list_insider_tickersEvery ticker that has insider-trade (Form 4) and/or initial-holdings (Form 3) data, with its jurisdiction, SEC CIK and a forms array saying which of the two it has. Unpaginated — cache it. Use the returned cik to verify a filing's issuer_cik. Limited to your plan's company coverage. 175 credits. GET /api/v1/ownership/tickers; FINANCIAL_API_DOCUMENTATION.md.
list_company_insidersAll insiders of one company, one row per SEC CIK, aggregated over its Form 4 and Form 3 filings: filing_count (total) plus form4_filing_count / form3_filing_count, identity flags and date range. A director who has only filed a Form 3 is listed. Use it to resolve a person to the insider_cik that list_insider_transactions, get_insider_stats and list_initial_holdings take. This endpoint aggregates across every filing, so the relationship filter takes ever_* values and means 'ever reported in this role'; the per-filing is_* form belongs to get_insider_stats and search_insider_trades. owner_name is the spelling on that insider's most recent filing; when name_changed is true a caveat notes that earlier filings spelled it differently. latest_officer_title is the most recent non-null title and officer_title_as_of is the filing date it came from. Counts and date ranges cover only the filings inside your plan's history window. A ticker outside your plan's company coverage returns 403 PLAN_TIER_INSUFFICIENT_COVERAGE and is still charged. 30 credits. POST /api/v1/ownership/names; FINANCIAL_API_DOCUMENTATION.md.
list_initial_holdingsInitial beneficial-ownership statements (SEC Form 3) and the holdings they report, nested filing -> holdings. A Form 3 is what an insider files on becoming an insider: positions, not trades — there is no transaction date, code, price or direction. Requires ticker and/or insider_cik; for unanchored screening use search_initial_holdings. Each filing carries no_securities_owned (true means the filer reported holding nothing and the holdings array is empty), issuer_cik, insiders, footnotes and source_url_prefix. Non-derivative rows carry shares_owned; derivative rows carry underlying_security_shares / underlying_security_value instead. A holding carries a split_adjusted block only when its filed amounts are not on the current per-share basis. data_quality_flags appears only on rows that fail a consistency check; such rows are withheld unless include_anomalies=true, and anomalies_excluded_on_page says how many this page withheld. Joint filings name several insiders and are reported in _warnings. Results are limited to your plan's history window, which _warnings reports. A ticker outside your plan's company coverage returns 403 PLAN_TIER_INSUFFICIENT_COVERAGE and is still charged. 30 credits per page. POST /api/v1/ownership/initial-holdings; FINANCIAL_API_DOCUMENTATION.md.
get_initial_holdings_by_idFull holding rows for up to 100 holding ids, nested under their filings — the companion of get_initial_holding_stats, whose holding_ids list says which rows a figure was built from. Ids that do not exist are listed in missing_ids; ids outside your plan's scope in restricted_ids; only when none exist does it return 404 OWNERSHIP_HOLDING_NOT_FOUND. ceil(n/5) x 10 credits on the deduplicated id count (max 200). POST /api/v1/ownership/initial-holding-ids; FINANCIAL_API_DOCUMENTATION.md.
get_initial_holding_statsAggregates over Form 3 filings in a filing-date window: filing_count, no_securities_filing_count, distinct_insiders, filings_with_multiple_filers, holdings_count (with non-derivative / derivative split), shares_owned_total (non-derivative rows, current adjusted basis) and underlying_shares_total (derivative rows, current adjusted basis) — two different units, not to be added together — plus earliest/latest_filing_date and corporate_action_crossing. Filing counts include filings that report no holdings. Read _warnings before using any total. holding_ids (paged) lists the rows the holding totals were built from; fetch them with get_initial_holdings_by_id. A ticker outside your plan's company coverage returns 403 PLAN_TIER_INSUFFICIENT_COVERAGE and is still charged. 40 credits + 5 per 1000 participating holdings. POST /api/v1/ownership/initial-holdings/stats; FINANCIAL_API_DOCUMENTATION.md.
search_initial_holdingsScreen Form 3 holdings across the whole library: holding-level conditions in holding_filters plus company-level gates in aggregate_filters. Operators for both: >, >=, <, <=, between ([lo, hi]). Returns the matching holdings themselves — grouped by ticker (default) or flat. In grouped mode holdings_count and shares_owned_total are the company's full hit values, not the page's. Every row carries issuer_cik, accession_number, filing_date, no_securities_owned, source_url_prefix and insiders. Filings that report no holdings have no rows here; they only enter the company-level filing_count / no_securities_filing_count gates. Filter on split_adjusted_shares_owned rather than shares_owned when the window spans a corporate action. page x page_size <= 500. Dynamic credit cost 65-920, charged even when the result set is empty and on a 504 timeout. Requires the Pro plan or higher; results are limited to your plan's history window and company coverage. POST /api/v1/screener/initial-holdings; FINANCIAL_API_DOCUMENTATION.md.
list_insider_transaction_typesThe 20 SEC insider-trade transaction codes with their official name and grouping, plus source_url for the SEC form the wording comes from. Run this to learn legal transaction_code values before filtering. A code does not imply direction — read acquired_disposed_code on each transaction. Free, no credits. GET /api/v1/ownership/transaction-types; FINANCIAL_API_DOCUMENTATION.md.
search_institutional_holdingsScreen SEC Form 13F institutional filings across the whole library: one row per manager-quarter with that quarter's headline numbers — total_positions_value (stock holdings value), total_derivatives_notional, cover_table_value (the cover-page total as filed), positions_count, derivatives_count, portfolio_value_qoq_pct, top1_security_pct / top10_security_pct (stock concentration), est_turnover, activity_counts, plus filing_date, accession, is_amended, confidential, is_combination_report, unit_multiplier and a ready-made sec_url. An empty body is the full listing by total_positions_value, descending. A quarter with no prior filed quarter to compare against has null qoq / turnover / activity_counts, so count conditions never match it. When the returned rows span more than one quarter, _warnings says so — the same manager can appear once per quarter. page x page_size <= 500. Dynamic credit cost 160-720 by request shape, charged even when the result set is empty. Requires the Pro plan or higher. POST /api/v1/screener/institutional-holdings; FINANCIAL_API_DOCUMENTATION.md. The URL opens the filing's EDGAR index page; see the files listed there for full details.
get_institutional_manager_historyOne institutional manager's 13F history: the same quarter rows as search_institutional_holdings, for one manager, newest first by default. Anchor with exactly one of cik / name; when no single manager matches the name it returns 404 OWNERSHIP_MANAGER_NOT_FOUND — several managers can file under the same or a similar name, so query by CIK. The response carries the manager's cik, name and sec_url_prefix once at the top; each quarter row carries period, filing_date, accession, the headline numbers and sec_url. A quarter with no prior filed quarter to compare against has null portfolio_value_qoq_pct, est_turnover and activity_counts. 30 credits flat; a 404 is still charged. POST /api/v1/ownership/institutional-holdings/manager-history; FINANCIAL_API_DOCUMENTATION.md. The URL opens the filing's EDGAR index page; see the files listed there for full details.
get_institutional_portfolioOne manager x one calendar quarter: the 13F holdings detail rows, under a quarter header that repeats the snapshot numbers and carries the amendment archive (accessions, sec_locators, amendments_merged, prior_versions). Rows mix three kinds told apart by each row's type: positions (stock rows with shares, value, weight, rank, avg_price and quarter-over-quarter deltas), derivatives (put_call, notional_value_usd, underlying_price_implied) and exited (positions closed out this quarter — identity plus the closing deltas only). weight is a percent string with two decimals, e.g. "61.88%". Read _warnings: they flag an amendment whose claimed action type differs from its actual action, unit-correction multipliers (see the unit_multiplier fields), CUSIP_CHANGE rows (see each row's predecessor_cusip and shares_before_cusip_change) and a quarter with no prior filed quarter to compare against (activity and the d_* deltas are null there — not everything is new). 30 credits per page; an unknown manager (404 OWNERSHIP_MANAGER_NOT_FOUND) or a quarter with no data (404 OWNERSHIP_MANAGER_QUARTER_NOT_FOUND) is still charged. POST /api/v1/ownership/institutional-holdings/portfolio; FINANCIAL_API_DOCUMENTATION.md. The URL opens the filing's EDGAR index page; see the files listed there for full details.
get_institutional_security_holdersOne security's 13F holder rows across managers, anchored by exactly one of cusip / ticker; an unknown security returns 404 OWNERSHIP_SECURITY_NOT_FOUND. The securities block describes each matched CUSIP (ticker, issuer_norm, security_type, first_seen / last_seen, latest_holders). Flat mode (default) returns the same detail rows as get_institutional_portfolio with manager_cik / manager_name added to each row; quarter, type, activity and sort_by narrow them. group_by_quarter=true returns one aggregate row per quarter instead — holders, total_shares, total_value over live stock rows — unpaged. Flat mode 30 credits per page; grouped 40 flat; a 404 is still charged. POST /api/v1/ownership/institutional-holdings/security; FINANCIAL_API_DOCUMENTATION.md. The URL opens the filing's EDGAR index page; see the files listed there for full details.
list_event_typesSupported corporate event Item codes and their official English titles, plus source_url. Use this to choose items for get_event_filing or search_events. 0 credits. Requires the Starter plan or higher. GET /api/v1/events/types; FINANCIAL_API_DOCUMENTATION.md.
list_event_filingsList one company's corporate event filings, newest first, with filing IDs, dates, Item lists and amendment status. Requires exactly one of ticker / cik. Use a returned id with get_event_filing to read the sections; use search_events for Item/date filters or searches across companies. Results are limited to your plan's history window; read _warnings for history notices and differing Item lists. 10 credits per page; empty pages and 404 EVENTS_COMPANY_NOT_FOUND are still charged. Requires the Starter plan or higher. POST /api/v1/events/filings; FINANCIAL_API_DOCUMENTATION.md.
get_event_filingRead one corporate event filing using an id from list_event_filings or search_events. Returns section summaries, source links, and available amendment and prior-summary history. items selects sections only; filing metadata and amendment history remain complete. Set include_original_raw_text=true to include the complete original text at no extra cost, include_exhibits=true to include the filing's attachments and their text, as_of_date=YYYY-MM-DD to read the filing only if it was filed by then (404 EVENTS_FILING_NOT_YET_FILED otherwise). Read _warnings for omitted sections, differences between items and items_declared, and unresolved amendments. 30 credits per call; no matching sections, 404 EVENTS_FILING_NOT_FOUND and 403 PLAN_TIER_INSUFFICIENT_HISTORY are still charged. Requires the Starter plan or higher. POST /api/v1/events/filing; FINANCIAL_API_DOCUMENTATION.md.
search_eventsScreen corporate events across companies and filing dates. Returns filings with matching section summaries, source links and amendment status, newest first; original text and amendment history are not included. Dates filter filing_date; summaries include available amendments, as_of_date bounds filing_date like end_date, with no start. Use list_event_types to choose Item codes, and get_event_filing with a returned id for the complete filing. Default 5 filings per page, maximum 10; page x page_size <= 500. Results are limited to your plan's history window. Dynamic credit cost 65-280 per page, charged even when the result set is empty and on a 504 timeout. Requires the Pro plan or higher. POST /api/v1/screener/events; FINANCIAL_API_DOCUMENTATION.md.
纠错与举报（发现条目失效、署名有误或涉及侵权？）
提交举报 / 纠错

侵权举报经核验成立后，我们会即时下线该条目并删除已存的内容副本。