Lean  $LEAN_TAG$
QuantConnect.Data.Auxiliary Namespace Reference

Classes

class  AuxiliaryDataKey
 Unique definition key for a collection of auxiliary data for a Market and SecurityType More...
 
class  CorporateFactorProvider
 Corporate related factor provider. Factors based on splits and dividends More...
 
class  CorporateFactorRow
 Defines a single row in a factor_factor file. This is a csv file ordered as {date, price factor, split factor, reference price} More...
 
class  FactorFile
 Represents an entire factor file for a specified symbol More...
 
class  FactorFileZipHelper
 Provides methods for reading factor file zips More...
 
interface  IFactorProvider
 Providers price scaling factors for a permanent tick More...
 
interface  IFactorRow
 Factor row abstraction. IFactorProvider More...
 
class  LocalDiskFactorFileProvider
 Provides an implementation of IFactorFileProvider that searches the local disk More...
 
class  LocalDiskMapFileProvider
 Provides a default implementation of IMapFileProvider that reads from the local disk More...
 
class  LocalZipFactorFileProvider
 Provides an implementation of IFactorFileProvider that searches the local disk for a zip file containing all factor files More...
 
class  LocalZipMapFileProvider
 Provides an implementation of IMapFileProvider that reads from a local zip file More...
 
class  MapFile
 Represents an entire map file for a specified symbol More...
 
class  MapFilePrimaryExchangeProvider
 Implementation of IPrimaryExchangeProvider from map files. More...
 
class  MapFileResolver
 Provides a means of mapping a symbol at a point in time to the map file containing that share class's mapping information More...
 
class  MapFileRow
 Represents a single row in a map_file. This is a csv file ordered as {date, mapped symbol} More...
 
class  MapFileZipHelper
 Helper class for handling mapfile zip files More...
 
class  MappingContractFactorProvider
 Mapping related factor provider. Factors based on price differences on mapping dates More...
 
class  MappingContractFactorRow
 Collection of factors for continuous contracts and their back months contracts for a specific mapping mode DataMappingMode and date More...
 
class  MappingExtensions
 Mapping extensions helper methods More...
 
class  PriceScalingExtensions
 Set of helper methods for factor files and price scaling operations More...
 
struct  SymbolDateRange
 Represents security identifier within a date range. More...
 
struct  TickerDateRange
 Represents stock data for a specific ticker within a date range. More...
 
class  ZipEntryName
 Defines a data type that just produces data points from the zip entry names in a zip file More...
 

Enumerations

enum  QuoteConditionFlags : long {
  QuoteConditionFlags.None = 0, QuoteConditionFlags.Regular = 1L << 0, QuoteConditionFlags.Slow = 1L << 1, QuoteConditionFlags.Gap = 1L << 2,
  QuoteConditionFlags.Closing = 1L << 3, QuoteConditionFlags.NewsDissemination = 1L << 4, QuoteConditionFlags.NewsPending = 1L << 5, QuoteConditionFlags.TradingRangeIndication = 1L << 6,
  QuoteConditionFlags.OrderImbalance = 1L << 7, QuoteConditionFlags.ClosedMarketMaker = 1L << 8, QuoteConditionFlags.VolatilityTradingPause = 1L << 9, QuoteConditionFlags.NonFirmQuote = 1L << 10,
  QuoteConditionFlags.OpeningQuote = 1L << 11, QuoteConditionFlags.DueToRelatedSecurity = 1L << 12, QuoteConditionFlags.Resume = 1L << 13, QuoteConditionFlags.InViewOfCommon = 1L << 14,
  QuoteConditionFlags.EquipmentChangeover = 1L << 15, QuoteConditionFlags.SubPennyTrading = 1L << 16, QuoteConditionFlags.NoOpenNoResume = 1L << 17, QuoteConditionFlags.LimitUpLimitDownPriceBand = 1L << 18,
  QuoteConditionFlags.RepublishedLimitUpLimitDownPriceBand = 1L << 19, QuoteConditionFlags.Manual = 1L << 20, QuoteConditionFlags.FastTrading = 1L << 21, QuoteConditionFlags.OrderInflux = 1L << 22
}
 Flag system for quote conditions More...
 
enum  TradeConditionFlags : long {
  TradeConditionFlags.None = 0, TradeConditionFlags.Regular = 1L << 0, TradeConditionFlags.Cash = 1L << 1, TradeConditionFlags.NextDay = 1L << 2,
  TradeConditionFlags.Seller = 1L << 3, TradeConditionFlags.YellowFlag = 1L << 4, TradeConditionFlags.IntermarketSweep = 1L << 5, TradeConditionFlags.OpeningPrints = 1L << 6,
  TradeConditionFlags.ClosingPrints = 1L << 7, TradeConditionFlags.ReOpeningPrints = 1L << 8, TradeConditionFlags.DerivativelyPriced = 1L << 9, TradeConditionFlags.FormT = 1L << 10,
  TradeConditionFlags.Sold = 1L << 11, TradeConditionFlags.Stopped = 1L << 12, TradeConditionFlags.ExtendedHours = 1L << 13, TradeConditionFlags.OutOfSequence = 1L << 14,
  TradeConditionFlags.Split = 1L << 15, TradeConditionFlags.Acquisition = 1L << 16, TradeConditionFlags.Bunched = 1L << 17, TradeConditionFlags.StockOption = 1L << 18,
  TradeConditionFlags.Distribution = 1L << 19, TradeConditionFlags.AveragePrice = 1L << 20, TradeConditionFlags.Cross = 1L << 21, TradeConditionFlags.PriceVariation = 1L << 22,
  TradeConditionFlags.Rule155 = 1L << 23, TradeConditionFlags.OfficialClose = 1L << 24, TradeConditionFlags.PriorReferencePrice = 1L << 25, TradeConditionFlags.OfficialOpen = 1L << 26,
  TradeConditionFlags.CapElection = 1L << 27, TradeConditionFlags.AutoExecution = 1L << 28, TradeConditionFlags.TradeThroughExempt = 1L << 29, TradeConditionFlags.UndocumentedFlag = 1L << 30,
  TradeConditionFlags.OddLot = 1L << 31
}
 Flag system for trade conditions More...
 

Enumeration Type Documentation

◆ QuoteConditionFlags

Flag system for quote conditions

Enumerator
None 

No Condition

Regular 

This condition is used for the majority of quotes to indicate a normal trading environment.

Slow 

This condition is used to indicate that the quote is a Slow Quote on both the Bid and Offer sides due to a Set Slow List that includes High Price securities.

Gap 

While in this mode, auto-execution is not eligible, the quote is then considered manual and non-firm in the Bid and Offer and either or both sides can be traded through as per Regulation NMS.

Closing 

This condition can be disseminated to indicate that this quote was the last quote for a security for that Participant.

NewsDissemination 

This regulatory Opening Delay or Trading Halt is used when relevant news influencing the security is being disseminated. Trading is suspended until the primary market determines that an adequate publication or disclosure of information has occurred.

NewsPending 

This condition is used to indicate a regulatory Opening Delay or Trading Halt due to an expected news announcement, which may influence the security. An Opening Delay or Trading Halt may be continued once the news has been disseminated.

TradingRangeIndication 

The condition is used to denote the probable trading range (bid and offer prices, no sizes) of a security that is not Opening Delayed or Trading Halted. The Trading Range Indication is used prior to or after the opening of a security.

OrderImbalance 

This non-regulatory Opening Delay or Trading Halt is used when there is a significant imbalance of buy or sell orders.

ClosedMarketMaker 

This condition is disseminated by each individual FINRA Market Maker to signify either the last quote of the day or the premature close of an individual Market Maker for the day.

VolatilityTradingPause 

This quote condition indicates a regulatory Opening Delay or Trading Halt due to conditions in which a security experiences a 10 % or more change in price over a five minute period.

NonFirmQuote 

This quote condition suspends a Participant's firm quote obligation for a quote for a security.

OpeningQuote 

This condition can be disseminated to indicate that this quote was the opening quote for a security for that Participant.

DueToRelatedSecurity 

This non-regulatory Opening Delay or Trading Halt is used when events relating to one security will affect the price and performance of another related security. This non-regulatory Opening Delay or Trading Halt is also used when non-regulatory halt reasons such as Order Imbalance, Order Influx and Equipment Changeover are combined with Due to Related Security on CTS.

Resume 

This quote condition along with zero-filled bid, offer and size fields is used to indicate that trading for a Participant is no longer suspended in a security which had been Opening Delayed or Trading Halted.

InViewOfCommon 

This quote condition is used when matters affecting the common stock of a company affect the performance of the non-common associated securities, e.g., warrants, rights, preferred, classes, etc.

EquipmentChangeover 

This non-regulatory Opening Delay or Trading Halt is used when the ability to trade a security by a Participant is temporarily inhibited due to a systems, equipment or communications facility problem or for other technical reasons.

SubPennyTrading 

This non-regulatory Opening Delay or Trading Halt is used to indicate an Opening Delay or Trading Halt for a security whose price may fall below $1.05, possibly leading to a sub-penny execution.

NoOpenNoResume 

This quote condition is used to indicate that an Opening Delay or a Trading Halt is to be in effect for the rest of the trading day in a security for a Participant.

LimitUpLimitDownPriceBand 

This quote condition is used to indicate that a Limit Up-Limit Down Price Band is applicable for a security.

RepublishedLimitUpLimitDownPriceBand 

This quote condition is used to indicate that a Limit Up-Limit Down Price Band that is being disseminated " + is a ‘republication’ of the latest Price Band for a security.

Manual 

This indicates that the market participant is in a manual mode on both the Bid and Ask. While in this mode, automated execution is not eligible on the Bid and Ask side and can be traded through pursuant to Regulation NMS requirements.

FastTrading 

For extremely active periods of short duration. While in this mode, the UTP participant will enter quotations on a “best efforts” basis.

OrderInflux 

A halt condition used when there is a sudden order influx. To prevent a disorderly market, trading is temporarily suspended by the UTP participant.

Definition at line 25 of file QuoteConditionFlags.cs.

◆ TradeConditionFlags

Flag system for trade conditions

Enumerator
None 

No Condition

Regular 

A trade made without stated conditions is deemed regular way for settlement on the third business day following the transaction date.

Cash 

A transaction which requires delivery of securities and payment on the same day the trade takes place.

NextDay 

A transaction that requires the delivery of securities on the first business day following the trade date.

Seller 

A Seller’s Option transaction gives the seller the right to deliver the security at any time within a specific period, ranging from not less than two calendar days, to not more than sixty calendar days.

YellowFlag 

Market Centers will have the ability to identify regular trades being reported during specific events as out of the ordinary by appending a new sale condition code Yellow Flag (Y) on each transaction reported to the UTP SIP. The new sale condition will be eligible to update all market center and consolidated statistics.

IntermarketSweep 

The transaction that constituted the trade-through was the execution of an order identified as an Intermarket Sweep Order.

OpeningPrints 

The trade that constituted the trade-through was a single priced opening transaction by the Market Center.

ClosingPrints 

The transaction that constituted the trade-through was a single priced closing transaction by the Market Center.

ReOpeningPrints 

The trade that constituted the trade-through was a single priced reopening transaction by the Market Center.

DerivativelyPriced 

The transaction that constituted the trade-through was the execution of an order at a price that was not based, directly or indirectly, on the quoted price of the security at the time of execution and for which the material terms were not reasonably determinable at the time the commitment to execute the order was made.

FormT 

Trading in extended hours enables investors to react quickly to events that typically occur outside regular market hours, such as earnings reports. However, liquidity may be constrained during such Form T trading, resulting in wide bid-ask spreads.

Sold 

Sold Last is used when a trade prints in sequence but is reported late or printed in conformance to the One or Two Point Rule.

Stopped 

The transaction that constituted the trade-through was the execution by a trading center of an order for which, at the time of receipt of the order, the execution at no worse than a specified price a 'stopped order'

ExtendedHours 

Identifies a trade that was executed outside of regular primary market hours and is reported as an extended hours trade.

OutOfSequence 

Identifies a trade that takes place outside of regular market hours.

Split 

An execution in two markets when the specialist or Market Maker in the market first receiving the order agrees to execute a portion of it at whatever price is realized in another market to which the balance of the order is forwarded for execution.

Acquisition 

A transaction made on the Exchange as a result of an Exchange acquisition.

Bunched 

A trade representing an aggregate of two or more regular trades in a security occurring at the same price either simultaneously or within the same 60-second period, with no individual trade exceeding 10,000 shares.

StockOption 

Stock-Option Trade is used to identify cash equity transactions which are related to options transactions and therefore potentially subject to cancellation if market conditions of the options leg(s) prevent the execution of the stock-option order at the price agreed upon.

Distribution 

Sale of a large block of stock in such a manner that the price is not adversely affected.

AveragePrice 

A trade where the price reported is based upon an average of the prices for transactions in a security during all or any portion of the trading day.

Cross 

Indicates that the trade resulted from a Market Center’s crossing session.

PriceVariation 

Indicates a regular market session trade transaction that carries a price that is significantly away from the prevailing consolidated or primary market value at the time of the transaction.

Rule155 

To qualify as a NYSE AMEX Rule 155

OfficialClose 

Indicates the ‘Official’ closing value as determined by a Market Center. This transaction report will contain the market center generated closing price.

PriorReferencePrice 

A sale condition that identifies a trade based on a price at a prior point in time i.e. more than 90 seconds prior to the time of the trade report. The execution time of the trade will be the time of the prior reference price.

OfficialOpen 

Indicates the ‘Official’ open value as determined by a Market Center. This transaction report will contain the market

CapElection 

The CAP Election Trade highlights sales as a result of a sweep execution on the NYSE, whereby CAP orders have been elected and executed outside the best price bid or offer and the orders appear as repeat trades at subsequent execution prices. This indicator provides additional information to market participants that an automatic sweep transaction has occurred with repeat trades as one continuous electronic transaction.

AutoExecution 

A sale condition code that identifies a NYSE trade that has been automatically executed without the potential benefit of price improvement.

TradeThroughExempt 

Denotes whether or not a trade is exempt (Rule 611) and when used jointly with certain Sale Conditions, will more fully describe the characteristics of a particular trade.

UndocumentedFlag 

This flag is present in raw data, but AlgoSeek document does not describe it.

OddLot 

Denotes the trade is an odd lot less than a 100 shares.

Definition at line 25 of file TradeConditionFlags.cs.