finance-query v3.0.0

finance-query-mcp MCP tools#

Generated by cargo soothfast spec html from mcp-tools.json (MCP tool manifest). Regenerate with cargo soothfast spec gen + spec html; do not hand-edit.

63 tool(s).

get_analysisGet analyst data for a stock: recommendation trends, upgrades/downgrades, earnings estimates, or earnings history.

Arguments

{
  "analysis_type": "recommendations",
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
analysis_typeAnalysisTyperequiredAnalysis type: recommendations | upgrades-downgrades | earnings-estimate | earnings-history
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
symbolstringrequiredStock ticker symbol

Types

AnalysisType

one of: "recommendations", "upgrades-downgrades", "earnings-estimate", "earnings-history"

get_calendarGet a time-sorted calendar of upcoming financial events (earnings with estimates, ex-dividend and dividend-payment dates, options expirations, and — when FRED is configured — market-wide economic releases) across multiple symbols. Answers 'what's coming up for my portfolio?' in one call.

Arguments

{
  "fields": "string",
  "range": "1d",
  "symbols": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
rangeTimeRangeoptionalForward time window: 1d|5d|1mo|3mo|6mo|1y|2y|5y|10y|ytd|max (default: 1mo)
symbolsstringrequiredComma-separated list of ticker symbols (e.g., "AAPL,MSFT,TSLA")

Types

TimeRange

one of: "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max"

get_chartGet historical OHLCV candlestick chart data for one or more stock symbols (comma-separated). A single symbol supports start/end absolute timestamps and returns one chart; multiple symbols return a batch of charts plus per-symbol errors (interval/range only, no start/end).

Arguments

{
  "cursor": "string",
  "end": 0,
  "fields": "string",
  "interval": "1m",
  "limit": 0,
  "range": "1d",
  "start": 0,
  "symbols": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
endintegeroptionalEnd date as Unix timestamp (seconds). Defaults to now when `start` is set.
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
intervalIntervaloptionalCandle interval: 1m|5m|15m|30m|1h|1d|1wk|1mo|3mo (default: 1d)
limitintegeroptionalMaximum candles per page; omitted = curated default (25)
rangeTimeRangeoptionalTime range: 1d|5d|1mo|3mo|6mo|1y|2y|5y|10y|ytd|max (default: 1mo). Ignored when `start` is set.
startintegeroptionalStart date as Unix timestamp (seconds). When provided, overrides `range`.
symbolsstringrequiredOne or more comma-separated ticker symbols (e.g., "AAPL" or "AAPL,MSFT,GOOG")

Types

Interval

one of: "1m", "2m", "5m", "15m", "30m", "1h", "90m", "1d", "5d", "1wk", "1mo", "3mo"

TimeRange

one of: "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max"

get_commodityGet a commodity's current quote (e.g. gold, silver, crude oil), provider-routed (Yahoo, keyless).

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
symbolstringrequiredCommodity symbol (e.g. "GCUSD" for gold, "CLUSD" for crude oil)
get_company_profileA company's identity/classification profile (name, description, asset type, exchange, currency, country, sector, industry, market capitalization).

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
symbolstringrequiredStock ticker symbol
get_congressional_tradesCongressional trading disclosures for a symbol, FMP when keyed and keyless House PTR filings otherwise.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
limitintegeroptionalMaximum entries per page; omitted = curated default (25)
symbolstringrequiredStock ticker symbol
get_cryptoGet top cryptocurrency coins by market cap from CoinGecko (no API key required).

Arguments

{
  "count": 0,
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "vs_currency": "string"
}
fieldtyperequireddescription
countintegeroptionalNumber of top coins to return (default: 50, max: 250)
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
limitintegeroptionalMaximum coins per page; omitted = curated default (25)
vs_currencystringoptionalQuote currency (default: usd)
get_crypto_newsMarket-wide crypto news (currently FMP only, requires FMP_API_KEY).

Arguments

{
  "count": 0,
  "cursor": "string",
  "fields": "string",
  "limit": 0
}
fieldtyperequireddescription
countintegeroptionalOverall cap on articles fetched (default: 20)
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
limitintegeroptionalMaximum articles per page; omitted = curated default (25)
get_dividendsGet dividend history for one or more dividend-paying stocks (comma-separated symbols). A single symbol returns paginated dividend history plus analytics (CAGR, average payment, payout count); multiple symbols return a batch of dividend histories plus per-symbol errors (no analytics for batch).

Arguments

{
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "range": "1d",
  "symbols": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
limitintegeroptionalMaximum dividend payments per page; omitted = curated default (25)
rangeTimeRangeoptionalTime range: 1y|2y|5y|10y|max (default: max)
symbolsstringrequiredOne or more comma-separated ticker symbols (e.g., "AAPL" or "AAPL,KO,JNJ")

Types

TimeRange

one of: "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max"

get_earnings_surprisesA stock's earnings-surprise history (actual vs. estimated EPS).

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
symbolstringrequiredStock ticker symbol
get_earnings_transcriptAn earnings call transcript for a symbol, latest when quarter and year are omitted.

Arguments

{
  "fields": "string",
  "quarter": "Q1",
  "symbol": "string",
  "year": 0
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
quarterQuarteroptionalFiscal quarter (Q1, Q2, Q3, Q4). Required alongside `year` for providers with no "latest" shortcut (Alpha Vantage); Yahoo defaults to latest when omitted
symbolstringrequiredStock ticker symbol
yearintegeroptionalFiscal year. See `quarter`

Types

Quarter

one of: "Q1", "Q2", "Q3", "Q4"

get_edgar_factsGet SEC EDGAR XBRL structured financial data (all reported accounting concepts) for a company. Requires EDGAR_EMAIL env var.

Arguments

{
  "concepts": "string",
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "symbol": "string",
  "taxonomy": "string"
}
fieldtyperequireddescription
conceptsstringoptionalComma-separated XBRL concept names to filter to (e.g. "Revenues,Assets"); omitted = curated defaults (headline financials)
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated GraphQL sub-fields to include per concept (e.g. "concept,dataPoints"); omitted = curated default set
limitintegeroptionalMaximum data points per concept per page; omitted = curated default (25). Applied uniformly across every returned concept.
symbolstringrequiredStock ticker symbol (e.g., "AAPL", "MSFT", "TSLA")
taxonomystringoptionalXBRL taxonomy (default: "us-gaap"); also try "ifrs-full" or "dei"
get_edgar_searchFull-text search across SEC EDGAR filings with optional form type and date filters. Requires EDGAR_EMAIL env var.

Arguments

{
  "end_date": "string",
  "forms": "string",
  "from": 0,
  "query": "string",
  "size": 0,
  "start_date": "string"
}
fieldtyperequireddescription
end_datestringoptionalEnd date filter in YYYY-MM-DD format
formsstringoptionalComma-separated form types to filter (e.g., "10-K,10-Q,8-K")
fromintegeroptionalPagination offset; omitted = 0 (first page)
querystringrequiredSearch query (keywords in filing text)
sizeintegeroptionalPage size; omitted = 100, max 100
start_datestringoptionalStart date filter in YYYY-MM-DD format
get_edgar_submissionsGet SEC filing history and company metadata from EDGAR (up to 1000 most recent filings). Requires EDGAR_EMAIL env var.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
limitintegeroptionalMaximum filings per page; omitted = curated default (25)
symbolstringrequiredStock ticker symbol (e.g., "AAPL", "MSFT", "TSLA")
get_etf_profileGet an ETF's profile and holdings (net assets, expense ratio, sector/country weightings, top holdings).

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
symbolstringrequiredETF ticker symbol
get_executive_compensationDisclosed executive compensation by year.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default
limitintegeroptionalMaximum entries per page; omitted = curated default (25)
symbolstringrequiredStock ticker symbol
get_fails_to_deliverFails-to-deliver records for a symbol, FMP when keyed and keyless EDGAR otherwise.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
limitintegeroptionalMaximum entries per page; omitted = curated default (25)
symbolstringrequiredStock ticker symbol
get_fear_and_greedGet the CNN Fear & Greed Index — market sentiment from extreme fear (0) to extreme greed (100).

Arguments

{
  "fields": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
get_feedsFetch RSS/Atom news from financial publishers (Bloomberg, WSJ, MarketWatch, FT, SEC, etc.).

Arguments

{
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "sources": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
limitintegeroptionalMaximum entries per page; omitted = curated default (25)
sourcesstringoptionalComma-separated feed sources: federal-reserve|sec|marketwatch|cnbc|bloomberg|ft|nyt| guardian|investing|bea|ecb|cfpb|wsj|fortune|businesswire|coindesk|cointelegraph| techcrunch|hackernews|oilprice|calculatedrisk|scmp|nikkei|boe|venturebeat|yc| economist|financialpost|ftlex|ritholtz (default: marketwatch, bloomberg, wsj, fortune)
get_filing_sectionsGet sectioned text of one SEC filing by accession number (10-K or 8-K). Routes through EDGAR (best-effort HTML extraction) or Polygon when configured.

Arguments

{
  "accession_number": "string",
  "fields": "string",
  "form": "ten-k",
  "symbol": "string"
}
fieldtyperequireddescription
accession_numberstringrequiredSEC accession number, e.g. "0000320193-24-000123"
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
formFilingSectionFormParamrequiredWhich filing form to fetch sectioned text for: ten-k | eight-k
symbolstringrequiredStock ticker symbol

Types

FilingSectionFormParam

one of: "ten-k", "eight-k"

get_financialsGet income statement, balance sheet, or cash flow statement for one or more stock symbols (comma-separated). A single symbol returns one statement; multiple symbols return a batch plus per-symbol errors.

Arguments

{
  "fields": "string",
  "frequency": "annual",
  "metrics": "string",
  "statement": "income",
  "symbols": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
frequencyFrequencyoptionalReporting frequency: annual | quarterly (default: annual)
metricsstringoptionalComma-separated list of line-item metrics to filter to; omitted = all reported metrics
statementStatementTyperequiredStatement type: income | balance | cashflow
symbolsstringrequiredOne or more comma-separated ticker symbols (e.g., "AAPL" or "AAPL,MSFT,GOOGL")

Types

Frequency

one of: "annual", "quarterly"

StatementType

one of: "income", "balance", "cashflow"

get_forexA currency pair's current exchange rate, provider-routed (Capability::FOREX).

Arguments

{
  "fields": "string",
  "from": "string",
  "to": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
fromstringrequiredBase currency code (e.g. "USD")
tostringrequiredQuote currency code (e.g. "EUR")
get_forex_newsMarket-wide forex news (currently FMP only, requires FMP_API_KEY).

Arguments

{
  "count": 0,
  "cursor": "string",
  "fields": "string",
  "limit": 0
}
fieldtyperequireddescription
countintegeroptionalOverall cap on articles fetched (default: 20)
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
limitintegeroptionalMaximum articles per page; omitted = curated default (25)
get_fred_seriesGet FRED macroeconomic time series data (e.g., FEDFUNDS, CPIAUCSL, GDP, UNRATE). Requires FRED_API_KEY env var.

Arguments

{
  "as_of": "string",
  "cursor": "string",
  "fields": "string",
  "id": "string",
  "limit": 0
}
fieldtyperequireddescription
as_ofstringoptionalVintage date (YYYY-MM-DD): the series as it stood then, before later revisions; omitted = latest
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
idstringrequiredFRED series ID (e.g., "FEDFUNDS", "CPIAUCSL", "GDP", "UNRATE")
limitintegeroptionalMaximum observations per page; omitted = curated default (25)
get_futuresGet a futures contract's current quote, provider-routed (Yahoo, keyless).

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
symbolstringrequiredFutures contract symbol (e.g. "ESM26" for E-mini S&P June 2026)
get_grading_actionsProvider-routed analyst upgrades and downgrades.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default
limitintegeroptionalMaximum entries per page; omitted = curated default (25)
symbolstringrequiredStock ticker symbol
get_holdersGet ownership data for a stock: major holders, institutional/fund ownership, or insider activity.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "holder_type": "major",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
holder_typeHolderTyperequiredHolder type: major | institutional | mutualfund | insider-transactions | insider-purchases | insider-roster
limitintegeroptionalMaximum entries per page for holder types with a list (institutional, mutualfund, insider-transactions, insider-roster); omitted = curated default (25). No-op for major/insider-purchases (no list).
symbolstringrequiredStock ticker symbol

Types

HolderType

one of: "major", "institutional", "mutualfund", "insider-transactions", "insider-purchases", "insider-roster"

get_index_constituent_changesAdditions and removals from an index's constituent list.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
limitintegeroptionalMaximum entries per page; omitted = curated default (25)
symbolstringrequiredIndex symbol (e.g. ^GSPC)
get_index_constituentsGet an index's current constituent list, provider-routed (Wikipedia, S&P 500 only).

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
symbolstringrequiredIndex symbol (e.g. "^GSPC" for the S&P 500; Wikipedia-backed, S&P 500 only)
get_indicatorsGet all 42 technical analysis indicators (SMA, EMA, RSI, MACD, Bollinger Bands, Ichimoku, etc.) for one or more stock symbols (comma-separated). A single symbol returns one indicators object; multiple symbols return a paginated batch plus per-symbol errors.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "interval": "1m",
  "limit": 0,
  "range": "1d",
  "symbols": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
intervalIntervaloptionalCandle interval: 1d|1wk|1mo (default: 1d)
limitintegeroptionalMaximum symbols per page (only applies when multiple symbols given); omitted = curated default (25)
rangeTimeRangeoptionalTime range: 1mo|3mo|6mo|1y|2y|5y (default: 1y)
symbolsstringrequiredOne or more comma-separated ticker symbols (e.g., "AAPL" or "AAPL,MSFT,GOOG")

Types

Interval

one of: "1m", "2m", "5m", "15m", "30m", "1h", "90m", "1d", "5d", "1wk", "1mo", "3mo"

TimeRange

one of: "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max"

get_indicesGet world market indices (S&P 500, DAX, Nikkei, etc.), optionally filtered by region.

Arguments

{
  "fields": "string",
  "region": "americas"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
regionindices_RegionoptionalRegion: americas|europe|asia-pacific|middle-east-africa|currencies (default: all)

Types

indices_Region

one of: "americas", "europe", "asia-pacific", "middle-east-africa", "currencies"

get_industryGet comprehensive industry data (overview, performance, top companies) for a specific industry slug.

Arguments

{
  "fields": "string",
  "industry": "agricultural-inputs",
  "lang": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
industryIndustryrequiredIndustry slug (e.g., semiconductors, biotechnology, banks-diversified)
langstringoptionalTarget language for translated text fields (BCP 47, e.g. "ja", "zh-Hant"); English or omitted = no translation

Types

Industry

one of: "agricultural-inputs", "aluminum", "coal", "copper", "farm-products", "forest-products", "gold", "lumber-wood-production", "other-industrial-metals-mining", "other-precious-metals-mining", "silver", "steel", "thermal-coal", "uranium", "apparel-manufacturing", "apparel-retail", "auto-truck-dealerships", "auto-manufacturers", "auto-parts", "beverages-brewers", "beverages-non-alcoholic", "beverages-wineries-distilleries", "confectioners", "department-stores", "discount-stores", "electronic-gaming-multimedia", "food-distribution", "footwear-accessories", "furnishings-fixtures-appliances", "gambling", "grocery-stores", "home-improvement-retail", "household-personal-products", "internet-retail", "leisure", "lodging", "luxury-goods", "packaged-foods", "personal-services", "residential-construction", "resorts-casinos", "restaurants", "specialty-retail", "textile-manufacturing", "tobacco", "travel-services", "oil-gas-drilling", "oil-gas-ep", "oil-gas-equipment-services", "oil-gas-integrated", "oil-gas-midstream", "oil-gas-refining-marketing", "solar", "asset-management", "banks-diversified", "banks-regional", "capital-markets", "credit-services", "financial-data-stock-exchanges", "insurance-brokers", "insurance-diversified", "insurance-life", "insurance-property-casualty", "insurance-reinsurance", "insurance-specialty", "mortgage-finance", "shell-companies", "biotechnology", "diagnostics-research", "drug-manufacturers-general", "drug-manufacturers-specialty-generic", "health-information-services", "healthcare-plans", "medical-care-facilities", "medical-devices", "medical-distribution", "medical-instruments-supplies", "pharmaceutical-retailers", "aerospace-defense", "building-materials", "building-products-equipment", "business-equipment-supplies", "chemical-manufacturing", "chemicals", "conglomerates", "consulting-services", "electrical-equipment-parts", "engineering-construction", "farm-heavy-construction-machinery", "industrial-distribution", "infrastructure-operations", "integrated-freight-logistics", "manufacturing-diversified", "marine-ports-services", "marine-shipping", "metal-fabrication", "paper-paper-products", "pollution-treatment-controls", "railroads", "rental-leasing-services", "security-protection-services", "specialty-business-services", "specialty-chemicals", "specialty-industrial-machinery", "staffing-employment-services", "tools-accessories", "trucking", "waste-management", "real-estate-development", "real-estate-diversified", "real-estate-services", "reit-diversified", "reit-healthcare-facilities", "reit-hotel-motel", "reit-industrial", "reit-mortgage", "reit-office", "reit-residential", "reit-retail", "reit-specialty", "communication-equipment", "computer-hardware", "consumer-electronics", "data-analytics", "electronic-components", "electronics-computer-distribution", "hardware-software-distribution", "information-technology-services", "internet-content-information", "scientific-technical-instruments", "semiconductor-equipment-materials", "semiconductors", "software-application", "software-infrastructure", "broadcasting", "entertainment", "publishing", "telecom-services", "utilities-diversified", "utilities-independent-power-producers", "utilities-regulated-electric", "utilities-regulated-gas", "utilities-regulated-water", "utilities-renewable", "closed-end-fund-debt", "closed-end-fund-equity", "closed-end-fund-foreign", "exchange-traded-fund"

get_key_metrics_ttmTrailing-twelve-month key metrics.

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default
symbolstringrequiredStock ticker symbol
get_market_calendarGet a market-wide event calendar over a date range: earnings, IPOs, dividends, splits, economic releases, market holidays, or live exchange open/closed status. Unlike get_calendar (per-symbol), this spans the whole market.

Arguments

{
  "fields": "string",
  "from": "string",
  "kind": "earnings",
  "to": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
fromstringoptionalStart date (YYYY-MM-DD); ignored by market-holiday/market-status
kindMarketCalendarKindParamrequiredWhich market-wide calendar to fetch: earnings | ipo | dividend | split | economic | market-holiday | market-status
tostringoptionalEnd date (YYYY-MM-DD); ignored by market-holiday/market-status

Types

MarketCalendarKindParam

one of: "earnings", "ipo", "dividend", "split", "economic", "market-holiday", "market-status"

get_market_hoursGet current market hours and open/closed status for a region.

Arguments

{
  "fields": "string",
  "region": "AR"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
regionRegionoptionalRegion code: US|GB|DE|CA|AU|FR|IN|CN|HK|BR|TW|SG (default: US)

Types

Region

one of: "AR", "AU", "BR", "CA", "CN", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "IL", "IT", "JP", "KR", "MY", "MX", "NZ", "NO", "PT", "QA", "RU", "SG", "ES", "SE", "TW", "TH", "TR", "GB", "US", "VN"

get_market_summaryGet market overview with major indices and currencies for a region.

Arguments

{
  "fields": "string",
  "lang": "string",
  "region": "AR"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
langstringoptionalTarget language for translated text fields (BCP 47, e.g. "ja", "zh-Hant"); English or omitted = no translation
regionRegionoptionalRegion code: US|GB|DE|CA|AU|FR|IN|CN|HK|BR|TW|SG (default: US)

Types

Region

one of: "AR", "AU", "BR", "CA", "CN", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "IL", "IT", "JP", "KR", "MY", "MX", "NZ", "NO", "PT", "QA", "RU", "SG", "ES", "SE", "TW", "TH", "TR", "GB", "US", "VN"

get_newsGet recent news. If a symbol is provided, returns news for that stock; otherwise returns general market news.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "lang": "string",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
langstringoptionalTarget language for translated text fields (BCP 47, e.g. "ja", "zh-Hant"); English or omitted = no translation
limitintegeroptionalMaximum articles per page; omitted = curated default (25)
symbolstringoptionalStock ticker symbol (optional; omit for general market news)
get_optionsGet the options chain for a symbol. Provide an expiration timestamp to get a specific expiry, or omit for the nearest expiration.

Arguments

{
  "cursor": "string",
  "expiration": 0,
  "fields": "string",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor` (applied to both calls and puts); omitted = first page
expirationintegeroptionalExpiration date as Unix timestamp in seconds (optional; defaults to nearest expiration)
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
limitintegeroptionalMaximum contracts per side (calls/puts) per page; omitted = curated default (25)
symbolstringrequiredStock ticker symbol
get_press_releasesGet a company's own press releases, distinct from get_news (press coverage). Routes through EDGAR 8-K exhibits, falling back to FMP/Alpha Vantage when configured.

Arguments

{
  "fields": "string",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
limitintegeroptionalMaximum number of releases to return (default: 10)
symbolstringrequiredStock ticker symbol
get_price_target_consensusGet a stock's consensus analyst price target (high/low/mean/median).

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
symbolstringrequiredStock ticker symbol
get_price_target_summaryAnalyst price-target counts and averages per window.

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default
symbolstringrequiredStock ticker symbol
get_protocol_tvlA DeFi protocol's total value locked and per-chain split.

Arguments

{
  "fields": "string",
  "id": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
idstringrequiredCoinGecko coin id (e.g. aave)
get_protocol_tvl_historyA DeFi protocol's TVL history, oldest first.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "id": "string",
  "limit": 0
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
idstringrequiredCoinGecko coin id (e.g. aave)
limitintegeroptionalMaximum entries per page; omitted = curated default (25)
get_quoteGet current quote and company data (price, market cap, PE ratio, 52-week range, etc.) for one or more stock symbols (comma-separated). A single symbol returns one quote object; multiple symbols return a paginated batch of quotes plus per-symbol errors.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "lang": "string",
  "limit": 0,
  "symbols": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
langstringoptionalTarget language for translated text fields (BCP 47, e.g. "ja", "zh-Hant"); English or omitted = no translation
limitintegeroptionalMaximum symbols per page; omitted = curated default (25)
symbolsstringrequiredComma-separated list of ticker symbols (e.g., "AAPL,MSFT,GOOG")
get_rating_consensusGet a stock's consensus analyst rating rollup (strong buy/buy/hold/sell/strong sell counts and a headline consensus label).

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
symbolstringrequiredStock ticker symbol
get_ratios_ttmTrailing-twelve-month financial ratios.

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default
symbolstringrequiredStock ticker symbol
get_recommendationsGet similar stock recommendations and analyst ratings for a symbol.

Arguments

{
  "fields": "string",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
limitintegeroptionalMaximum number of recommendations to return (default: 5)
symbolstringrequiredStock ticker symbol
get_riskGet risk analytics: VaR (95/99%), Sharpe/Sortino/Calmar ratios, beta, and maximum drawdown for a symbol.

Arguments

{
  "benchmark": "string",
  "fields": "string",
  "interval": "1m",
  "range": "1d",
  "symbol": "string"
}
fieldtyperequireddescription
benchmarkstringoptionalBenchmark symbol for beta calculation (e.g., "SPY")
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
intervalIntervaloptionalCandle interval: 1d|1wk (default: 1d)
rangeTimeRangeoptionalTime range: 1y|2y|5y (default: 1y)
symbolstringrequiredStock ticker symbol

Types

Interval

one of: "1m", "2m", "5m", "15m", "30m", "1h", "90m", "1d", "5d", "1wk", "1mo", "3mo"

TimeRange

one of: "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max"

get_risk_factorsGet risk factors extracted from a symbol's SEC filings. Routes through EDGAR (best-effort HTML extraction) or Polygon when configured.

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
symbolstringrequiredStock ticker symbol
get_sectorGet comprehensive sector data (overview, performance, top companies, ETFs) for one of the 11 GICS sectors.

Arguments

{
  "fields": "string",
  "lang": "string",
  "sector": "technology"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
langstringoptionalTarget language for translated text fields (BCP 47, e.g. "ja", "zh-Hant"); English or omitted = no translation
sectorSectorrequiredSector slug: technology|financial-services|consumer-cyclical|communication-services| healthcare|industrials|consumer-defensive|energy|basic-materials|real-estate|utilities

Types

Sector

one of: "technology", "financial-services", "consumer-cyclical", "communication-services", "healthcare", "industrials", "consumer-defensive", "energy", "basic-materials", "real-estate", "utilities"

get_sector_peGet price/earnings ratios by market sector, provider-routed (Yahoo screener fan-out, keyless).

Arguments

{
  "fields": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
get_sector_performanceGet aggregate performance for every market sector, provider-routed (Yahoo screener fan-out, keyless). Distinct from get_sector (per-sector Yahoo-only shortcut).

Arguments

{
  "fields": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
get_sector_performance_historySector performance per session.

Arguments

{
  "fields": "string",
  "limit": 0
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
limitintegeroptionalSessions to return; omitted = 30
get_short_volumeDaily FINRA short-sale volume for a symbol, keyless.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default
limitintegeroptionalMaximum entries per page; omitted = curated default (25)
symbolstringrequiredStock ticker symbol
get_sparkGet lightweight close-price sparklines for multiple symbols. Faster and smaller than get_charts — use when you only need price direction/trend across many symbols.

Arguments

{
  "fields": "string",
  "interval": "1m",
  "range": "1d",
  "symbols": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
intervalIntervaloptionalCandle interval: 1m|5m|15m|30m|1h|1d|1wk|1mo|3mo (default: 1d)
rangeTimeRangeoptionalTime range: 1d|5d|1mo|3mo|6mo|1y|2y|5y|10y|ytd|max (default: 1mo)
symbolsstringrequiredComma-separated list of ticker symbols (e.g., "AAPL,MSFT,GOOG")

Types

Interval

one of: "1m", "2m", "5m", "15m", "30m", "1h", "90m", "1d", "5d", "1wk", "1mo", "3mo"

TimeRange

one of: "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max"

get_splitsGet historical stock split history for a symbol.

Arguments

{
  "fields": "string",
  "range": "1d",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
rangeTimeRangeoptionalTime range: 1y|2y|5y|10y|max (default: max)
symbolstringrequiredStock ticker symbol

Types

TimeRange

one of: "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max"

get_symbol_detailsReference detail for one symbol.

Arguments

{
  "fields": "string",
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
symbolstringrequiredStock ticker symbol
get_transcriptsGet earnings call transcripts for a company. Returns paragraph-by-paragraph text (speaker, timestamp, text), paginated via paragraph_limit/paragraph_cursor since a full call can be tens of thousands of tokens.

Arguments

{
  "fields": "string",
  "lang": "string",
  "limit": 0,
  "paragraph_cursor": "string",
  "paragraph_limit": 0,
  "symbol": "string"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
langstringoptionalTarget language for translated text fields (BCP 47, e.g. "ja", "zh-Hant"); English or omitted = no translation
limitintegeroptionalMaximum number of transcripts to return (default: all)
paragraph_cursorstringoptionalOpaque continuation token from a previous response's paragraphs `pageInfo.endCursor`; omitted = first page
paragraph_limitintegeroptionalMaximum transcript paragraphs per page; omitted = curated default (25). A full call's `text` is returned as paginated paragraphs, not one giant blob
symbolstringrequiredStock ticker symbol
get_treasury_yieldsGet US Treasury yield curve data (1m through 30y) for a given year. No API key required.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "limit": 0,
  "year": 0
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = all fields
limitintegeroptionalMaximum rows per page; omitted = curated default (25)
yearintegeroptionalYear to fetch yield curve data for (default: current year)
get_trendingGet currently trending stock tickers for a region.

Arguments

{
  "fields": "string",
  "region": "AR"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
regionRegionoptionalRegion code: US|GB|DE|CA|AU|FR|IN|CN|HK|BR|TW|SG (default: US)

Types

Region

one of: "AR", "AU", "BR", "CA", "CN", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "IL", "IT", "JP", "KR", "MY", "MX", "NZ", "NO", "PT", "QA", "RU", "SG", "ES", "SE", "TW", "TH", "TR", "GB", "US", "VN"

lookupDiscover tickers filtered by type (equity, ETF, mutual fund, index, future, currency, cryptocurrency).

Arguments

{
  "fields": "string",
  "lang": "string",
  "logo": true,
  "query": "string",
  "query_type": "all"
}
fieldtyperequireddescription
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
langstringoptionalTarget language for translated text fields (BCP 47, e.g. "ja", "zh-Hant"); English or omitted = no translation
logobooleanoptionalInclude logo URLs (requires an additional upstream API call); default: false
querystringrequiredSearch query (company name or ticker symbol)
query_typeLookupTypeoptionalFilter by type: equity|etf|mutualfund|index|future|currency|cryptocurrency (default: all)

Types

LookupType

one of: "all", "equity", "mutualfund", "etf", "index", "future", "currency", "cryptocurrency"

screenerGet results from a predefined stock screener (e.g., most-actives, day-gainers, undervalued-growth-stocks).

Arguments

{
  "count": 0,
  "fields": "string",
  "screener_type": "aggressive-small-caps"
}
fieldtyperequireddescription
countintegeroptionalNumber of results to return (default: 25, max: 250)
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
screener_typeScreenerrequiredScreener type: most-actives | day-gainers | day-losers | growth-technology-stocks | undervalued-growth-stocks | undervalued-large-caps | aggressive-small-caps | small-cap-gainers | most-shorted-stocks | high-yield-bond | top-mutual-funds | conservative-foreign-funds | portfolio-anchors | solid-large-growth-funds | solid-midcap-growth-funds

Types

Screener

one of: "aggressive-small-caps", "day-gainers", "day-losers", "growth-technology-stocks", "most-actives", "most-shorted-stocks", "small-cap-gainers", "undervalued-growth-stocks", "undervalued-large-caps", "conservative-foreign-funds", "high-yield-bond", "portfolio-anchors", "solid-large-growth-funds", "solid-midcap-growth-funds", "top-mutual-funds"

searchSearch for stocks, ETFs, and companies by name or ticker symbol.

Arguments

{
  "cursor": "string",
  "fields": "string",
  "lang": "string",
  "limit": 0,
  "query": "string"
}
fieldtyperequireddescription
cursorstringoptionalOpaque continuation token from a previous response's `pageInfo.endCursor`; omitted = first page
fieldsstringoptionalComma-separated list of GraphQL field names to include; omitted = curated default set
langstringoptionalTarget language for translated text fields (BCP 47, e.g. "ja", "zh-Hant"); English or omitted = no translation
limitintegeroptionalMaximum quotes per page; omitted = curated default (25)
querystringrequiredSearch query string (company name or ticker symbol)
built with cargo soothfast docs build source