Skip to content
Clear Street Clear Street
Start Trading
API Reference
V1
Instruments

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.

ParametersExpand Collapse
instrument_id: InstrumentIDOrSymbol

Instrument identifier

formatuuid
include_options_expiry_dates: Optional[bool]

When true, include unique options expiry dates for this instrument

ReturnsExpand Collapse
class InstrumentGetInstrumentByIDResponse: …

Represents a tradable financial instrument.

id: str

Unique instrument identifier (UUID)

formatuuid
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_fractionable: bool

Indicates if the instrument supports fractional-quantity orders

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_ptp: bool

Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.

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. When a null/undefined value is observed, it indicates that there is no available data.

Deprecatedexpiry: Optional[date]

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

formatdate
instrument_type: Optional[SecurityType]

The type of security (e.g., Common Stock, ETF) When a null/undefined value is observed, it indicates that there is no available data.

One of the following:
"COMMON_STOCK"
"OPTION"
"CASH"
long_margin_rate: Optional[str]

The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

name: Optional[str]

The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.

notional_adv: Optional[str]

Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.

options_expiry_dates: Optional[List[date]]

Available options expiration dates for this instrument. Present only when include_options_expiry_dates=true in the request. When a null/undefined value is observed, it indicates it does not apply.

previous_close: Optional[str]

Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.

short_margin_rate: Optional[str]

The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

Deprecatedstrike_price: Optional[str]

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

Get Instrument By ID

from clearstreet 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)
{
  "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"
  },
  "error": null,
  "metadata": {
    "request_id": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e"
  }
}
{
  "error": {
    "code": 404,
    "message": "Instrument not found: AAP"
  },
  "metadata": {
    "request_id": "fa8cc9b2-fbf0-4f5b-8ce3-b3205b9f85f2"
  }
}
Returns Examples
{
  "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"
  },
  "error": null,
  "metadata": {
    "request_id": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e"
  }
}
{
  "error": {
    "code": 404,
    "message": "Instrument not found: AAP"
  },
  "metadata": {
    "request_id": "fa8cc9b2-fbf0-4f5b-8ce3-b3205b9f85f2"
  }
}