Instruments

Retrieve core details and discovery endpoints for tradable instruments.

Get Instruments

InstrumentGetInstrumentsResponse v1().instruments().getInstruments(, )

GET/v1/instruments

Get Instrument By ID

InstrumentGetInstrumentByIdResponse v1().instruments().getInstrumentById(, )

GET/v1/instruments/{instrument_id}

Search Instruments

InstrumentSearchInstrumentsResponse v1().instruments().searchInstruments(, )

GET/v1/instruments/search

Get Option Contracts

InstrumentGetOptionContractsResponse v1().instruments().getOptionContracts(, )

GET/v1/instruments/options/contracts

ModelsExpand Collapse

enum ContractType:

The type of options contract

CALL("CALL")

PUT("PUT")

enum ExerciseStyle:

The exercise style of an options contract

AMERICAN("AMERICAN")

EUROPEAN("EUROPEAN")

class Instrument:

Represents a tradable financial instrument.

String id

Unique OEMS instrument identifier (UUID)

formatuuid

String countryOfIssue

The ISO country code of the instrument’s issue

String currency

The ISO currency code in which the instrument is traded

boolean easyToBorrow

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

boolean isLiquidationOnly

Indicates if the instrument is liquidation only and cannot be bought

boolean isMarginable

Indicates if the instrument is marginable

boolean isRestricted

Indicates if the instrument is restricted from trading

boolean isShortProhibited

Indicates if short selling is prohibited for the instrument

boolean isThresholdSecurity

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

boolean isTradable

Indicates if the instrument is tradable

String symbol

The trading symbol for the instrument

String venue

The MIC code of the primary listing venue

Optional<String> adv

Average daily share volume from the security definition.

Optional<LocalDate> expiry

The expiration date for options instruments

formatdate

Optional<SecurityType> instrumentType

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

One of the following:

COMMON_STOCK("COMMON_STOCK")

PREFERRED_STOCK("PREFERRED_STOCK")

OPTION("OPTION")

CASH("CASH")

OTHER("OTHER")

Optional<String> longMarginRate

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

Optional<String> name

The full name of the instrument or its issuer

Optional<String> notionalAdv

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.

Optional<List<LocalDate>> optionsExpiryDates

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

Optional<String> previousClose

Last close price from the security definition.

Optional<String> shortMarginRate

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

Optional<String> strikePrice

The strike price for options instruments

class InstrumentCore:

String id

Unique OEMS instrument identifier (UUID)

formatuuid

String countryOfIssue

The ISO country code of the instrument’s issue

String currency

The ISO currency code in which the instrument is traded

boolean easyToBorrow

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

boolean isLiquidationOnly

Indicates if the instrument is liquidation only and cannot be bought

boolean isMarginable

Indicates if the instrument is marginable

boolean isRestricted

Indicates if the instrument is restricted from trading

boolean isShortProhibited

Indicates if short selling is prohibited for the instrument

boolean isThresholdSecurity

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

boolean isTradable

Indicates if the instrument is tradable

String symbol

The trading symbol for the instrument

String venue

The MIC code of the primary listing venue

Optional<String> adv

Average daily share volume from the security definition.

Optional<LocalDate> expiry

The expiration date for options instruments

formatdate

Optional<SecurityType> instrumentType

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

One of the following:

COMMON_STOCK("COMMON_STOCK")

PREFERRED_STOCK("PREFERRED_STOCK")

OPTION("OPTION")

CASH("CASH")

OTHER("OTHER")

Optional<String> longMarginRate

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

Optional<String> name

The full name of the instrument or its issuer

Optional<String> notionalAdv

Optional<String> previousClose

Last close price from the security definition.

Optional<String> shortMarginRate

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

Optional<String> strikePrice

The strike price for options instruments

enum ListingType:

The listing type of an options contract

STANDARD("STANDARD")

FLEX("FLEX")

OTC("OTC")

class OptionsContract:

An options contract with options-specific metadata

String id

OEMS instrument identifier

formatuuid

ContractType contractType

Whether this is a CALL or PUT

One of the following:

CALL("CALL")

PUT("PUT")

String currency

ISO currency code

String exchange

MIC code of the primary listing venue

ExerciseStyle exerciseStyle

Exercise style

One of the following:

AMERICAN("AMERICAN")

EUROPEAN("EUROPEAN")

LocalDate expiry

Expiration date

formatdate

boolean isLiquidationOnly

Whether the contract is liquidation-only

boolean isMarginable

Whether the contract is marginable

boolean isRestricted

Whether the contract is restricted from trading

ListingType listingType

Listing type

One of the following:

STANDARD("STANDARD")

FLEX("FLEX")

OTC("OTC")

String multiplier

Contract multiplier (100 for standard options)

String strikePrice

Strike price

String symbol

OSI symbol (e.g. “AAPL 251219C00150000”)

Optional<Long> openInterest

Open interest (number of outstanding contracts), if available

formatint64

Optional<String> underlyingInstrumentId

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid