Overview
The symbol search endpoint allows you to find trading symbols across different asset classes including stocks, ETFs, and options. The endpoint supports both equity and options search with intelligent filtering.Search Types
Equity Search
Search for stocks, ETFs, and other equity securities by providing the symbol or company name:Options Search
Search for options by prefixing your query with a dot (.
):
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
query | string | Yes | Search term. Use . prefix for options |
limit | integer | No | Max results (1-100, default: 20) |
Response Format
The endpoint returns an array of search results with the following structure: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 specific symbols for exact matches
- Partial company names work for broader searches
- Options search with
.
prefix provides comprehensive option chain results - Limit parameter helps control response size for better performance
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Search query. Use '.' prefix for options search (e.g., '.AAPL')
Minimum length:
1
Maximum number of results to return
Required range:
1 <= x <= 100