Skip to main content
The yf_lookup tool provides targeted ticker symbol lookup with filtering by asset type. It’s more focused than search and returns only ticker symbols and basic identification information.

​
Parameters

​
query
string
required
Lookup query string. Typically a ticker symbol, partial symbol, or company name.
​
kind
string
default:"all"
Filter results by asset type.Options:
  • all - All asset types
  • stock - Stocks/equities
  • mutualfund - Mutual funds
  • etf - Exchange-traded funds
  • index - Market indices
  • future - Futures contracts
  • currency - Currencies
  • cryptocurrency - Cryptocurrencies
​
count
integer
default:10
Maximum number of results to return.Constraints: Min: 1, Max: 100

​
Output Options

​
response_format
string
default:"json"
Format of the response data.Options: json, markdown
​
preview_limit
integer
default:25
Number of rows to preview when using markdown format.Constraints: Min: 1, Max: 200
​
save
object
Save the results to a file.

​
Use Cases

​
Find Stocks Only

Filter lookup results to show only stock equities: 
{
  "query": "Apple",
  "kind": "stock",
  "count": 5
}

​
Look Up ETFs

Find ETFs matching a search term: 
{
  "query": "S&P 500",
  "kind": "etf",
  "count": 10
}

​
Cryptocurrency Lookup

Search for cryptocurrency tickers: 
{
  "query": "Bitcoin",
  "kind": "cryptocurrency",
  "count": 5
}

​
Futures Contracts

Find futures contracts: 
{
  "query": "crude oil",
  "kind": "future",
  "count": 15
}

​
Asset Type Filtering

The kind parameter helps you narrow down results when:
  • You’re building a portfolio with specific asset types
  • You want to avoid confusion between stocks and ETFs with similar names
  • You’re analyzing a specific market segment (e.g., only mutual funds)
  • You need futures or currency symbols for derivatives trading

​
Response Structure

Lookup returns an array of matches with:
  • Symbol: Ticker symbol
  • Name: Full name of the security
  • Exchange: Trading exchange
  • Type: Asset type (matches the kind parameter if specified)
When to use yf_lookup:
  • You need to filter by specific asset types
  • You want a simpler, faster response without news or research
  • You’re building type-specific queries (e.g., all ETFs matching a term)
When to use yf_search:
  • You want comprehensive results including news and research
  • You need more context about the securities
  • You’re doing exploratory discovery
Use kind="stock" when you want to ensure you’re getting equity tickers and not funds or derivatives with similar names.

Build docs developers (and LLMs) love

Get started for freeTalk to us