MasterInstrument

View as Markdown

Definition

An instrument’s configuration settings. These are settings and properties which are defined in the Instrument window.

Warning: The properties in this class should NOT be accessed within the OnStateChange() method before the State has reached State.DataLoaded.

Methods and Properties

Method/PropertyDescription
Compare()Returns An int value compares two price values with respect to the Instrument tick size
CurrencyThe currency that the instrument traded in
DescriptionA written representation of a given instrument
DividendsA collection of dividends for stock instruments
ExchangesA collection of exchanges configured for an instrument
FormatPrice()Returns a string representing the price formatted to the nearest tick size
InstrumentTypeThe type of instrument
MergePolicyThe Merge Policy that is configured for the current master instrument.
NameThe name of the instrument.
GetNextExpiry()Returns a DateTime structure representing the next futures expiry for a given date
PointValueCurrency value of 1 full point of movement
RolloverCollectionA collection of expiration dates and offsets for futures instruments
RoundToTickSize()Rounds the value up to the nearest valid value
RoundDownToTickSize()Rounds the value down to the nearest valid value
SplitsA collection of splits for stock instruments
TickSizeThe smallest movement in price configured
UrlA web url where contract details have been collected