Search Instruments
Search instruments by symbol, alternate identifier, or company name.
The q parameter is case-insensitive and supports ticker symbols, alternate identifiers such as CUSIP, ISIN, and OPRA root, and company names for non-option instruments. Results are ranked by match quality plus instrument quality signals and relevance. Defaults to the EQUITY asset class (common stocks, preferred shares, ADRs, ETFs, and exchange-traded mutual funds). Pass asset_class=OPTION to search option contracts: by full OSI symbol, by an OSI prefix (root + YYMMDD expiry, e.g. AAPL 261217), or by a root-scoped phrase such as AAPL Dec 250 call.
Query parameters
Search term applied case-insensitively to ticker symbols, alternate identifiers (CUSIP, ISIN, OPRA root), and company names for non-option instruments. Option searches match symbols and alternate identifiers.
Comma-separated asset classes (EQUITY|OPTION|WARRANT|BOND|FX|OTHER). Defaults to EQUITY.
Include inactive instruments. Default false.
Include publicly traded partnership (PTP) instruments. Default true (penalized in ranking).
Optional ISO currency filter (e.g., USD).
Optional listing-country filter (e.g., US).
The number of items to return per page. Only used when page_token is not provided.
Base64URL-encoded pagination token
Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.
Response
Ranked list of matching instruments
Example response
{
"error": {
"code": 400,
"message": "Order quantity must be greater than zero"
},
"data": [
{
"country_of_issue": "US",
"currency": "USD",
"easy_to_borrow": true,
"id": "0f5a1a4e-5b3e-4d8f-9b7a-2b1d0e3f4a5b",
"instrument_type": "COMMON_STOCK",
"is_fractionable": false,
"is_liquidation_only": false,
"is_marginable": true,
"is_ptp": false,
"is_short_prohibited": false,
"is_threshold_security": false,
"is_tradable": true,
"long_margin_rate": "0.25",
"name": "Apple Inc.",
"short_margin_rate": "0.25",
"symbol": "AAPL",
"venue": "XNMS"
}
]
}