Get Instrument By ID

GET/v1/instruments/{instrument_id}

Retrieves detailed information for a specific instrument.

Path ParametersExpand Collapse

instrument_id: string

Instrument identifier: either an instrument UUID or a symbol (symbol for equities, OSI for options). Non-UUID inputs are resolved server-side.

minLength1

Query ParametersExpand Collapse

include_options_expiry_dates: optional boolean

When true, include unique options expiry dates for this instrument

ReturnsExpand Collapse

data: Instrument { id, country_of_issue, currency, 21 more }

Represents a tradable financial instrument.

id: string

Unique instrument identifier (UUID)

formatuuid

country_of_issue: string

The ISO country code of the instrument’s issue

currency: string

The ISO currency code in which the instrument is traded

easy_to_borrow: boolean

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

is_fractionable: boolean

Indicates if the instrument supports fractional-quantity orders

is_liquidation_only: boolean

Indicates if the instrument is liquidation only and cannot be bought

is_marginable: boolean

Indicates if the instrument is marginable

is_ptp: boolean

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: boolean

Indicates if short selling is prohibited for the instrument. This is a standing property of the security. For the live Rule 201 circuit breaker, see short_sale_restricted on the market-data snapshot.

is_threshold_security: boolean

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

is_tradable: boolean

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: optional string

Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.

cax_adjusted_previous_close: optional string

Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.

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"

"INDEX"

"OPTION"

"CASH"

long_margin_rate: optional string

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 string

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 string

Notional average daily volume (ADV multiplied by the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.

options_contract_expiry_dates: optional array of OptionExpiryDate { date, has_settles_on_close, has_settles_on_open }

Available options expiration dates for this instrument, each annotated with which settlement cycles have listed contracts on it. Present only when include_options_expiry_dates=true in the request. When a null/undefined value is observed, it indicates it does not apply.

date: string

The expiration date.

formatdate

has_settles_on_close: boolean

Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.

has_settles_on_open: boolean

Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.

Deprecatedoptions_expiry_dates: optional array of string

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

Deprecated: use options_contract_expiry_dates, which carries the same dates annotated with settlement-cycle information. When a null/undefined value is observed, it indicates it does not apply.

previous_close: optional string

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 string

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.

tick_rules: optional array of TickRule { start_price, tick_size, end_price }

Price bands this instrument quotes on, ascending. Absent when we have no schedule for it, which includes an option whose penny-program status our reference data never supplied.

start_price: string

Lowest price in the band, inclusive.

tick_size: string

Minimum price increment within the band.

end_price: optional string

Upper bound of the band, exclusive. Absent on the last band, which runs to infinity. When a null/undefined value is observed, it indicates it does not apply.

Get Instrument By ID

curl https://api.clearstreet.com/v1/instruments/$INSTRUMENT_ID \
    -H "Authorization: Bearer $API_KEY"

{
  "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: AAPL"
  },
  "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: AAPL"
  },
  "metadata": {
    "request_id": "fa8cc9b2-fbf0-4f5b-8ce3-b3205b9f85f2"
  }
}