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.
. for options and a leading / for futures. Any other leading character (including !) is treated as normal search text, not as a special prefix.
| 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.
. prefix). (not !):
/ prefix)/:
| 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. |
results 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:
200 - Success400 - Bad request (missing query parameter)401 - Unauthorized (invalid API key or token)500 - Internal server error. for options and / for futures; do not rely on ! — it is not a documented prefix.ES) can return broader mixes of symbols.. prefix is for option-chain style discovery; descriptions come from the upstream search provider.limit to bound payload size; the API enforces it after merging stock and index results for unprefixed queries.OAuth2 Bearer token: obtain an access token from the token endpoint and send it in the Authorization header.
Search query (required). Prefix with '.' for options (not '!') and '/' for futures. Other characters (including '!') are literal. Examples: 'AAPL' (stocks/indices), '.AAPL' (options), '/ES' (futures).
1Maximum number of results returned (optional). Default 20, min 1, max 100. The response is capped at this value after merging and ranking (including unprefixed stock+index searches).
1 <= x <= 100Search results retrieved successfully
[
{
"symbol": "AAPL",
"description": "Apple Inc.",
"tag": "XNAS",
"type": "stock"
},
{
"symbol": "AAPL240119C00190000",
"description": "AAPL Jan 19 2024 190 Call",
"tag": "OPRA",
"type": "option"
}
]