discovery
Surface market-wide ideas without a ticker: scan stock, ETF, index, forex, commodity and crypto lists, screeners, gainers and losers, sector performance, calendars, filings and news feeds.
Instructions
Market discovery (lists of stocks, ETFs, indices, currencies, commodities and cryptocurrencies, stock screener, biggest gainers and losers, most active stocks, sector and industry performance and P/E, earnings, IPO and stock split calendars, latest 8-K filings, insider trades and mergers, market news and press releases). No tickers or countries needed. The news and press release feeds (get_stock_news, get_press_releases, get_general_news, get_crypto_news, get_forex_news) are the latest articles across the whole market, not news about one company: each article names its ticker, but the feed cannot be narrowed to a ticker. The calendars and filings take start_date/end_date; the market-wide earnings calendar covers the coming week unless a range is given. Sector and industry performance and P/E take date= for one day's snapshot or sector=/industry= for a history (the last year unless start_date/end_date say otherwise); they average the companies of one exchange, exchange='NASDAQ' (default), 'NYSE' or 'AMEX', and performance is a decimal change (0.0125 is +1.25%). The stock screener ranks by market cap in US dollars ('Market Cap (USD)'; 'Market Cap' is in the listing's own currency) and returns every listing of a company unless primary_only=true; to screen by classification, use the Finance Database server. get_index_constituents lists the members of index='S&P 500', 'NASDAQ 100' or 'Dow Jones'.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | For get_industry_pe, get_industry_performance, get_sector_pe, get_sector_performance: The date to retrieve a snapshot for, e.g. "2024-02-01". For get_insider_trading_latest: Only return the trades filed on this date. | |
| page | No | For get_delisted_stocks: The page of results to retrieve, starting at 0. For get_insider_trading_latest, get_mergers_acquisitions_latest, get_sec_filings_8k: The page number to retrieve. | |
| index | No | "S&P 500", "NASDAQ 100" or "Dow Jones". | S&P 500 |
| limit | No | The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length. Leave unset to use the default of the indicator you selected. Defaults are 100 for get_crypto_news, get_delisted_stocks, get_forex_news, get_general_news, get_insider_trading_latest, get_mergers_acquisitions_latest, get_press_releases, get_sec_filings_8k, get_stock_news; 1000 for get_stock_screener. | |
| pages | No | The number of pages to collect, each page is a separate API call, e.g. pages=5 makes 5 calls. | |
| is_etf | No | Whether to restrict the screen to ETFs or to exclude them. | |
| sector | No | For get_sector_pe, get_sector_performance: The sector to retrieve the history for, e.g. "Energy". For get_stock_screener: The sector to restrict the screen to, e.g. "Energy". | |
| country | No | The two-letter country code to restrict the screen to, e.g. "US". | |
| end_date | No | End of the date range in YYYY-MM-DD format. | |
| exchange | No | For get_industry_pe, get_industry_performance, get_sector_pe, get_sector_performance, get_sectors_performance: The exchange whose companies are averaged, "NASDAQ", "NYSE" or "AMEX". For get_stock_screener: The exchange code to restrict the screen to, e.g. "NASDAQ". Leave unset to use the default of the indicator you selected. Defaults are 'NASDAQ' for get_industry_pe, get_industry_performance, get_sector_pe, get_sector_performance, get_sectors_performance; None for get_stock_screener. | |
| industry | No | For get_industry_pe, get_industry_performance: The industry to retrieve the history for, e.g. "Biotechnology". For get_stock_screener: The industry to restrict the screen to, e.g. "Biotechnology". | |
| indicator | Yes | Name of the specific metric to calculate, one of the listed values. Required — search_metrics finds the indicator (and its tool) for a metric by name. | |
| beta_lower | No | The maximum beta of the stock. | |
| start_date | No | Start of the date range in YYYY-MM-DD format. | |
| beta_higher | No | The minimum beta of the stock. | |
| price_lower | No | The maximum price of the stock. | |
| price_higher | No | The minimum price of the stock. | |
| primary_only | No | Set to true to keep only the most traded listing of each company rather than every listing (e.g. ING in Amsterdam, New York, Toronto and Frankfurt). | |
| show_columns | No | Comma-separated names to filter the output. For historical data use the key names visible in any response record (e.g. 'Close,Volume,Return'). For financial statements use the 'metric' field values from the response (e.g. 'Revenue,Net Income,EBITDA'). Call the tool once without this parameter to see all available names, then repeat with show_columns to reduce response size and token usage. | |
| volume_lower | No | The maximum volume of the stock. | |
| volume_higher | No | The minimum volume of the stock, in shares traded. | |
| dividend_lower | No | The maximum dividend of the stock. | |
| dividend_higher | No | The minimum dividend of the stock, as an amount per share over the last annual period rather than as a yield. | |
| market_cap_lower | No | The maximum market capitalization of the stock in US dollars. | |
| market_cap_higher | No | The minimum market capitalization of the stock in US dollars (not in millions), e.g. 1_000_000_000 for $1 billion. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |