## Search Instruments

`client.V1.Instruments.SearchInstruments(ctx, query) (*V1InstrumentSearchInstrumentsResponse, error)`

**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.

### Parameters

- `query V1InstrumentSearchInstrumentsParams`

  - `Q param.Field[string]`

    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.

  - `AssetClass param.Field[string]`

    Comma-separated asset classes (EQUITY|OPTION|WARRANT|BOND|FX|OTHER). Defaults to EQUITY.

  - `Country param.Field[string]`

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

  - `Currency param.Field[string]`

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

  - `IncludeInactive param.Field[bool]`

    Include inactive instruments. Default false.

  - `IncludeRestricted param.Field[bool]`

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

  - `PageSize param.Field[int64]`

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

  - `PageToken param.Field[string]`

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

### Returns

- `type V1InstrumentSearchInstrumentsResponse struct{…}`

  - `Data InstrumentCoreList`

    - `ID string`

      Unique OEMS instrument identifier (UUID)

    - `CountryOfIssue string`

      The ISO country code of the instrument's issue

    - `Currency string`

      The ISO currency code in which the instrument is traded

    - `EasyToBorrow bool`

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

    - `IsLiquidationOnly bool`

      Indicates if the instrument is liquidation only and cannot be bought

    - `IsMarginable bool`

      Indicates if the instrument is marginable

    - `IsRestricted bool`

      Indicates if the instrument is restricted from trading

    - `IsShortProhibited bool`

      Indicates if short selling is prohibited for the instrument

    - `IsThresholdSecurity bool`

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

    - `IsTradable bool`

      Indicates if the instrument is tradable

    - `Symbol string`

      The trading symbol for the instrument

    - `Venue string`

      The MIC code of the primary listing venue

    - `Adv string`

      Average daily share volume from the security definition.

    - `Expiry Time`

      The expiration date for options instruments

    - `InstrumentType SecurityType`

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

      - `const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"`

      - `const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"`

      - `const SecurityTypeOption SecurityType = "OPTION"`

      - `const SecurityTypeCash SecurityType = "CASH"`

      - `const SecurityTypeOther SecurityType = "OTHER"`

    - `LongMarginRate string`

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

    - `Name string`

      The full name of the instrument or its issuer

    - `NotionalAdv string`

      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.

    - `PreviousClose string`

      Last close price from the security definition.

    - `ShortMarginRate string`

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

    - `StrikePrice string`

      The strike price for options instruments

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.Instruments.SearchInstruments(context.TODO(), clearstreet.V1InstrumentSearchInstrumentsParams{
    Q: "q",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}
```

#### Response

```json
{
  "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": "..."
  }
}
```