API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Instruments

Retrieve core details and discovery endpoints for tradable instruments.

Get Instruments

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

GET/v1/instruments

Get Instrument By ID

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

GET/v1/instruments/{instrument_id}

Search Instruments

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

GET/v1/instruments/search

Get Option Contracts

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

GET/v1/instruments/options/contracts

ModelsExpand Collapse

Literal["CALL", "PUT"]

The type of options contract

One of the following:

"CALL"

"PUT"

Literal["AMERICAN", "EUROPEAN"]

The exercise style of an options contract

One of the following:

"AMERICAN"

"EUROPEAN"

class Instrument: …

Represents a tradable financial instrument.

id: str

Unique OEMS 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_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

formatdate

instrument_type: Optional[SecurityType]

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

One of the following:

"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

class InstrumentCore: …

id: str

Unique OEMS 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_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

formatdate

instrument_type: Optional[SecurityType]

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

One of the following:

"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

List[InstrumentCore]

id: str

Unique OEMS 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_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

formatdate

instrument_type: Optional[SecurityType]

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

One of the following:

"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

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

The listing type of an options contract

One of the following:

"STANDARD"

"FLEX"

"OTC"

class OptionsContract: …

An options contract with options-specific metadata

id: str

OEMS instrument identifier

formatuuid

contract_type: ContractType

Whether this is a CALL or PUT

One of the following:

"CALL"

"PUT"

currency: str

ISO currency code

exchange: str

MIC code of the primary listing venue

exercise_style: ExerciseStyle

Exercise style

One of the following:

"AMERICAN"

"EUROPEAN"

expiry: date

Expiration date

formatdate

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

One of the following:

"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

formatint64

underlying_instrument_id: Optional[str]

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid

List[OptionsContract]

id: str

OEMS instrument identifier

formatuuid

contract_type: ContractType

Whether this is a CALL or PUT

One of the following:

"CALL"

"PUT"

currency: str

ISO currency code

exchange: str

MIC code of the primary listing venue

exercise_style: ExerciseStyle

Exercise style

One of the following:

"AMERICAN"

"EUROPEAN"

expiry: date

Expiration date

formatdate

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

One of the following:

"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

formatint64

underlying_instrument_id: Optional[str]

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid

class InstrumentGetInstrumentsResponse: …

data: InstrumentCoreList

id: str

Unique OEMS 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_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

formatdate

instrument_type: Optional[SecurityType]

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

One of the following:

"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

class InstrumentGetInstrumentByIDResponse: …

data: Instrument

Represents a tradable financial instrument.

id: str

Unique OEMS 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_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

formatdate

instrument_type: Optional[SecurityType]

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

One of the following:

"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

class InstrumentSearchInstrumentsResponse: …

data: InstrumentCoreList

id: str

Unique OEMS 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_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

formatdate

instrument_type: Optional[SecurityType]

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

One of the following:

"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

class InstrumentGetOptionContractsResponse: …

data: OptionsContractList

id: str

OEMS instrument identifier

formatuuid

contract_type: ContractType

Whether this is a CALL or PUT

One of the following:

"CALL"

"PUT"

currency: str

ISO currency code

exchange: str

MIC code of the primary listing venue

exercise_style: ExerciseStyle

Exercise style

One of the following:

"AMERICAN"

"EUROPEAN"

expiry: date

Expiration date

formatdate

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

One of the following:

"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

formatint64

underlying_instrument_id: Optional[str]

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid