Instruments
Retrieve core details and discovery endpoints for tradable instruments.
Get Instruments
Get Instrument By ID
Search Instruments
Get Option Contracts
ModelsExpand Collapse
class Instrument: …
Represents a tradable financial instrument.
is_ptp: 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.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
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[str]
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[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
options_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentCore: …
is_ptp: 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.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
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[str]
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[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
List[InstrumentCore]
is_ptp: 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.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
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[str]
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[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
List[OptionsContract]
class InstrumentGetInstrumentsResponse: …
is_ptp: 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.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
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[str]
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[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentGetInstrumentByIDResponse: …
Represents a tradable financial instrument.
is_ptp: 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.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
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[str]
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[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
options_expiry_dates: Optional[List[date]]
Available options expiration dates for this instrument.
Present only when include_options_expiry_dates=true in the request.
When a null/undefined value is observed, it indicates it does not apply.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
class InstrumentSearchInstrumentsResponse: …
is_ptp: 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.
is_threshold_security: bool
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: Optional[str]
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
Deprecatedexpiry: Optional[date]
Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.
long_margin_rate: Optional[str]
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[str]
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[str]
Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.
previous_close: Optional[str]
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.