Equity Research

OpenAlice provides a suite of equity research tools powered by the OpenBB data engine. These work out of the box with no API keys — the default yfinance provider is free.

Available Tools

equityGetProfile

Company overview combined with key valuation metrics.

Returns: name, sector, industry, description, website, CEO, employee count, market cap, PE ratio, PB ratio, EV/EBITDA, dividend yield, and more.

You: Tell me about Apple.

Alice: [calls equityGetProfile("AAPL")]

      Apple Inc (AAPL) — Technology / Consumer Electronics
      Market Cap: $3.2T | PE: 32.5 | Dividend Yield: 0.5%
      ...

equityGetFinancials

Financial statements: income statement, balance sheet, or cash flow.

Parameters:

• type — income, balance, or cash
• period — annual or quarter (default: annual)
• limit — Number of periods (default: 5)

You: Show me Apple's quarterly income for the last 4 quarters.

Alice: [calls equityGetFinancials("AAPL", type="income", period="quarter", limit=4)]

equityGetRatios

Financial ratios across profitability, liquidity, leverage, and efficiency.

Returns: ROE, ROA, gross margin, net margin, operating margin, current ratio, quick ratio, debt/equity, asset turnover, inventory turnover.

equityGetEstimates

Analyst consensus estimates.

Returns: buy/hold/sell counts, average target price, EPS estimates. Useful for understanding market sentiment on a stock.

equityGetEarningsCalendar

Upcoming and recent earnings release dates.

Parameters:

• symbol — Specific company (optional)
• start_date / end_date — Date range for market-wide calendar

Check the earnings calendar before holding positions through earnings — these events carry significant risk.

equityGetInsiderTrading

Recent buy/sell transactions by company insiders (executives, directors, major shareholders).

Parameters:

• symbol — Company ticker
• limit — Number of transactions (default: 20)

Insider buying is often a bullish signal. Large insider selling may warrant caution.

equityDiscover

Market movers — what's trending right now.

Parameters:

• type — gainers (top price gainers), losers (top losers), or active (most traded by volume)

You: What are the top gainers today?

Alice: [calls equityDiscover(type="gainers")]

      Top Gainers:
      1. XYZ Corp +15.2% — earnings beat
      2. ABC Inc +12.8% — FDA approval
      ...

Data Providers

The default provider is yfinance (free, no API key). For some tools, premium providers offer additional data:

Add provider API keys in data/config/market-data.json:

{
  "providerKeys": {
    "fmp": "your-fmp-key"
  }
}

Usage Tips

• Always use marketSearchForResearch first if you're unsure of the exact symbol
• Financial data is fetched live — no caching, always current
• Combine multiple tools for comprehensive analysis: profile for overview, financials for fundamentals, estimates for sentiment, insider trading for signals