Search Instruments

InstrumentSearchInstrumentsResponse v1().instruments().searchInstruments(, )

GET/v1/instruments/search

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, OPRA root, and CMS identifiers, and company names for non-option instruments. Results are ranked by match quality plus instrument quality signals including log-scaled ADV, listing status, marginability, easy-to-borrow status, and OTC, restricted, and liquidation-only penalties. 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 symbol or alternate identifier.

ParametersExpand Collapse

InstrumentSearchInstrumentsParams params

String q

Search term applied case-insensitively to ticker symbols, alternate identifiers (CUSIP, ISIN, OPRA root, CMS), and company names for non-option instruments. Option searches match symbols and alternate identifiers.

Optional<String> assetClass

Optional<String> country

Optional listing-country filter (e.g., US).

Optional<String> currency

Optional ISO currency filter (e.g., USD).

Optional<Boolean> includeInactive

Include inactive instruments. Default false.

Optional<Boolean> includeRestricted

Include restricted instruments. Default true (penalized in ranking).

Optional<Long> pageSize

The number of items to return per page. Only used when page_token is not provided.

formatint64

maximum100

minimum1

Optional<String> pageToken

Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.

formatbyte

ReturnsExpand Collapse

class InstrumentSearchInstrumentsResponse:

List<InstrumentCore> data

String id

Unique OEMS instrument identifier (UUID)

formatuuid

String countryOfIssue

The ISO country code of the instrument’s issue

String currency

The ISO currency code in which the instrument is traded

boolean easyToBorrow

Indicates if the instrument is classified as Easy-To-Borrow

boolean isLiquidationOnly

Indicates if the instrument is liquidation only and cannot be bought

boolean isMarginable

Indicates if the instrument is marginable

boolean isRestricted

Indicates if the instrument is restricted from trading

boolean isShortProhibited

Indicates if short selling is prohibited for the instrument

boolean isThresholdSecurity

Indicates if the instrument is on the Regulation SHO Threshold Security List

boolean isTradable

Indicates if the instrument is tradable

String symbol

The trading symbol for the instrument

String venue

The MIC code of the primary listing venue

Optional<String> adv

Average daily share volume from the security definition.

Optional<LocalDate> expiry

The expiration date for options instruments

formatdate

Optional<SecurityType> instrumentType

The type of security (e.g., Common Stock, ETF)

One of the following:

COMMON_STOCK("COMMON_STOCK")

PREFERRED_STOCK("PREFERRED_STOCK")

OPTION("OPTION")

CASH("CASH")

OTHER("OTHER")

Optional<String> longMarginRate

The percent of a long position’s value you must post as margin

Optional<String> name

The full name of the instrument or its issuer

Optional<String> notionalAdv

Notional ADV (adv × previous_close). The primary liquidity signal used by /instruments/search ranking. Computed at response time so it stays consistent with whatever adv and previous_close show.

Optional<String> previousClose

Last close price from the security definition.

Optional<String> shortMarginRate

The percent of a short position’s value you must post as margin

Optional<String> strikePrice

The strike price for options instruments

Search Instruments

package com.clear_street.api.example;

import com.clear_street.api.client.ClearStreetClient;
import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient;
import com.clear_street.api.models.v1.instruments.InstrumentSearchInstrumentsParams;
import com.clear_street.api.models.v1.instruments.InstrumentSearchInstrumentsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        InstrumentSearchInstrumentsParams params = InstrumentSearchInstrumentsParams.builder()
            .q("q")
            .build();
        InstrumentSearchInstrumentsResponse response = client.v1().instruments().searchInstruments(params);
    }
}

{
  "data": [
    {
      "currency": "USD",
      "id": "0f5a1a4e-5b3e-4d8f-9b7a-2b1d0e3f4a5b",
      "instrument_type": "COMMON_STOCK",
      "is_marginable": true,
      "name": "Apple Inc.",
      "symbol": "AAPL",
      "venue": "XNMS"
    }
  ],
  "error": null,
  "metadata": {
    "request_id": "..."
  }
}

{
  "data": [
    {
      "country_of_issue": "US",
      "currency": "USD",
      "easy_to_borrow": true,
      "id": "0f5a1a4e-5b3e-4d8f-9b7a-2b1d0e3f4a5b",
      "instrument_type": "COMMON_STOCK",
      "is_liquidation_only": false,
      "is_marginable": true,
      "is_restricted": false,
      "is_short_prohibited": false,
      "is_threshold_security": false,
      "is_tradable": true,
      "name": "Apple Inc.",
      "symbol": "AAPL",
      "venue": "XNMS"
    }
  ],
  "error": null,
  "metadata": {
    "request_id": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e"
  }
}

Returns Examples

{
  "data": [
    {
      "currency": "USD",
      "id": "0f5a1a4e-5b3e-4d8f-9b7a-2b1d0e3f4a5b",
      "instrument_type": "COMMON_STOCK",
      "is_marginable": true,
      "name": "Apple Inc.",
      "symbol": "AAPL",
      "venue": "XNMS"
    }
  ],
  "error": null,
  "metadata": {
    "request_id": "..."
  }
}

{
  "data": [
    {
      "country_of_issue": "US",
      "currency": "USD",
      "easy_to_borrow": true,
      "id": "0f5a1a4e-5b3e-4d8f-9b7a-2b1d0e3f4a5b",
      "instrument_type": "COMMON_STOCK",
      "is_liquidation_only": false,
      "is_marginable": true,
      "is_restricted": false,
      "is_short_prohibited": false,
      "is_threshold_security": false,
      "is_tradable": true,
      "name": "Apple Inc.",
      "symbol": "AAPL",
      "venue": "XNMS"
    }
  ],
  "error": null,
  "metadata": {
    "request_id": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e"
  }
}