# Instruments

## 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
  }
}
```

## Get Instrument By ID

`v1.instruments.get_instrument_by_id(InstrumentIDOrSymbolinstrument_id, InstrumentGetInstrumentByIDParams**kwargs)  -> InstrumentGetInstrumentByIDResponse`

**get** `/v1/instruments/{instrument_id}`

Retrieves detailed information for a specific instrument.

### Parameters

- `instrument_id: InstrumentIDOrSymbol`

  OEMS instrument UUID

- `include_options_expiry_dates: Optional[bool]`

  When true, include unique options expiry dates for this instrument

### Returns

- `class InstrumentGetInstrumentByIDResponse: …`

  - `data: Instrument`

    Represents a tradable financial instrument.

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

    - `options_expiry_dates: Optional[List[date]]`

      Available options expiration dates for this instrument.
      Present only when `include_options_expiry_dates=true` in the request.

    - `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_instrument_by_id(
    instrument_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
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,
    "long_margin_rate": "0.25",
    "name": "Apple Inc.",
    "short_margin_rate": "0.25",
    "symbol": "AAPL",
    "venue": "XNMS"
  },
  "error": null,
  "metadata": {
    "request_id": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e"
  }
}
```

## Search Instruments

`v1.instruments.search_instruments(InstrumentSearchInstrumentsParams**kwargs)  -> InstrumentSearchInstrumentsResponse`

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

- `q: str`

  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.

- `asset_class: Optional[str]`

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

- `country: Optional[str]`

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

- `currency: Optional[str]`

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

- `include_inactive: Optional[bool]`

  Include inactive instruments. Default false.

- `include_restricted: Optional[bool]`

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

- `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 InstrumentSearchInstrumentsResponse: …`

  - `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.search_instruments(
    q="q",
)
print(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": "..."
  }
}
```

## Get Option Contracts

`v1.instruments.get_option_contracts(InstrumentGetOptionContractsParams**kwargs)  -> InstrumentGetOptionContractsResponse`

**get** `/v1/instruments/options/contracts`

List options contracts.

Returns options contracts for a given underlier with options-specific metadata.
Exactly one underlier identifier must be provided.

### Parameters

- `contract_type: Optional[ContractType]`

  Filter by contract type: CALL or PUT

  - `"CALL"`

  - `"PUT"`

- `expiry: Optional[Union[null, null]]`

  Filter to contracts expiring on this date (YYYY-MM-DD)

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

- `underlier: Optional[str]`

  Underlier symbol (e.g., AAPL, SPX)

- `underlying_instrument_id: Optional[InstrumentIDOrSymbol]`

  OEMS instrument UUID or symbol of the underlying equity/index

### Returns

- `class InstrumentGetOptionContractsResponse: …`

  - `data: OptionsContractList`

    - `id: str`

      OEMS instrument identifier

    - `contract_type: ContractType`

      Whether this is a CALL or PUT

      - `"CALL"`

      - `"PUT"`

    - `currency: str`

      ISO currency code

    - `exchange: str`

      MIC code of the primary listing venue

    - `exercise_style: ExerciseStyle`

      Exercise style

      - `"AMERICAN"`

      - `"EUROPEAN"`

    - `expiry: date`

      Expiration date

    - `is_liquidation_only: bool`

      Whether the contract is liquidation-only

    - `is_marginable: bool`

      Whether the contract is marginable

    - `is_restricted: bool`

      Whether the contract is restricted from trading

    - `listing_type: ListingType`

      Listing type

      - `"STANDARD"`

      - `"FLEX"`

      - `"OTC"`

    - `multiplier: str`

      Contract multiplier (100 for standard options)

    - `strike_price: str`

      Strike price

    - `symbol: str`

      OSI symbol (e.g. "AAPL  251219C00150000")

    - `open_interest: Optional[int]`

      Open interest (number of outstanding contracts), if available

    - `underlying_instrument_id: Optional[str]`

      OEMS instrument ID of the underlying instrument, if resolvable

### Example

```python
from clear_street import ClearStreet

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

#### Response

```json
{
  "data": [
    {
      "contract_type": "CALL",
      "currency": "USD",
      "exchange": "BATO",
      "exercise_style": "AMERICAN",
      "expiry": "2026-03-20",
      "id": "b6f4b5e2-94a8-4fe4-9a85-2b4a81d30cc5",
      "is_liquidation_only": false,
      "is_marginable": true,
      "is_restricted": false,
      "is_tradable": true,
      "listing_type": "STANDARD",
      "multiplier": "100",
      "strike_price": "180",
      "symbol": "AAPL  260320C00180000",
      "underlying_instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8"
    },
    {
      "contract_type": "PUT",
      "currency": "USD",
      "exchange": "BATO",
      "exercise_style": "AMERICAN",
      "expiry": "2026-03-20",
      "id": "c7e5c6f3-a5b9-5gf5-0b96-3c5b92e41dd6",
      "is_liquidation_only": false,
      "is_marginable": true,
      "is_restricted": false,
      "is_tradable": true,
      "listing_type": "STANDARD",
      "multiplier": "100",
      "strike_price": "180",
      "symbol": "AAPL  260320P00180000",
      "underlying_instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8"
    }
  ],
  "metadata": {
    "page_number": 1,
    "request_id": "c2d0429d-c629-4ee1-b719-df007157f3bb",
    "total_items": 2,
    "total_pages": 1
  }
}
```

## Domain Types

### Contract Type

- `Literal["CALL", "PUT"]`

  The type of options contract

  - `"CALL"`

  - `"PUT"`

### Exercise Style

- `Literal["AMERICAN", "EUROPEAN"]`

  The exercise style of an options contract

  - `"AMERICAN"`

  - `"EUROPEAN"`

### Instrument

- `class Instrument: …`

  Represents a tradable financial instrument.

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

  - `options_expiry_dates: Optional[List[date]]`

    Available options expiration dates for this instrument.
    Present only when `include_options_expiry_dates=true` in the request.

  - `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

### Instrument Core

- `class InstrumentCore: …`

  - `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

### Instrument Core List

- `List[InstrumentCore]`

  - `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

### Listing Type

- `Literal["STANDARD", "FLEX", "OTC"]`

  The listing type of an options contract

  - `"STANDARD"`

  - `"FLEX"`

  - `"OTC"`

### Options Contract

- `class OptionsContract: …`

  An options contract with options-specific metadata

  - `id: str`

    OEMS instrument identifier

  - `contract_type: ContractType`

    Whether this is a CALL or PUT

    - `"CALL"`

    - `"PUT"`

  - `currency: str`

    ISO currency code

  - `exchange: str`

    MIC code of the primary listing venue

  - `exercise_style: ExerciseStyle`

    Exercise style

    - `"AMERICAN"`

    - `"EUROPEAN"`

  - `expiry: date`

    Expiration date

  - `is_liquidation_only: bool`

    Whether the contract is liquidation-only

  - `is_marginable: bool`

    Whether the contract is marginable

  - `is_restricted: bool`

    Whether the contract is restricted from trading

  - `listing_type: ListingType`

    Listing type

    - `"STANDARD"`

    - `"FLEX"`

    - `"OTC"`

  - `multiplier: str`

    Contract multiplier (100 for standard options)

  - `strike_price: str`

    Strike price

  - `symbol: str`

    OSI symbol (e.g. "AAPL  251219C00150000")

  - `open_interest: Optional[int]`

    Open interest (number of outstanding contracts), if available

  - `underlying_instrument_id: Optional[str]`

    OEMS instrument ID of the underlying instrument, if resolvable

### Options Contract List

- `List[OptionsContract]`

  - `id: str`

    OEMS instrument identifier

  - `contract_type: ContractType`

    Whether this is a CALL or PUT

    - `"CALL"`

    - `"PUT"`

  - `currency: str`

    ISO currency code

  - `exchange: str`

    MIC code of the primary listing venue

  - `exercise_style: ExerciseStyle`

    Exercise style

    - `"AMERICAN"`

    - `"EUROPEAN"`

  - `expiry: date`

    Expiration date

  - `is_liquidation_only: bool`

    Whether the contract is liquidation-only

  - `is_marginable: bool`

    Whether the contract is marginable

  - `is_restricted: bool`

    Whether the contract is restricted from trading

  - `listing_type: ListingType`

    Listing type

    - `"STANDARD"`

    - `"FLEX"`

    - `"OTC"`

  - `multiplier: str`

    Contract multiplier (100 for standard options)

  - `strike_price: str`

    Strike price

  - `symbol: str`

    OSI symbol (e.g. "AAPL  251219C00150000")

  - `open_interest: Optional[int]`

    Open interest (number of outstanding contracts), if available

  - `underlying_instrument_id: Optional[str]`

    OEMS instrument ID of the underlying instrument, if resolvable

### Instrument Get Instruments Response

- `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

### Instrument Get Instrument By ID Response

- `class InstrumentGetInstrumentByIDResponse: …`

  - `data: Instrument`

    Represents a tradable financial instrument.

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

    - `options_expiry_dates: Optional[List[date]]`

      Available options expiration dates for this instrument.
      Present only when `include_options_expiry_dates=true` in the request.

    - `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

### Instrument Search Instruments Response

- `class InstrumentSearchInstrumentsResponse: …`

  - `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

### Instrument Get Option Contracts Response

- `class InstrumentGetOptionContractsResponse: …`

  - `data: OptionsContractList`

    - `id: str`

      OEMS instrument identifier

    - `contract_type: ContractType`

      Whether this is a CALL or PUT

      - `"CALL"`

      - `"PUT"`

    - `currency: str`

      ISO currency code

    - `exchange: str`

      MIC code of the primary listing venue

    - `exercise_style: ExerciseStyle`

      Exercise style

      - `"AMERICAN"`

      - `"EUROPEAN"`

    - `expiry: date`

      Expiration date

    - `is_liquidation_only: bool`

      Whether the contract is liquidation-only

    - `is_marginable: bool`

      Whether the contract is marginable

    - `is_restricted: bool`

      Whether the contract is restricted from trading

    - `listing_type: ListingType`

      Listing type

      - `"STANDARD"`

      - `"FLEX"`

      - `"OTC"`

    - `multiplier: str`

      Contract multiplier (100 for standard options)

    - `strike_price: str`

      Strike price

    - `symbol: str`

      OSI symbol (e.g. "AAPL  251219C00150000")

    - `open_interest: Optional[int]`

      Open interest (number of outstanding contracts), if available

    - `underlying_instrument_id: Optional[str]`

      OEMS instrument ID of the underlying instrument, if resolvable