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

IsFractionable bool

Indicates if the instrument supports fractional-quantity orders

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsPtp 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.

IsShortProhibited bool

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.

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

CaxAdjustedPreviousClose stringOptional

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.

InstrumentType SecurityTypeOptional

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:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

LongMarginRate stringOptional

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 stringOptional

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

NotionalAdv stringOptional

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.

OptionsContractExpiryDates []OptionExpiryDateOptional

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 Time

The expiration date.

formatdate

HasSettlesOnClose bool

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

HasSettlesOnOpen bool

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.

DeprecatedOptionsExpiryDates []TimeOptional

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.

PreviousClose stringOptional

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

ShortMarginRate stringOptional

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.

TickRules []TickRuleOptional

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.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

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.

type InstrumentCore struct{…}

ID string

Unique 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

IsFractionable bool

Indicates if the instrument supports fractional-quantity orders

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsPtp 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.

IsShortProhibited bool

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

CaxAdjustedPreviousClose stringOptional

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.

InstrumentType SecurityTypeOptional

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:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

LongMarginRate stringOptional

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 stringOptional

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

NotionalAdv stringOptional

PreviousClose stringOptional

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

ShortMarginRate stringOptional

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.

TickRules []TickRuleOptional

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.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

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.

type InstrumentCoreList []InstrumentCore

ID string

Unique 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

IsFractionable bool

Indicates if the instrument supports fractional-quantity orders

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsPtp 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.

IsShortProhibited bool

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

CaxAdjustedPreviousClose stringOptional

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.

InstrumentType SecurityTypeOptional

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:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeIndex SecurityType = "INDEX"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

LongMarginRate stringOptional

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 stringOptional

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

NotionalAdv stringOptional

PreviousClose stringOptional

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

ShortMarginRate stringOptional

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.

TickRules []TickRuleOptional

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.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

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.

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 OptionExpiryDate struct{…}

An options expiry date, annotated with which settlement cycles have listed contracts on it.

Date Time

The expiration date.

formatdate

HasSettlesOnClose bool

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

HasSettlesOnOpen bool

type OptionsContract struct{…}

An options contract with options-specific metadata

ID string

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

IsTradable bool

Whether the contract is tradable

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”)

IsSettleOnOpen boolOptional

Whether the option settles on the opening price (AM settlement), if known When a null/undefined value is observed, it indicates that there is no available data.

LastTradeCutoff TimeOptional

Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

OpenInterest int64Optional

Open interest (number of outstanding contracts), if available When a null/undefined value is observed, it indicates that there is no available data.

formatint64

TickRules []TickRuleOptional

Price bands this contract quotes on, ascending. Absent when our reference data never supplied the contract’s penny-program status.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

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.

UnderlyingInstrumentID stringOptional

Instrument ID of the underlying instrument, when available When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

type OptionsContractList []OptionsContract

ID string

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

IsTradable bool

Whether the contract is tradable

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”)

IsSettleOnOpen boolOptional

Whether the option settles on the opening price (AM settlement), if known When a null/undefined value is observed, it indicates that there is no available data.

LastTradeCutoff TimeOptional

Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

OpenInterest int64Optional

Open interest (number of outstanding contracts), if available When a null/undefined value is observed, it indicates that there is no available data.

formatint64

TickRules []TickRuleOptional

Price bands this contract quotes on, ascending. Absent when our reference data never supplied the contract’s penny-program status.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

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.

UnderlyingInstrumentID stringOptional

Instrument ID of the underlying instrument, when available When a null/undefined value is observed, it indicates that there is no available data.

formatuuid

type TickRule struct{…}

One band of an instrument’s tick schedule. A price in the band is valid only if it is a whole multiple of tick_size. Bands describe the instrument itself: on an equity they say nothing about that equity’s option chain.

StartPrice string

Lowest price in the band, inclusive.

TickSize string

Minimum price increment within the band.

EndPrice stringOptional

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.