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

client.V1.Instruments.GetInstruments(ctx, query) (*V1InstrumentGetInstrumentsResponse, error)

GET/v1/instruments

Get Instrument By ID

client.V1.Instruments.GetInstrumentByID(ctx, instrumentID, query) (*V1InstrumentGetInstrumentByIDResponse, error)

GET/v1/instruments/{instrument_id}

Search Instruments

client.V1.Instruments.SearchInstruments(ctx, query) (*V1InstrumentSearchInstrumentsResponse, error)

GET/v1/instruments/search

Get Option Contracts

client.V1.Instruments.GetOptionContracts(ctx, query) (*V1InstrumentGetOptionContractsResponse, error)

GET/v1/instruments/options/contracts

ModelsExpand Collapse

type ContractType string

The type of options contract

One of the following:

const ContractTypeCall ContractType = "CALL"

const ContractTypePut ContractType = "PUT"

type ExerciseStyle string

The exercise style of an options contract

One of the following:

const ExerciseStyleAmerican ExerciseStyle = "AMERICAN"

const ExerciseStyleEuropean ExerciseStyle = "EUROPEAN"

type Instrument struct{…}

Represents a tradable financial instrument.

ID string

Unique OEMS instrument identifier (UUID)

formatuuid

CountryOfIssue string

The ISO country code of the instrument’s issue

Currency string

The ISO currency code in which the instrument is traded

EasyToBorrow bool

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

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsRestricted bool

Indicates if the instrument is restricted from trading

IsShortProhibited bool

Indicates if short selling is prohibited for the instrument

IsThresholdSecurity bool

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

IsTradable bool

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 stringOptional

Average daily share volume from the security definition.

Expiry TimeOptional

The expiration date for options instruments

formatdate

InstrumentType SecurityTypeOptional

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

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

const SecurityTypeOther SecurityType = "OTHER"

LongMarginRate stringOptional

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

Name stringOptional

The full name of the instrument or its issuer

NotionalAdv stringOptional

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.

OptionsExpiryDates []TimeOptional

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

PreviousClose stringOptional

Last close price from the security definition.

ShortMarginRate stringOptional

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

StrikePrice stringOptional

The strike price for options instruments

type InstrumentCore struct{…}

ID string

Unique OEMS instrument identifier (UUID)

formatuuid

CountryOfIssue string

The ISO country code of the instrument’s issue

Currency string

The ISO currency code in which the instrument is traded

EasyToBorrow bool

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

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsRestricted bool

Indicates if the instrument is restricted from trading

IsShortProhibited bool

Indicates if short selling is prohibited for the instrument

IsThresholdSecurity bool

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

IsTradable bool

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 stringOptional

Average daily share volume from the security definition.

Expiry TimeOptional

The expiration date for options instruments

formatdate

InstrumentType SecurityTypeOptional

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

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

const SecurityTypeOther SecurityType = "OTHER"

LongMarginRate stringOptional

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

Name stringOptional

The full name of the instrument or its issuer

NotionalAdv stringOptional

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.

PreviousClose stringOptional

Last close price from the security definition.

ShortMarginRate stringOptional

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

StrikePrice stringOptional

The strike price for options instruments

type InstrumentCoreList []InstrumentCore

ID string

Unique OEMS instrument identifier (UUID)

formatuuid

CountryOfIssue string

The ISO country code of the instrument’s issue

Currency string

The ISO currency code in which the instrument is traded

EasyToBorrow bool

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

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsRestricted bool

Indicates if the instrument is restricted from trading

IsShortProhibited bool

Indicates if short selling is prohibited for the instrument

IsThresholdSecurity bool

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

IsTradable bool

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 stringOptional

Average daily share volume from the security definition.

Expiry TimeOptional

The expiration date for options instruments

formatdate

InstrumentType SecurityTypeOptional

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

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

const SecurityTypeOther SecurityType = "OTHER"

LongMarginRate stringOptional

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

Name stringOptional

The full name of the instrument or its issuer

NotionalAdv stringOptional

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.

PreviousClose stringOptional

Last close price from the security definition.

ShortMarginRate stringOptional

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

StrikePrice stringOptional

The strike price for options instruments

type ListingType string

The listing type of an options contract

One of the following:

const ListingTypeStandard ListingType = "STANDARD"

const ListingTypeFlex ListingType = "FLEX"

const ListingTypeOtc ListingType = "OTC"

type OptionsContract struct{…}

An options contract with options-specific metadata

ID string

OEMS instrument identifier

formatuuid

ContractType ContractType

Whether this is a CALL or PUT

One of the following:

const ContractTypeCall ContractType = "CALL"

const ContractTypePut ContractType = "PUT"

Currency string

ISO currency code

Exchange string

MIC code of the primary listing venue

ExerciseStyle ExerciseStyle

Exercise style

One of the following:

const ExerciseStyleAmerican ExerciseStyle = "AMERICAN"

const ExerciseStyleEuropean ExerciseStyle = "EUROPEAN"

Expiry Time

Expiration date

formatdate

IsLiquidationOnly bool

Whether the contract is liquidation-only

IsMarginable bool

Whether the contract is marginable

IsRestricted bool

Whether the contract is restricted from trading

ListingType ListingType

Listing type

One of the following:

const ListingTypeStandard ListingType = "STANDARD"

const ListingTypeFlex ListingType = "FLEX"

const ListingTypeOtc ListingType = "OTC"

Multiplier string

Contract multiplier (100 for standard options)

StrikePrice string

Strike price

Symbol string

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

OpenInterest int64Optional

Open interest (number of outstanding contracts), if available

formatint64

UnderlyingInstrumentID stringOptional

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid

type OptionsContractList []OptionsContract

ID string

OEMS instrument identifier

formatuuid

ContractType ContractType

Whether this is a CALL or PUT

One of the following:

const ContractTypeCall ContractType = "CALL"

const ContractTypePut ContractType = "PUT"

Currency string

ISO currency code

Exchange string

MIC code of the primary listing venue

ExerciseStyle ExerciseStyle

Exercise style

One of the following:

const ExerciseStyleAmerican ExerciseStyle = "AMERICAN"

const ExerciseStyleEuropean ExerciseStyle = "EUROPEAN"

Expiry Time

Expiration date

formatdate

IsLiquidationOnly bool

Whether the contract is liquidation-only

IsMarginable bool

Whether the contract is marginable

IsRestricted bool

Whether the contract is restricted from trading

ListingType ListingType

Listing type

One of the following:

const ListingTypeStandard ListingType = "STANDARD"

const ListingTypeFlex ListingType = "FLEX"

const ListingTypeOtc ListingType = "OTC"

Multiplier string

Contract multiplier (100 for standard options)

StrikePrice string

Strike price

Symbol string

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

OpenInterest int64Optional

Open interest (number of outstanding contracts), if available

formatint64

UnderlyingInstrumentID stringOptional

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid