Search Symbols
Searches for trading symbols across multiple asset classes including stocks, ETFs, and options using query string matching. Supports prefix-based search for equities and dot-prefix search for options chains with intelligent filtering.
Use Case: Autocomplete and symbol lookup with correct prefix rules (.AAPL, /ES) and a predictable maximum number of results.
Documentation Index
Fetch the complete documentation index at: https://finance.dev/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The symbol search endpoint finds symbols across stocks, indices, options, and futures. Only two prefixes change how your query is interpreted: a leading. for options and a leading / for futures. Any other leading character (including !) is treated as normal search text, not as a special prefix.
Query syntax (prefixes)
| Prefix | Meaning | Example |
|---|---|---|
| (none) | Search stocks and indices (combined results). | ES, AAPL |
. | Search options (option-chain style lookup on the text after the dot). | .AAPL, .ES |
/ | Search futures (leading slash is stripped for the underlying lookup). | /ES |
! | Not supported as a prefix. !ES is searched like a literal string, not “options only.” | — |
ES can match both equities and index-related symbols; .ES and /ES target options vs futures respectively, which is why results and descriptions can differ for what looks like the “same” letters.
Search Types
Equity and index search (no prefix)
Search stocks and indices by symbol or name. Results can include both asset classes.Options search (. prefix)
Prefix with . (not !):
Futures search (/ prefix)
Prefix with /:
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Search term. Use . for options and / for futures; see Query syntax. |
limit | integer | No | Maximum number of results returned (1–100, default 20). The response never contains more than limit items. Unprefixed queries merge stock and index matches, then rank and trim to this cap. Prefer . or / when you want a single asset class without mixing. |
Response Format
The handler returns a JSON array at the top level (noresults object). Each element has symbol, description, tag (exchange or source tag such as XNAS or OPRA), and type (stock, index, option, or future). The sample below matches the OpenAPI example:
Search Examples
Stock Search
Option Search
Error Handling
The endpoint returns standard HTTP status codes:200- Success400- Bad request (missing query parameter)401- Unauthorized (invalid API key or token)500- Internal server error
Rate Limits
This endpoint is subject to standard API rate limits. See the main API documentation for current limits.Tips
- Use
.for options and/for futures; do not rely on!— it is not a documented prefix. - Use specific symbols or names for tighter matches; very short queries (for example
ES) can return broader mixes of symbols. - Options search with a
.prefix is for option-chain style discovery; descriptions come from the upstream search provider. - Set
limitto bound payload size; the API enforces it after merging stock and index results for unprefixed queries.
Authorizations
OAuth2 Bearer token: obtain an access token from the token endpoint and send it in the Authorization header.
Query Parameters
Text the user entered in symbol search. Use AAPL for stocks and indices, .AAPL for option-chain style searches, and /ES for futures. Do not use ! as a special prefix; it is treated as literal text.
1Maximum number of matches to return. Use a small number for autocomplete and a larger number for full search pages. Default is 20; minimum is 1; maximum is 100.
1 <= x <= 100Response
Search results retrieved successfully
Human-readable company or security name. Show this next to the symbol so users can confirm they selected the intended instrument.
Symbol value to pass into quote, chart, research, or order endpoints. Use the exact case returned here.
Exchange or source tag, such as XNAS for Nasdaq or OPRA for options. Use it for display or filtering when multiple instruments share similar symbols.
Security class returned by search. Supported values are stock, index, option, and future. Use this to decide whether to show equity, index, option, or futures workflows.
[
{
"symbol": "AAPL",
"description": "Apple Inc.",
"tag": "XNAS",
"type": "stock"
},
{
"symbol": "AAPL240119C00190000",
"description": "AAPL Jan 19 2024 190 Call",
"tag": "OPRA",
"type": "option"
}
]