Instruments
Retrieve core details and discovery endpoints for tradable instruments.
ModelsExpand Collapse
instrument: object { id, country_of_issue, currency, 21 more }
Represents a tradable financial instrument.
is_ptp: boolean
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_short_prohibited: boolean
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.
is_threshold_security: boolean
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: optional string
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
cax_adjusted_previous_close: optional string
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.
long_margin_rate: optional string
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 string
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 string
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.
options_contract_expiry_dates: optional array of OptionExpiryDate { date, has_settles_on_close, has_settles_on_open }
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.
has_settles_on_close: boolean
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
has_settles_on_open: boolean
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.
Deprecatedoptions_expiry_dates: optional array of string
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.
previous_close: optional string
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
short_margin_rate: optional string
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.
instrument_core: object { id, country_of_issue, currency, 19 more }
is_ptp: boolean
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_short_prohibited: boolean
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.
is_threshold_security: boolean
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: optional string
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
cax_adjusted_previous_close: optional string
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.
long_margin_rate: optional string
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 string
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 string
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.
previous_close: optional string
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
short_margin_rate: optional string
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.
is_ptp: boolean
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_short_prohibited: boolean
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.
is_threshold_security: boolean
Indicates if the instrument is on the Regulation SHO Threshold Security List
adv: optional string
Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
cax_adjusted_previous_close: optional string
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.
long_margin_rate: optional string
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 string
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 string
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.
previous_close: optional string
Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.
short_margin_rate: optional string
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.
option_expiry_date: object { date, has_settles_on_close, has_settles_on_open }
An options expiry date, annotated with which settlement cycles have listed contracts on it.
has_settles_on_close: boolean
Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.
has_settles_on_open: boolean
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.
options_contract: object { id, contract_type, currency, 15 more }
An options contract with options-specific metadata
is_settle_on_open: optional boolean
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.
last_trade_cutoff: optional string
Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.
open_interest: optional number
Open interest (number of outstanding contracts), if available When a null/undefined value is observed, it indicates that there is no available data.
is_settle_on_open: optional boolean
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.
last_trade_cutoff: optional string
Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.
open_interest: optional number
Open interest (number of outstanding contracts), if available When a null/undefined value is observed, it indicates that there is no available data.