Class OptionSale
Option Sale event represents a trade or another market event with the price
(for example, market open/close price, etc.) for each option symbol listed under the specified Underlying.
Option Sales are intended to provide information about option trades in a continuous time slice with
the additional metrics, like Option Volatility, Option Delta, and Underlying Price.
Option Sale events have unique Index
which can be used for later correction/cancellation processing.
For more details see Javadoc.
[EventCode(EventCodeNative.OptionSale)]
public class OptionSale : MarketEvent, IIndexedEvent, IEventType
- Inheritance
-
OptionSale
- Implements
- Inherited Members
Constructors
OptionSale()
Initializes a new instance of the OptionSale class.
public OptionSale()
OptionSale(string?)
Initializes a new instance of the OptionSale class with the specified event symbol.
public OptionSale(string? eventSymbol)
Parameters
eventSymbol
stringThe specified event symbol.
Fields
MaxSequence
Maximum allowed sequence value. Sequence
public const int MaxSequence = 4194303
Field Value
Properties
AggressorSide
Gets or sets aggressor side of this option sale event.
public Side AggressorSide { get; set; }
Property Value
AskPrice
Gets or sets the current ask price on the market when this option sale event had occurred.
public double AskPrice { get; set; }
Property Value
BidPrice
Gets or sets the current bid price on the market when this option sale event had occurred.
public double BidPrice { get; set; }
Property Value
Delta
Gets or sets option delta at the time of this option sale event. Delta is the first derivative of an option price by an underlying price.
public double Delta { get; set; }
Property Value
EventFlags
Gets or sets transactional event flags.
public int EventFlags { get; set; }
Property Value
EventSource
Gets a source identifier for this event, which is always DEFAULT for time-series events.
public IndexedEventSource EventSource { get; }
Property Value
ExchangeCode
Gets or sets exchange code of this option sale event.
public char ExchangeCode { get; set; }
Property Value
ExchangeSaleConditions
Gets or sets sale conditions provided for this event by data feed. This field format is specific for every particular data feed.
public string? ExchangeSaleConditions { get; set; }
Property Value
Index
Gets or sets unique per-symbol index of this option sale event.
public long Index { get; set; }
Property Value
IsCancel
Gets a value indicating whether this is a cancellation of a previous event.
It is false
for newly created option sale event.
true
if this is a cancellation of a previous event.
public bool IsCancel { get; }
Property Value
IsCorrection
Gets a value indicating whether this is a correction of a previous event.
It is false
for newly created optionsale event.
true
if this is a correction of a previous event.
public bool IsCorrection { get; }
Property Value
IsExtendedTradingHours
Gets or sets a value indicating whether this event represents an extended trading hours sale.
public bool IsExtendedTradingHours { get; set; }
Property Value
IsNew
Gets a value indicating whether this is a new event (not cancellation or correction).
It is true
for newly created option sale event.
public bool IsNew { get; }
Property Value
IsSpreadLeg
Gets or sets a value indicating whether this event represents a spread leg.
public bool IsSpreadLeg { get; set; }
Property Value
IsValidTick
Gets or sets a value indicating whether this event represents a valid intraday tick. Note, that a correction for a previously distributed valid tick represents a new valid tick itself, but a cancellation of a previous valid tick does not.
public bool IsValidTick { get; set; }
Property Value
OptionSymbol
Gets or sets option symbol of this event.
public string? OptionSymbol { get; set; }
Property Value
Price
Gets or sets price of this option sale event.
public double Price { get; set; }
Property Value
Sequence
Gets or sets sequence number sequence number of this order to distinguish orders that have the same Time. This sequence number does not have to be unique and does not need to be sequential. Sequence can range from 0 to MaxSequence.
public int Sequence { get; set; }
Property Value
Exceptions
- ArgumentException
If sequence out of range.
Size
Gets or sets size this option sale event as floating number with fractions.
public double Size { get; set; }
Property Value
Time
Gets or sets timestamp of the original event. Time is measured in milliseconds between the current time and midnight, January 1, 1970 UTC.
public long Time { get; set; }
Property Value
TimeNanoPart
Gets or sets microseconds and nanoseconds time part of event.
public int TimeNanoPart { get; set; }
Property Value
TimeNanos
Gets or sets time of the last trade in nanoseconds. Time is measured in nanoseconds between the current time and midnight, January 1, 1970 UTC.
public long TimeNanos { get; set; }
Property Value
TimeSequence
Gets or sets time and sequence of of this event. Do not set this property directly. Sets Time and/or Sequence.
public long TimeSequence { get; set; }
Property Value
TradeThroughExempt
Gets or sets TradeThroughExempt flag of this option sale event.
public char TradeThroughExempt { get; set; }
Property Value
Type
Gets or sets type of this option sale event.
public TimeAndSaleType Type { get; set; }
Property Value
UnderlyingPrice
Gets or sets underlying price at the time of this option sale event.
public double UnderlyingPrice { get; set; }
Property Value
Volatility
Gets or sets Black-Scholes implied volatility of the option at the time of this option sale event.
public double Volatility { get; set; }
Property Value
Methods
ToString()
Returns string representation of this option sale event.
public override string ToString()
Returns
- string
The string representation.