## Get Instruments

`v1.instruments.get_instruments(InstrumentGetInstrumentsParams**kwargs)  -> InstrumentGetInstrumentsResponse`

**get** `/v1/instruments`

Retrieves a list of tradeable instruments.

### Parameters

- `easy_to_borrow: Optional[bool]`

  Filter by easy to borrow status

- `instrument_ids: Optional[Sequence[str]]`

  Comma-separated OEMS instrument UUIDs

- `instrument_type: Optional[Literal["COMMON_STOCK", "PREFERRED_STOCK", "OPTION", 2 more]]`

  Filter by instrument type. OPTION is not supported on this endpoint; use GET /instruments/options/contracts to list option contracts. If omitted, returns all supported instrument types except options.

  - `"COMMON_STOCK"`

  - `"PREFERRED_STOCK"`

  - `"OPTION"`

  - `"CASH"`

  - `"OTHER"`

- `is_liquidation_only: Optional[bool]`

  Filter by liquidation only status

- `is_marginable: Optional[bool]`

  Filter by marginable status

- `is_restricted: Optional[bool]`

  Filter by restricted status

- `is_short_prohibited: Optional[bool]`

  Filter by short prohibited status

- `is_threshold_security: Optional[bool]`

  Filter by threshold security status

- `page_size: Optional[int]`

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

- `page_token: Optional[Union[str, Base64FileInput]]`

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

### Returns

- `class InstrumentGetInstrumentsResponse: …`

  - `data: InstrumentCoreList`

    - `id: str`

      Unique OEMS instrument identifier (UUID)

    - `country_of_issue: str`

      The ISO country code of the instrument's issue

    - `currency: str`

      The ISO currency code in which the instrument is traded

    - `easy_to_borrow: bool`

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

    - `is_liquidation_only: bool`

      Indicates if the instrument is liquidation only and cannot be bought

    - `is_marginable: bool`

      Indicates if the instrument is marginable

    - `is_restricted: bool`

      Indicates if the instrument is restricted from trading

    - `is_short_prohibited: bool`

      Indicates if short selling is prohibited for the instrument

    - `is_threshold_security: bool`

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

    - `is_tradable: bool`

      Indicates if the instrument is tradable

    - `symbol: str`

      The trading symbol for the instrument

    - `venue: str`

      The MIC code of the primary listing venue

    - `adv: Optional[str]`

      Average daily share volume from the security definition.

    - `expiry: Optional[date]`

      The expiration date for options instruments

    - `instrument_type: Optional[SecurityType]`

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

      - `"COMMON_STOCK"`

      - `"PREFERRED_STOCK"`

      - `"OPTION"`

      - `"CASH"`

      - `"OTHER"`

    - `long_margin_rate: Optional[str]`

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

    - `name: Optional[str]`

      The full name of the instrument or its issuer

    - `notional_adv: Optional[str]`

      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.

    - `previous_close: Optional[str]`

      Last close price from the security definition.

    - `short_margin_rate: Optional[str]`

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

    - `strike_price: Optional[str]`

      The strike price for options instruments

### Example

```python
from clear_street import ClearStreet

client = ClearStreet(
    api_key="My API Key",
)
response = client.v1.instruments.get_instruments()
print(response)
```

#### Response

```json
{
  "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": {
    "next_page_token": "cGFnZT0yJmxhc3Rfc3ltYm9sPUdNRQ==",
    "page_number": 1,
    "request_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
    "total_items": 10,
    "total_pages": 5
  }
}
```