Skip to Content
Tool ReferenceOverview

Tool Reference

The tool surface is generated from the launch manifest. Each page includes the contract version, route or MCP binding, parameters, and response schema.

XBRL Facts And Concepts

  • Financials - Return the full structured XBRL financial fact payload for one filing period.
  • Metric - Return one discovered metric or XBRL tag with current, prior, and YoY values.
  • Metric Series - Return one metric across multiple periods with per-period cache and coverage status.
  • List Metrics - List exact metric candidates available in one filing period.
  • Search Metrics - Search filing metrics by natural-language query and return ranked exact candidates.
  • Statement - Return a template-backed income statement, balance sheet, or cash flow statement from cached concepts.
  • Concept - Resolve one registry-backed financial concept from cached filing facts.
  • Compare Concept - Compare one registry-backed concept across a caller-provided ticker set.
  • Concept Trend - Return a cache-only concept time series across a requested period range.
  • Cite Concept - Join a registry-backed concept value to filing prose and optional extraction evidence.
  • Warm Metric Cache - Queue paid-tier background warming for metric periods before follow-up reads.
  • Warm Metric Cache Status - Poll a background cache-warming job returned by warm_metric_cache.
  • Tag Equivalence Registry - Return registry-backed XBRL tag equivalence groups for client taxonomy alignment.

Filing Metadata And Documents

  • Filings - Return filing metadata and SEC accession details for one ticker period.
  • Event Filings - Discover event filings by ticker, CIK, date range, form type, or query.
  • Describe Filing - Show cached availability for financials, sections, tables, markdown, and extractions for one filing.
  • Filing Document - Return a readable markdown filing document with section filtering and pagination.
  • Filing Sections - Extract selected qualitative filing sections and optional embedded tables.
  • Filing Cover Facts - Return exact DEI cover-page facts such as shares outstanding with citations.
  • Filing Evidence - Plan and retrieve citation-ready filing evidence for qualitative SEC questions.

Structured Filing Tables

Filing Text Search

  • Search Filing Text - Search cached markdown within one filing and return matching spans.
  • Filing Extractions - Return cached langextract spans for one filing or run paid extraction on cache miss.
  • Search Extractions - Search cached langextract spans across filings with structured filters.
  • Extraction Series - Return periodized counts and optional hits for cached langextract spans.
  • Extract Filing File - Ingest a trusted local markdown filing and run a selected extraction schema.
  • List Extraction Schemas - List document extraction schemas available to the internal document API.

Operational KPIs

XBRL Facts And Concepts