list_my_portfolios
List your authorized portfolios
List the portfolios you authorized this connector to access.
Returns the portfolios that were on your TipRanks account at the time
you signed in, each with its id and name. If you've added or renamed
portfolios since, re-authorize to refresh.
無需輸入參數。
get_portfolio_holdings
Get portfolio holdings
Returns all holdings for one of your TipRanks portfolios.
Per holding: ticker, shares, price, cost basis (AvgExecutionPrice),
P/E ratio, dividend yield, market cap, sector, country, 52-week high/low,
percentage of portfolio, beta, EPS. Plus total value, cash, stock count.
Args:
portfolio_id: One of the IDs returned by list_my_portfolios.
輸入參數portfolio_id必填
get_portfolio_overview
Get portfolio overview
Returns lifetime / 1mo / 6mo / 12mo / YTD returns, Sharpe ratio, and a
monthly-return time series. The monthly history field is chart-ready —
a list of {month, return} points suitable for direct plotting.
Args:
portfolio_id: One of the IDs returned by list_my_portfolios.
輸入參數portfolio_id必填
get_portfolio_analysis
Get portfolio allocation analysis
Returns asset allocation by type/country/top stocks and distribution by sector,
market cap, dividend yield, beta, and P/E.
Args:
portfolio_id: One of the IDs returned by list_my_portfolios.
輸入參數portfolio_id必填
get_portfolio_performance
Get portfolio performance
Returns full performance: stats, gains, best trade, recent activity, a
daily-yield time series benchmarked against S&P 500 (chart-ready —
aligned dates with portfolio and benchmark yield columns, plot directly
as overlaid lines), monthly returns, risk profile, beta, dividend
yield/amount.
Args:
portfolio_id: One of the IDs returned by list_my_portfolios.
輸入參數portfolio_id必填
get_assets_data
Get stock data for tickers
Returns key TipRanks stock data for one or more tickers.
Args:
tickers: Ticker symbols — a comma-separated string ("AAPL,MSFT,C") or a
JSON array (["AAPL","MSFT","C"]). Both are accepted.
Returns JSON {"assetsData": [...one compact entry per ticker...]}. This is a
headline summary tuned to stay small enough for a whole portfolio to fit in a
single response. Fields per entry:
- ticker, companyName, sector, stockType, marketCap
- url: canonical TipRanks page for the stock — use as the citation source.
- price: latest close.
- smartScore: TipRanks composite 1-10 (combines the 8 datasets — analyst,
blogger, news, hedge-fund, insider, etc.).
- analystConsensus / bestAnalystConsensus: rating label from ALL covering
analysts vs. the top-performing ones ("Strong Buy".."Strong Sell"); a
divergence between the two is itself a signal.
- priceTarget: average 12-month target. priceTargetUpside: decimal vs.
current price (0.05 = +5%).
- peRatio, dividendYield (decimal).
- newsSentiment, hedgeFundsScore, insiderScore: 0-1 sentiment signals.
- ytdGainPct, yearlyGainPct: price performance as a percent (12.5 = +12.5%,
3944 = +3944%).
- nextEarningsDate, and daysUntilEarnings (whole days from today — quote this
rather than computing the gap from the date yourself).
Floats are rounded and dates are day-resolution. For deeper per-ticker detail
(full price history, 13F / insider breakdowns, blogger counts, financials)
use the dedicated tools (get_stock_prices, get_hedge_fund_holdings,
get_insider_transactions, get_financials, ...).
輸入參數tickers必填
get_assets_events
Get upcoming events for tickers
Returns upcoming dividend and earnings events for tickers.
Args:
tickers: Comma-separated ticker symbols (e.g. "AAPL,MSFT")
from_date: Optional start date (ISO format, e.g. "2026-03-01")
to_date: Optional end date (ISO format, e.g. "2026-06-01")
Returns: dividend dates, earnings dates, and coupon dates per ticker.
輸入參數tickers必填to_datefrom_date
get_assets_news
Get recent news for tickers
Returns recent news articles for tickers, aggregated from many news
sites, each with a sentiment tag and source URL (headlines only — no
article body). For general/market TipRanks news without a specific ticker,
or for an article excerpt, use get_latest_news.
This tool serves the CURRENT news window only: it returns each ticker's most
recent articles, and from_date just trims that recent set. For news from a
specific past date range, use get_latest_news with from_date + to_date,
which searches the full archive.
Args:
tickers: Comma-separated ticker symbols
count: Number of articles to return (default 10)
from_date: Optional 'YYYY-MM-DD' recency floor (filtered on `date`).
Returns JSON: {"assetNewsArticles": [...]}. Each entry:
- ticker, companyName
- sentiment: bucketed signal — one of "VeryPositive", "Positive",
"Neutral", "Negative", "VeryNegative". Derived from TipRanks
news-sentiment classifier on the article text.
- siteName, url, title
- date, addedOn, publishTime, articleTimestamp: redundant date
fields. addedOn is when TipRanks ingested it; publishTime is
the source's stated publication time. Prefer publishTime.
輸入參數counttickers必填from_date
get_latest_news
Get latest TipRanks news
Latest TipRanks news articles (newest first) from TipRanks's own
editorial/wire feed — each with a text excerpt, unlike get_assets_news.
Use for general market news (no ticker), news on a specific stock with a
short summary of each story, or to browse a news category. This is also the
tool for news from a specific PAST date range — pass from_date AND to_date
together; the archive holds years of stories, so a past window is answerable
here even though get_assets_news only reaches recent articles.
Args:
tickers: Optional comma-separated tickers to filter by (e.g. 'NVDA,AAPL').
Omit for general market news.
category: Optional single category (see the field description).
from_date: Optional 'YYYY-MM-DD' recency floor.
limit: Max articles to return (default 20).
to_date: Optional 'YYYY-MM-DD' inclusive upper bound. Results are
newest-first, so from_date alone returns today's news rather
than news from around that date — add to_date to scope a window.
Returns a JSON list of {id, title, excerpt, author, category, date, url,
tickers}. To read a full article, pass its url or id to get_article.
輸入參數limittickersto_datecategoryfrom_date
get_article
Read a TipRanks article
Fetch the full text of a single TipRanks article.
Resolve a TipRanks article URL (e.g. from get_latest_news / get_assets_news),
a slug, or a numeric post id to its title, excerpt, full body text
(HTML-stripped, capped at 8000 chars), author, category, date, canonical
URL, and any tagged tickers.
Args:
identifier: Numeric post id, slug, or a tipranks.com article URL.
Returns a JSON object, or {"error": ...} when no matching TipRanks article
exists (e.g. the URL points to an aggregated third-party site, which is not
stored in TipRanks).
輸入參數identifier必填
get_assets_warnings
Get risk warnings for tickers
Returns risk warnings for tickers.
Args:
tickers: Comma-separated ticker symbols
Returns: warning type, date, and detail fields per ticker.
輸入參數tickers必填
get_trending_stocks
Get trending stocks
Returns currently trending stocks that recently received analyst ratings.
Args:
num: Number of results (default 20)
filter: exactly one of 'analysts', 'bloggers', 'both'. Anything else is
refused — the feed would otherwise answer it with the 'both' list.
daysAgo: Days to look back: 3, 7, or any number from 30 up. Every other value
(1, 2, 14…) is rejected by the feed. Default 7. Pass 30 or more when
filtering by sector or country to ensure enough results — narrow
windows often return fewer than 5 stocks in a specific sector.
trendingType: exactly 'best-rated' or 'worst-rated' (empty for all). Anything
else is refused — the feed would otherwise return the unranked list.
country: 'US','Canada','UK','Germany','Israel','Australia' etc.
sector: One of energy, financial, general, healthcare, industrials, services,
technology, utilities. Empty for all sectors. This feed answers a
sector it does not recognise with financial stocks rather than an
error, so anything outside that list comes back refused instead.
Rows returned for 'energy' are energy companies (Exxon, Chevron, BP)
even though the feed tags them UTILITIES.
Returns: ticker, SmartScore, analyst/blogger sentiment, hedge fund trend,
price target, buy/hold/sell counts per stock.
輸入參數numfiltersectorcountrydaysAgotrendingType
get_company_kpis
Get company operational KPIs
Returns company-specific operational KPIs: segment revenue, geographic
breakdown, active users/devices, gross margins by type, opex breakdown.
Full history runs back to 2014 and is large, so this returns the most
recent `count` periods per metric by default — pass count=0 for the full
history, or `group` to fetch a single group.
Args:
ticker: Stock ticker (e.g. 'AAPL', 'MSFT')
count: Most-recent periods per metric (default 8, max 40; 0 = full history)
group: Optional single group by slug or title
Returns JSON: {"ticker", "lastUpdated", "groups": [...]}. Each group has
slug, title, and metrics: [{title, slug, unit, series: [{periodEnd, value}]}].
輸入參數countgroupticker必填
get_market_movers
Get today's market movers
Returns today's market movers: biggest gainers, losers, most active.
Args:
category: 1=DollarVolume, 2=PercentGainers, 3=PercentLosers,
4=GainersRegular, 5=LosersRegular, 6=UnusualVolume
country: 1=US, 2=Canada, 3=UK
num: Number of results
輸入參數numcountrycategory必填
get_top_rated_stocks
Get top-rated stocks
Returns stocks most recommended by the best-performing analysts (by analyst track record).
Args:
num: Number of results
sector: Sector filter (financial, healthcare, technology, etc.) or empty for all
country: 'US', 'Canada', 'UK', 'Global'. NOTE: UK tickers use GB: prefix but country param is 'UK'.
輸入參數numsectorcountry
get_top_smart_score_stocks
Get top Smart Score stocks
Returns stocks with the highest TipRanks Smart Score (perfect 10 / Outperform).
Args:
num: Number of results
sector: Sector filter (financial, healthcare, technology, etc.) or empty for all
country: 'US', 'Canada', 'UK', 'Germany', 'Spain', 'France', 'India', 'Italy',
'Israel', 'Australia', 'Singapore', 'Japan', 'HongKong', 'Global'.
NOTE: UK tickers use GB: prefix but the country param is 'UK'.
輸入參數numsectorcountry
get_economic_calendar
Get economic calendar
Returns upcoming and recent economic events (Fed meetings, jobs reports, CPI, GDP).
Defaults to US events at High/Medium impact only because the raw feed includes
hundreds of low-impact items from every country.
For what data was released (how the jobs report or CPI came in), set daysBack to 35;
the result keeps the latest actual of each High-impact release (payrolls, CPI, ISM),
then the events nearest today.
A row with a numeric actual and estimate carries vsEstimate {diff, label: above|below|in line},
actual minus estimate; the label gives direction only, so judge good or bad yourself.
Args:
daysBack: Days to look back (default 0)
daysForward: Days to look forward (default 7)
fromDate: Start date ISO format (alternative to daysBack)
toDate: End date ISO format (alternative to daysForward)
countries: Comma-separated country names to keep (default 'US').
Pass an empty string to disable the country filter.
Common values: 'US','UK','Germany','Japan','China','Canada','France'.
impact: Comma-separated impact levels to keep (default 'High,Medium').
Valid values: 'High','Medium','Low'. Pass empty to keep all levels.
limit: Max events returned after filtering (default 50, max 200); a large limit is also cut to
the events nearest now so the result fits, and the result says how many were left out.
Returns: { totalMatched, returned, filters, economicCalendar: [...] }.
輸入參數limitimpacttoDatedaysBackfromDatecountriesdaysForward
get_peers
Get peer companies
Peer/competitor companies for a stock, with comparative metrics for
side-by-side analysis. Read-only, no side effects.
Use to find and compare a company against similar names (competitors,
same-sector peers). For that company's own data use get_assets_data; for a
sector-wide breakdown use get_sector_analysis.
輸入參數ticker必填
get_politicians
List politicians with trading activity
Returns the list of politicians tracked for trading activity.
Returns: name, party, state, position, net worth, profile.
無需輸入參數。
get_politician_activity
Get a politician's trades or holdings
Returns a specific politician's stock trades or holdings.
First call get_politicians to find the politicianId.
Args:
politicianId: Politician ID from get_politicians
activity: 'trades' or 'holdings'
輸入參數activitypoliticianId必填
get_earnings_calendar
Get earnings calendar by date range
Returns upcoming earnings dates across all stocks for a date range.
Serves at most 15 days per call (fromDate through fromDate+14); a longer
range is shortened, and the result's fromDate/toDate give the window
actually served. For a longer period, call again starting the day after
toDate.
Args:
fromDate: Start date YYYY-MM-DD (default: today)
toDate: End date YYYY-MM-DD (default and maximum: fromDate+14)
exchange: Optional exchange filter, e.g. 'US' for US-only results
輸入參數toDateexchangefromDate
get_ticker_earnings
Get earnings dates for a specific ticker
Upcoming and recent earnings dates for a specific stock — scheduled
report dates with EPS/revenue estimates where available. Read-only, no
side effects.
Use this to find when a company reports. For past actual-vs-estimate
results use get_earnings_history; for a cross-market schedule use
get_earnings_calendar.
輸入參數ticker必填
get_ipo_calendar
Get IPO calendar
Returns upcoming and recent IPOs.
Args:
fromDate: Start date ISO format (default: today)
toDate: End date ISO format (default: 30 days from now)
輸入參數toDatefromDate
get_clinical_trials
Get FDA / clinical-trial calendar
Returns the FDA / clinical-trial calendar — upcoming drug approval target
dates and the tickers behind each drug.
Window is fixed at today − 14 days to today + 60 days, sorted by date ascending.
Use for upcoming FDA decisions, PDUFA dates, biotech catalysts.
Returns: { data: [{ targetDate, clinicalTrials: [{ drugName, ticker }] }],
count, window }.
無需輸入參數。
get_stock_splits
Get upcoming and recent stock splits
Returns the stock-split calendar with split ratios and direction
(Forward / Reverse). Use for upcoming splits, reverse-split alerts,
historical split lookup.
Args:
fromDate: Start date YYYY-MM-DD (default: 30 days ago)
toDate: End date YYYY-MM-DD (default: 30 days from now)
type: Optional filter — 'Forward' or 'Reverse' (case-insensitive).
Empty string returns both.
limit: Max rows (default: 25, max: 100)
ticker: Optional single symbol. Widen fromDate to search a company's history —
the default window is only today ± 30 days.
Returns: { totalCount, data: [{ ticker, companyName, effectiveDate, type,
splitRatio, splitRatioText }] }. A filtered call
(ticker or type) also returns `matched` and `window`: `totalCount` is
every split in the window, `matched` how many passed the filter. The
window is read in full before filtering, so an empty result means there
genuinely are none rather than that the first page held none.
輸入參數typelimittickertoDatefromDate
get_buybacks
Get share-buyback / repurchase activity
Returns share-buyback / stock-repurchase activity in one of two modes:
- CROSS-MARKET (no ticker): latest reported buybacks across all companies,
sorted by dollar amount spent (largest first). Use for 'biggest buybacks',
'top repurchase companies'. A single company may appear multiple times for
different fiscal quarters.
- PER-TICKER (ticker provided): historical quarterly buyback series for one
ticker. Use for 'AAPL buyback history', 'MSFT repurchase trend'.
Args:
ticker: Optional. If provided, returns the per-ticker historical series.
If empty, returns the cross-market list.
limit: Cross-market mode only — max rows (default: 25, max: 100).
page: Cross-market mode only — page number, 1-based (default: 1).
Returns:
Cross-market mode: { totalCount, data: [{ ticker, companyName,
fiscalPeriodEndDate, stockEarningsDate, eps,
marketCapUSD, totalValueSpentToRepurchaseShares,
epsCurrencyTypeCode }] }.
Per-ticker mode: quarterly time series, chart-ready as a bar or
line plot of buyback spend over time —
[{ date, marketCapEndFiscalPeriod,
totalValueSpentToRepurchaseShares,
ratio (decimal — buyback / market cap) }, ...].
輸入參數pagelimitticker
get_bulls_bears_summary
Get bull and bear key points
Returns the discrete bull and bear key points for stocks — the individual
sentence bullets TipRanks shows on its stock pages, each tagged with a topic.
Args:
tickers: Comma-separated tickers (e.g. 'AAPL,TSLA')
Returns JSON: {"data": [...one entry per ticker...]}. Each entry has:
- ticker, updatedOn
- bullish: list of bullish point sentences
- bearish: list of bearish point sentences
- key_points: list of {sentiment, topic, point} for the full set.
輸入參數tickers必填
get_investor_sentiment
Get crowd / investor sentiment
Returns crowd / retail investor sentiment for a stock.
Args:
ticker: Stock ticker (e.g. 'NVDA')
Returns JSON with these top-level keys:
- investorStatsOverview: stats aggregated across ALL TipRanks
portfolios that hold the ticker. Fields:
* numberOfPortfolios: total active portfolios on the platform.
* portfoliosHoldingStock: how many of them hold THIS ticker.
* averageAllocation: average % allocation among holders (decimal).
* percentOverLast30Days / percentOverLast7Days: change in the
count of holders over the window (decimal; 0.013 = +1.3%).
* investorScore: TipRanks' 0-1 score of how confident "the
crowd" is on this stock; higher = more bullish positioning.
* sectorAverageScore: investorScore averaged across the sector,
for comparison.
* sentiment: bucketed label — one of "VeryNegative",
"Negative", "Neutral", "Positive", "VeryPositive".
* sectorAverageSentiment: same bucket, sector-wide.
- bestInvestorStatsOverview: same fields, but restricted to "Best
Investors" — TipRanks users with top-decile portfolio returns
over the trailing window. If investorStatsOverview and
bestInvestorStatsOverview diverge (e.g. crowd is Positive but
best investors are Negative), that's the headline signal.
- ageDistribution: holders split by TipRanks account-tenure tier
(NOT the investor's biological age):
* eldest: oldest accounts on the platform
* midRange: middle tier
* youngest: newest accounts
Each has percentHolders, last30DaysChange, last7DaysChange,
and per-bucket averages (averageBeta, averageMonthlyReturn,
dividendYield, averagePeRatio).
- investorsAlsoBought: top other stocks held by people who hold
this one (each: ticker, companyName, averageHoldi
輸入參數ticker必填
get_blogger_sentiment
Get blogger sentiment for a ticker
Returns the financial-blogger consensus for a stock plus the underlying
blogger articles.
Distinct from get_recent_analyst_ratings (Wall Street analysts) and
get_investor_sentiment (TipRanks crowd positioning).
Args:
ticker: Stock ticker (e.g. 'AAPL')
limit: Max blogger articles to return (default 20, max 50)
Returns JSON: {ticker, company, consensus, articles}.
- consensus: {bullish_pct, bearish_pct, neutral_pct, bullish_count,
bearish_count, neutral_count, score, avg}.
- articles: [{blogger, title, url, site, date}] (newest first).
輸入參數limitticker必填
get_top_hedge_fund_managers
Get top hedge fund managers
Returns top-performing hedge fund managers ranked by success rate and returns.
Args:
num: Number of managers to return (default 10, max 100 — the upstream
returns 100 for anything higher)
輸入參數num
get_hedge_fund_activity
Get per-fund hedge fund activity
Returns per-fund hedge-fund holdings and recent transactions for a ticker —
which institutions hold it, how much each changed (bought/sold), the holding
value, % of portfolio, and the fund's TipRanks rank/stars.
Complements get_hedge_fund_holdings (the aggregate share-count timeseries).
Args:
ticker: Stock ticker (e.g. 'AAPL')
limit: Max funds to return (default 25, max 100)
Returns JSON: {ticker, company, sentiment, trend_action, trend_value, funds}.
- funds: [{manager, institution, shares_change, direction, holding_value,
pct_of_portfolio, as_of, rank, stars, is_active}].
輸入參數limitticker必填
get_best_performing_experts
Get best-performing experts
Returns the best-performing experts ranked by TipRanks success rate and average return.
Args:
expert_type: One of: analyst, insider, hedgeFund, blogger, firm (default: analyst)
num: Number of results (default: 10, max: 25)
輸入參數numexpert_type
get_technical_analysis
Get technical analysis
Returns RSI, MACD, Stochastics, ADX, moving averages, and pivot points
for stocks and ETFs.
Covers stocks and ETFs alike (e.g. 'NVDA', 'SPY', 'QQQ', 'VTI') with the
same payload shape. For an ETF's analyst consensus, forecast, holdings or
exposures, use get_etf_analysis, get_etf_forecast, get_etf_top_stocks, or
get_etf_exposures.
Args:
tickers: Comma-separated stock or ETF tickers (e.g. 'NVDA' or 'NVDA,SPY').
timeFrame: '1m','5m','15m','30m','1h','5h','day','3d','week','2w','month' (default: 'day')
'5h' is slow upstream: request it for one ticker per call.
Returns: summary scores, oscillators (RSI, MACD, Stochastics, ADX, CCI,
Williams %R, ATR, ROC), moving averages, and pivot points.
Labels are strings. indicator: "Buy", "Neutral" or "Sell" (null
on ATR and pivot points). scoreScale: "StrongBuy", "Buy",
"Neutral", "Sell" or "StongSell" (the upstream's own spelling).
輸入參數tickers必填timeFrame
get_etf_analysis
Get ETF analyst consensus
Returns analyst consensus for ETFs based on weighted average of holdings' ratings.
Args:
tickers: Comma-separated ETF tickers (e.g. 'QQQ,SPY,VTI')
輸入參數tickers必填
get_etf_forecast
Get ETF forecast
Returns the analyst forecast for a specific ETF: consensus, price target, upside.
Args:
ticker: ETF ticker (e.g. 'QQQ')
輸入參數ticker必填
get_etf_top_stocks
Get top stock holdings in an ETF
Returns the top stock holdings within an ETF along with their analyst ratings.
Args:
ticker: ETF ticker (e.g. 'QQQ')
輸入參數ticker必填
get_etf_exposures
List ETFs holding a stock
Returns the list of ETFs that hold a specific stock, sorted by holding market
value (largest first).
Args:
ticker: Stock ticker (e.g. 'MSFT', 'AAPL')
page: Page number (default 1)
page_size: Results per page (default 20, max 100)
Returns per ETF: etfTicker, etfCompanyName, etfCategory, aum, expenseRatio,
holdingWeight (% of ETF in this stock), holdingMarketValue ($),
holdingNumOfShares, weightInAsset (% of stock's outstanding shares held by this ETF),
etfAnalystConsensusScore, etfSmartScore. Also returns totalCount (total ETFs holding the stock).
輸入參數pageticker必填page_size
get_etf_screener
Screen ETFs by criteria
Filters ETFs by asset class, category, and focus.
Args:
assetClass: Alternatives, AssetAllocation, Commodities, Currency, Equity, FixedIncome
category: BroadMarket, Sector, HighDividendYield, SizeAndStyle, Corporate, etc.
focus: LargeCap, SmallCap, MidCap, TotalMarket, Financials, HealthCare,
InformationTechnology, Energy, RealEstate, HighDividendYield, HighYield, etc.
Use this for a sector question ('tech ETFs' -> InformationTechnology);
the screener has no `sector` filter.
limit: Rows to return (default 20, max 100).
Returns: `count` (all ETFs matching the filters) and `data` rows: ticker, name,
price, smartScore, analystConsensus, priceTarget, upsidePct,
dividendYieldPct, expenseRatioPct, aum, currency, assetClass, segment,
category, focus, index, brand, holdingsCount, isCurrencyHedged and
isUcitsCompliant (true/false), and isLeveraged/isInverse/isActivelyManaged
when true.
輸入參數focuslimitcategoryassetClass
get_commodity_quote
Get commodity quote
Returns the real-time price quote for a specific commodity.
Common symbols: GCUSD (gold), SIUSD (silver), CLUSD (crude oil),
NGUSD (natural gas), HGUSD (copper), PLUSD (platinum).
yearHigh / yearLow are the feed's trailing-year range, roughly the past
12-13 months: call them trailing-year figures. For a year-to-date or
calendar-year change, a dated extreme or an exact 52-week figure use
get_commodity_historical, since the quote does not date its extremes.
Args:
symbol: Commodity symbol (e.g. 'GCUSD' for gold)
輸入參數symbol必填
get_all_commodities_quotes
Get all commodity quotes
Returns real-time quotes for all commodities in a single request.
Each row carries the commodity's display name and a changePercentage derived
from price and change, alongside the raw price, change and volume. Use the
name given in the response — several symbols are non-mnemonic (HEUSX is Lean
Hogs, SBUSX is Sugar, ZSUSX is Soybeans).
無需輸入參數。
get_commodity_historical
Get commodity historical OHLCV
Daily OHLC price history for a commodity, covering the whole date range you ask for.
Chart-ready: while the range fits in one response, each row is the price feed's
own daily row — {symbol, date, open, high, low, close, volume, change,
changePercent, vwap} — newest first, ordered for direct plotting as a price history.
A range too long to return day by day is aggregated into coarser OHLC bars
rather than cut short. `interval` names which (weekly/monthly/quarterly/yearly),
each bar spans `date` to `endDate`, and a bar's high/low are that period's real
extremes. Aggregated bars carry the same fields except `vwap`, which the feed
defines per session only. Re-request a narrower from_date/to_date for daily rows.
`summary` always describes the FULL requested window, computed from the daily
data: its first and last close with dates, its high and low with dates, and the
trailing changes the window reaches back far enough to support. Base any
"starting price", "a year ago" or "period high/low" claim on `summary`, or on a
bar that is actually present.
`summary.windowHigh`/`windowLow` describe THIS window. A quote tool's
yearHigh/yearLow are the feed's trailing range, roughly the past 12-13
months — a different period — so label those as trailing-year figures. For the current level alone, call get_commodity_quote.
Args:
symbol: Commodity symbol (e.g. 'GCUSD' for gold)
from_date: Start date YYYY-MM-DD (optional)
to_date: End date YYYY-MM-DD (optional)
輸入參數symbol必填to_datefrom_date
get_forex_quote
Get forex quote
Returns the real-time exchange rate quote for a forex pair.
Common pairs: EURUSD, GBPUSD, USDJPY, USDCHF, AUDUSD, USDCAD.
yearHigh / yearLow are the feed's trailing-year range, roughly the past
12-13 months: call them trailing-year figures. For a year-to-date or
calendar-year change, a dated extreme or an exact 52-week figure use
get_forex_historical, since the quote does not date its extremes.
A pair quotes the BASE currency (first three letters) in units of the
QUOTE currency (last three): USDHUF 320 means 1 USD = 320 HUF. A rising
rate, or a rate above its priceAvg50 / priceAvg200, is the base
strengthening against the quote. changePercentage is measured against
previousClose as of the quote's timestamp. Spot FX is closed from Friday
17:00 to Sunday 17:00 New York time; a quote stamped in that window
shows the change as of the last close, not a move made that day.
Args:
symbol: Forex pair symbol (e.g. 'EURUSD')
輸入參數symbol必填
get_all_forex_quotes
Get forex market overview
Real-time forex quotes: the most-traded pairs, each with a display name.
The feed carries 1,550 pairs in alphabetical order, which is far more than one
response can hold — so this returns the most prominent `limit` of them (majors
first, then by volume), and the response states how many were left out. Pass
`symbols` for specific pairs, or call get_forex_quote for a single one.
Read `note` before summarising: it says how many pairs the slice covers out of
how many exist, so a "top pairs" answer is not mistaken for the whole market.
`volume` on a forex row is a per-venue tick count, not market turnover — FX is
over-the-counter and most pairs report 0. It does not rank the market.
Args:
symbols: Comma-separated pairs (optional; overrides the ranked slice)
limit: How many ranked pairs to return (optional)
輸入參數limitsymbols
get_forex_historical
Get forex historical OHLCV
Daily OHLC price history for a forex pair, covering the whole date range you ask for.
Chart-ready: while the range fits in one response, each row is the price feed's
own daily row — {symbol, date, open, high, low, close, volume, change,
changePercent, vwap} — newest first, ordered for direct plotting as an exchange-rate history.
A range too long to return day by day is aggregated into coarser OHLC bars
rather than cut short. `interval` names which (weekly/monthly/quarterly/yearly),
each bar spans `date` to `endDate`, and a bar's high/low are that period's real
extremes. Aggregated bars carry the same fields except `vwap`, which the feed
defines per session only. Re-request a narrower from_date/to_date for daily rows.
`summary` always describes the FULL requested window, computed from the daily
data: its first and last close with dates, its high and low with dates, and the
trailing changes the window reaches back far enough to support. Base any
"starting rate", "a year ago" or "period high/low" claim on `summary`, or on a
bar that is actually present.
`summary.windowHigh`/`windowLow` describe THIS window. A quote tool's
yearHigh/yearLow are the feed's trailing range, roughly the past 12-13
months — a different period — so label those as trailing-year figures. For the current level alone, call get_forex_quote.
`volume` on a forex row is a per-venue tick count, not market turnover — FX is
over-the-counter. Read it as a liquidity hint at best.
Args:
symbol: Forex pair symbol (e.g. 'EURUSD')
from_date: Start date YYYY-MM-DD (optional)
to_date: End date YYYY-MM-DD (optional)
輸入參數symbol必填to_datefrom_date
get_index_quote
Get index quote
Returns the real-time quote for a major market index.
Index symbols: ^GSPC (S&P 500), ^NDX (Nasdaq 100), ^IXIC (Nasdaq
Composite), ^DJI (Dow Jones), ^RUT (Russell 2000), ^GSPTSE (TSX),
^FTSE (FTSE 100), ^GDAXI (DAX 40), ^FCHI (CAC 40), ^STOXX50E
(Euro STOXX 50), ^IBEX (IBEX 35), ^N225 (Nikkei), ^AXJO (ASX 200),
^AORD (All Ords), ^HSI (Hang Seng), ^STI (STI), ^BSESN (Sensex),
^VIX (VIX).
Broker / CFD names map to the index they track (the same map the AI
chat uses): 'US Tech 100' / 'NAS100' / 'USTEC' -> ^NDX; 'US 500' /
'SPX500' -> ^GSPC; 'Wall Street 30' / 'US 30' -> ^DJI; 'US 2000' /
'US Small Cap 2000' -> ^RUT; 'Germany 40' / 'GER40' -> ^GDAXI;
'UK 100' -> ^FTSE; 'France 40' -> ^FCHI; 'Euro 50' / 'EU50' ->
^STOXX50E; 'Spain 35' -> ^IBEX; 'Japan 225' -> ^N225; 'Australia 200'
-> ^AXJO; 'Hong Kong 50' -> ^HSI. 'Nasdaq Composite' is
^IXIC; 'Nasdaq 100' and the Nasdaq 100 CFD names above are ^NDX —
different indices at different levels, so quote the one the user named
and name it. A bare 'Nasdaq' is ambiguous: say which one you quote. For
an index not listed here (e.g. 'S&P 100'), call it by its own symbol —
a listed index with a similar name is a different index.
yearHigh / yearLow are the feed's trailing-year range, roughly the past
12-13 months: call them trailing-year figures. For a year-to-date or
calendar-year change, a dated extreme or an exact 52-week figure use
get_index_historical, since the quote does not date its extremes.
Args:
symbol: Index symbol (e.g. '^GSPC' for S&P 500)
輸入參數symbol必填
get_index_historical
Get index historical OHLCV
Daily OHLC price history for a major market index, covering the whole date range you ask for.
Chart-ready: while the range fits in one response, each row is the price feed's
own daily row — {symbol, date, open, high, low, close, volume, change,
changePercent, vwap} — newest first, ordered for direct plotting as an index history.
A range too long to return day by day is aggregated into coarser OHLC bars
rather than cut short. `interval` names which (weekly/monthly/quarterly/yearly),
each bar spans `date` to `endDate`, and a bar's high/low are that period's real
extremes. Aggregated bars carry the same fields except `vwap`, which the feed
defines per session only. Re-request a narrower from_date/to_date for daily rows.
`summary` always describes the FULL requested window, computed from the daily
data: its first and last close with dates, its high and low with dates, and the
trailing changes the window reaches back far enough to support. Base any
"starting level", "a year ago" or "period high/low" claim on `summary`, or on a
bar that is actually present.
`summary.windowHigh`/`windowLow` describe THIS window. A quote tool's
yearHigh/yearLow are the feed's trailing range, roughly the past 12-13
months — a different period — so label those as trailing-year figures. For the current level alone, call get_index_quote.
Takes the same index symbols and broker/CFD-name mapping as
get_index_quote — e.g. ^NDX for 'US Tech 100' / 'Nasdaq 100', ^IXIC for
'Nasdaq Composite', ^GDAXI for 'Germany 40'.
Args:
symbol: Index symbol (e.g. '^GSPC' for S&P 500)
from_date: Start date YYYY-MM-DD
to_date: End date YYYY-MM-DD (defaults to today)
輸入參數symbol必填to_datefrom_date必填
get_crypto_quote
Get crypto quote
Returns the real-time price quote for a specific cryptocurrency.
Common symbols: BTCUSD (Bitcoin), ETHUSD (Ethereum), SOLUSD (Solana),
BNBUSD (BNB), XRPUSD (XRP), ADAUSD (Cardano), DOGEUSD (Dogecoin).
yearHigh / yearLow are the feed's trailing-year range, roughly the past
12-13 months: call them trailing-year figures. For a year-to-date or
calendar-year change, a dated extreme or an exact 52-week figure use
get_crypto_historical, since the quote does not date its extremes.
Args:
symbol: Cryptocurrency symbol (e.g. 'BTCUSD' for Bitcoin)
輸入參數symbol必填
get_all_crypto_quotes
Get crypto market overview
Real-time crypto quotes: the largest coins, each with a display name.
The feed carries 4,771 coins in alphabetical order, which is far more than one
response can hold — so this returns `limit` of them ordered by market
capitalisation, largest first, and the response states how many were left out.
Pass `symbols` for specific coins, or call get_crypto_quote for a single one.
Read `note` before summarising: it says how many coins the slice covers out of
how many exist, so a "top coins" answer is not mistaken for the whole market.
`volume` on a crypto row is the source venue's own figure and is not a common
unit across coins — some rows count coins, others quote-currency turnover. It
does not rank the market and coins cannot be compared on it.
Args:
symbols: Comma-separated coins (optional; overrides the ranked slice)
limit: How many ranked coins to return (optional)
輸入參數limitsymbols
get_crypto_historical
Get crypto historical OHLCV
Daily OHLC price history for a cryptocurrency, covering the whole date range you ask for.
Chart-ready: while the range fits in one response, each row is the price feed's
own daily row — {symbol, date, open, high, low, close, volume, change,
changePercent, vwap} — newest first, ordered for direct plotting as a price history.
A range too long to return day by day is aggregated into coarser OHLC bars
rather than cut short. `interval` names which (weekly/monthly/quarterly/yearly),
each bar spans `date` to `endDate`, and a bar's high/low are that period's real
extremes. Aggregated bars carry the same fields except `vwap`, which the feed
defines per session only. Re-request a narrower from_date/to_date for daily rows.
`summary` always describes the FULL requested window, computed from the daily
data: its first and last close with dates, its high and low with dates, and the
trailing changes the window reaches back far enough to support. Base any
"starting price", "a year ago" or "period high/low" claim on `summary`, or on a
bar that is actually present.
`summary.windowHigh`/`windowLow` describe THIS window. A quote tool's
yearHigh/yearLow are the feed's trailing range, roughly the past 12-13
months — a different period — so label those as trailing-year figures. For the current level alone, call get_crypto_quote.
Args:
symbol: Cryptocurrency symbol (e.g. 'BTCUSD' for Bitcoin)
from_date: Start date YYYY-MM-DD (optional)
to_date: End date YYYY-MM-DD (optional)
輸入參數symbol必填to_datefrom_date
get_crypto_news
Get crypto news
Latest cryptocurrency news — a market-wide feed across all coins (not
filtered to a single asset), ordered newest-first: article headlines,
snippets, and source URLs. Read-only, no side effects.
Use for broad crypto/market headlines. For news about a specific holding
use get_assets_news; for the general (non-crypto) editorial feed use
get_latest_news.
輸入參數page
get_sector_analysis
Get sector-level analysis
Returns sector-level analysis for all 11 US sectors: average P/E, analyst
upside, buy ratio, stock count. Sorted by average analyst upside.
無需輸入參數。
get_market_performance
Get country market performance
Returns market-wide performance for a specific country: average returns,
sector breakdown, top/bottom performers.
Args:
country: Country code: 'us', 'ca', 'gb', 'de', 'il', 'au', 'hk', 'sg', etc.
輸入參數country
get_earnings_history
Get earnings history
Quarterly earnings time series for a ticker. Chart-ready: each
quarter row is {period, report_date, actual_eps, estimate_eps,
eps_surprise_pct, prior_year_eps, eps_yoy_change_pct, actual_revenue,
estimate_revenue, revenue_surprise_pct, net_income, ...}, ordered
oldest-first so a bar chart of actual vs. estimate EPS, or a YoY
trend line, plots directly.
Also returns next_quarter — the upcoming scheduled report with the
consensus estimate, low/high estimate band, and expected report date
— for forward-looking charts.
Use for: "AAPL earnings history", "earnings surprise trend", "did
NVDA beat last quarter", "EPS beat/miss the past 4 quarters".
Args:
ticker: Stock ticker (e.g. 'AAPL', 'NVDA').
quarters: Number of most-recent reported quarters to return
(default 8, max 40).
輸入參數ticker必填quarters
get_financials
Get financial statements
Financial statements time series for a ticker, chart-ready. Each
period is a flat ~25-field object spanning the income statement
(revenue, gross / operating / EBITDA / net margins, EPS, R&D),
the balance sheet (total assets, total debt, total equity, net
debt, cash + short-term investments), the cash flow statement
(operating cash flow, free cash flow, capex, dividends paid,
buybacks), and two computed ratios (current ratio, debt-to-equity).
Margins are emitted as percentages — gross_margin_pct of 49.27
means 49.27%. Cash outflows (dividends_paid, buybacks) are
returned as negative numbers, matching the source convention.
Use for: "AAPL revenue and FCF over the last 10 years", "show
margins trend", "is net debt rising", "EPS growth", "R&D as %
of revenue".
Args:
ticker: Stock ticker (e.g. 'AAPL', 'NVDA').
period: 'annual' (default), 'quarterly', or 'ttm' (trailing
twelve months). Annual periods extend ~9 years back;
quarterly extends ~37 quarters back.
count: Number of most-recent periods to return (default 5,
max 40), ordered oldest-first inside the returned
`periods` array.
輸入參數countperiodticker必填
get_earnings_call_summary
Get earnings call summary
Returns the most recent earnings call summary for a ticker —
management guidance text, overall call sentiment (positive / neutral
/ negative with a one-line rationale), and AI-extracted highlights
and lowlights from the call as {title, content} bullets.
This is a structured summary derived from the call, not the raw
transcript text. Useful for "what did management say about X on the
last call", "was the most recent call bullish or bearish", or
"summarise the highlights from MSFT's latest earnings".
Only the most recent quarter is stored per ticker; for historical
EPS actual-vs-estimate series use get_earnings_history.
Args:
ticker: Stock ticker (e.g. 'AAPL', 'NVDA').
Returns:
{ ticker, fiscal_year, fiscal_quarter, guidance,
sentiment: { label, summary },
highlights: [ { title, content }, ... ],
lowlights: [ { title, content }, ... ] }
輸入參數ticker必填
get_ai_stock_analysis
Get AI Stock Analysis scores
TipRanks AI Stock Analysis — the 0-100 AI score for one or more stocks.
Six frontier models (OpenAI, Anthropic, Gemini, xAI, DeepSeek, Perplexity)
research each covered stock independently. Every model returns its own
0-100 score, rating (outperform / neutral / underperform), price target,
and a weighted factor breakdown across financial performance, technical
analysis, valuation, earnings call and corporate events.
Use for: "what's the AI score for NVDA", "AI rating on my watchlist",
"compare the AI scores of AAPL, MSFT and NVDA", "why do the models
disagree on Tesla".
Pass every symbol in one call — a multi-ticker call returns one compact row
per ticker, which is what a watchlist or ranking question needs. A single
ticker also returns every model's score with its factor breakdown plus the
bull and bear key points.
This is NOT the Smart Score (1-10, eight quantitative factors). It is a
separate system, and the two routinely disagree by design.
`ai_score` is the headline score and matches the AI Stock Analysis page;
`consensus` holds the cross-model average, the high and low scoring models,
and the split of rating labels. `upside_pct` is the model's price target
against the current price. `as_of` is when the report was generated —
reports regenerate on new earnings or a significant price move, so an older
date means nothing material has changed since.
Coverage is a subset of the stock universe and excludes ETFs. Symbols with
no report at all come back under `not_covered`; symbols that are covered but
lack a report from the requested `provider` come back separately under
`no_report_from_provider`, each listing the models that did score them — so
a missing provider is never reported as "this stock has no AI analysis".
Args:
tickers: Comma-separated tickers (e.g. 'AAPL' or 'AAPL,MSFT'), max 25.
provider: Optional single provider to report on. O
輸入參數detailtickers必填provider
get_dividend_history
Get dividend history
Dividend payment history for a ticker. Chart-ready: includes the
current snapshot (yield %, payout ratio, frequency, annualised
payout) plus two time series — a per-payment list
[{ex_date, pay_date, amount, yield_pct, is_special, ...}] (newest
first, capped at `count`) and an annual_totals list
[{year, amount, yield_pct}] suitable for a yearly bar chart.
All yields are emitted as percentages (4.5 = 4.5%), so plots don't
need to know which underlying field used decimal vs. percentage
encoding.
Use for: "AAPL dividend history", "yield trend over 5 years",
"dividend growth chart", "is the payout sustainable".
Args:
ticker: Stock ticker (e.g. 'AAPL', 'JNJ').
count: Number of most-recent individual payments to return
(default 16, max 100). The annual_totals series is
always returned in full.
輸入參數countticker必填
get_stock_quotes
Get real-time stock quotes
Real-time price quote for one or more stocks or ETFs.
Returns price, intraday OHLC, day change (amount + percent), volume,
previous close, market cap, currency, exchange, and market-state
flags (is_market_open / is_premarket / is_after_market). When
extended-hours data is present, the entry includes a
`pre_post_market` block — when the regular session is closed,
that's the freshest price.
For forex pairs use get_forex_quote; this endpoint is stocks/ETFs only.
Args:
tickers: Comma-separated tickers (e.g. 'AAPL' or 'AAPL,MSFT,NVDA').
輸入參數tickers必填
get_stock_prices
Get historical stock price series
Historical daily closing prices for up to 5 stocks or ETFs.
Per ticker: {ticker, period, series:[{date, price}], summary} with
summary fields first_price, last_price, change_pct, high, low,
trading_days. Series is downsampled to ~250 evenly-spaced points
(latest point always retained) so the payload stays small for charting.
`period` must be one of: 1m, 3m, 6m, ytd, 1y, 2y, 3y, 5y, all.
Args:
tickers: Comma-separated tickers, up to 5 (e.g. 'AAPL,MSFT').
period: Lookback window (default 'ytd').
輸入參數periodtickers必填
get_stock_catalyst
Get AI catalyst summary for stocks
TipRanks-generated catalyst summary explaining why a stock is moving.
Each entry: {ticker, summary, sentiment, updated} where sentiment is
'positive' | 'neutral' | 'negative'. Updated throughout the trading
day. Use to explain today's move for a specific stock.
Args:
tickers: Comma-separated tickers (e.g. 'AMZN' or 'AMZN,NVDA').
輸入參數tickers必填
get_insider_transactions
Get insider transactions
Individual corporate-insider (officers/directors, Form 4) transactions for
a ticker, newest first.
Each row: insider_name, role, is_officer, is_director, action (e.g.
"Auto Sell", "Grant/Award/Other Acquisition"), side (buy/sell), shares,
price (approximate — value / shares; the source has no exact price), value,
date, filing_link (the SEC Form-4 URL), and insider_stars.
This is corporate-insider activity (Form 4). For retail/individual
investor sentiment, use get_assets_data and read investorActivity.
Args:
ticker: Stock ticker (e.g. 'AAPL').
limit: Max rows to return (default 30, max 100).
輸入參數limitticker必填
get_hedge_fund_holdings
Get hedge fund holdings history
Hedge-fund share-count history for a ticker.
Returns the most recent `limit` snapshots (max 60) plus a summary
block (snapshot_count, first/last date and shares). Each row:
{date, shares}. Sourced from quarterly 13F filings; lags by up to
45 days.
For a snapshot of current sentiment without the timeseries, use
get_assets_data and read hedgeFundSentimentData.
Args:
ticker: Stock ticker (e.g. 'AAPL').
limit: Max snapshots to return (default 60, max 60).
輸入參數limitticker必填
get_etf_holdings
Get ETF constituents and weights
List the constituents of an ETF.
Base mode (default): returns every holding with its weight % in the
index — {ticker, name, weight_pct}.
Top-performers mode: pass `sort_by` (one of '5d', 'month', 'ytd',
'year') and a `limit` > 0 to get the top N constituents by that
period's return. Each row carries weight_pct, current_price,
return_pct for the chosen period, and analyst_consensus.
Use the top-performers mode for questions like 'which stocks in XLK
rose most this week' without separately calling a screener.
Args:
ticker: ETF ticker (e.g. 'SPY', 'QQQ').
sort_by: '' for full list, or one of '5d', 'month', 'ytd', 'year'.
limit: 0 to return all constituents; >0 (max 50) to return top N. A
negative or non-numeric limit is REJECTED rather than treated as 0 —
`limit` picks the mode here, so defaulting an unusable one would
answer a ranked top-N request with the full unranked list.
輸入參數limitticker必填sort_by
get_analysts_by_firm
List analysts by firm
List analysts at a given firm (case-insensitive substring match).
Each row: {name, firm, rank, avg_return_1y_pct, covered_tickers_sample,
total_covered}. Results are deduped by analyst name (keeping the best
rank) and sorted by rank ascending.
When `sector` is provided, the per-analyst coverage list is filtered
to tickers in that sector and the row shape becomes {name, firm,
rank, avg_return_1y_pct, sector, covered_tickers}.
Args:
firm: Firm name or fragment (e.g. 'Goldman' matches 'Goldman Sachs').
sector: Optional lowercase sector (e.g. 'technology', 'healthcare').
輸入參數firm必填sector
get_recent_analyst_ratings
Get recent analyst ratings
Recent Wall Street analyst rating actions on a single stock, covering the
trailing 12 months (newest first).
`ratings` holds one row per analyst, their latest rating, newest first.
Each row carries the analyst's name and firm, the rating
(Buy/Hold/Sell), the action (initiated/upgraded/downgraded/reiterated/
maintained), the price target, and the analyst's TipRanks credibility
(numOfStars 0-5, rank, successRate as a fraction, excessReturn as the
average return) plus the source article title/quote.
`counts` gives exact last30Days / last90Days / last12Months totals
(analysts whose latest rating falls in the window, split buy/hold/sell) over
every rating fetched, as of `asOf`; answer 'how many analysts rated X in the
past month' from `counts`, since a long list may show only its newest rows.
For the aggregate consensus and average/best price target, use
get_assets_data instead.
Args:
ticker: Stock ticker (e.g. 'NVDA', 'AAPL').
Returns: {ticker, asOf, totalRatings, counts, ratings}. recommendationDate is
a 'MM/DD/YYYY' string; numOfStars is the analyst's 0-5 TipRanks star rating.
輸入參數ticker必填
get_options_expirations
List option expirations
List future expiration dates for a ticker's listed options.
Excludes past expirations. Use the result as input to get_options_chain.
Also use it FIRST when the user asks for greeks, IV or delta on a
ticker's options: the chain it leads to is the data we can present.
Args:
ticker: Underlying ticker (e.g. 'AAPL').
輸入參數ticker必填
get_options_chain
Get option chain
Contracts at one expiration, enriched with price + OI + volume.
Each row: ticker (OCC), contract_type, strike, name, price, volume,
open_interest, open_interest_change, change_percent, day_open / high /
low, last_trade_date.
Quotes are typically delayed ~15 minutes.
GREEKS AND IV: the results carry price, open interest and volume;
delta/gamma/theta/vega and implied volatility are not part of this
data. When the user asks for greeks, IV or a '30-delta call' style
query, fetch the chain first (get_options_expirations, then this
tool), present the matching strikes with price, open interest and
volume, and state plainly that greeks and IV are unavailable. Report
only values that appear in the results, and leave delta and IV
unestimated, including rules of thumb.
Args:
ticker: Underlying (e.g. 'AAPL').
expiration_date: One of the dates from get_options_expirations
(YYYY-MM-DD).
contract_type: '' for both, or 'call' or 'put'.
strike_gte: Filter strikes >= this value (optional).
strike_lte: Filter strikes <= this value (optional).
limit: Max contracts to return (default 50).
輸入參數limitticker必填strike_gtestrike_ltecontract_typeexpiration_date必填
get_options_contract
Get option contract snapshot
Snapshot one OCC contract — price, OI, intraday OHLCV, last trade.
The contract_ticker is an OCC-format symbol like 'O:AAPL260520C00205000'
(O: + underlying + YYMMDD + C/P + strike-in-thousandths-8-digits).
The 'O:' prefix is optional.
Quotes are typically delayed ~15 minutes.
GREEKS AND IV: the results carry price, OI, OI change, volume, day OHLC
and last_trade_date; delta/gamma/theta/vega, implied volatility and
bid/ask are not part of this data. When the user asks for them, call
this tool, present what it returns, and state plainly that those fields
are unavailable. Report only values that appear in the results, and
leave greeks and IV unestimated, including rules of thumb.
Args:
contract_ticker: OCC contract symbol.
輸入參數contract_ticker必填
get_options_unusual_trades
Get unusual option trades
Recent unusual option trades for an underlying (size/sweep alerts).
Returns the most recent `limit` flagged trades with the side, strike,
expiry, size, and notional value. Useful for spotting large bullish
or bearish positioning.
Args:
ticker: Underlying ticker (e.g. 'AAPL').
limit: Max trades to return (default 25).
輸入參數limitticker必填
get_my_usage
Get my MCP usage
Your current TipRanks MCP usage against the monthly tool-call quota.
Reports calls used this calendar month, your limit, how many remain, your
plan tier, and when the quota resets (UTC). Handy to check before running a
large batch of calls. This call is free — it never counts against the quota.
What counts: every tool call is metered once whether or not it returns data,
so an unrecognised ticker or an invalid argument costs the same as a
successful call. The connection handshake (initialize, tools/list and the
other discovery calls) is never metered, and neither is this tool.
Calls refused for being over the limit are refunded on both ladders, so
`used` settles at the cap rather than climbing while a client retries. It
can still read higher than `limit` when the ceiling FELL mid-month — a
complimentary grant expiring or being revoked, or a paid MCP subscription
lapsing — and there it is the count of calls genuinely served before the
cap dropped.
無需輸入參數。