quantdata.massive.trade_conds#

quantdata.massive.trade_conds#

OPRA (options) and spot (stocks) trade condition codes and bitmask flags.

Sources: - https://massive.com/glossary/trade-conditions - https://massive.com/glossary/conditions-indicators

Design: - Keep the vendor condition IDs as IntEnum values (as returned in conditions). - Provide IntFlag bitmasks for fast filtering/joins (int32). - pack_conditions raises on unknown codes so vendor schema changes are explicit.

Use the function filter_valid_trades() in quantdata.massive.processing to filter out bad trades based NORMAL_TRADE_EXCLUDE_FLAGS.

class quantdata.massive.trade_conds.ConditionCode(*values)[source]#

Bases: IntEnum

Massive condition IDs (stocks 0..60-ish, options 201..248).

See https://massive.com/glossary/trade-conditions and https://massive.com/glossary/conditions-indicators

REGULAR_SALE = 0#
ACQUISITION = 1#
AVERAGE_PRICE_TRADE = 2#
STOCK_AUTOMATIC_EXECUTION = 3#
BUNCHED_TRADE = 4#
BUNCHED_SOLD_TRADE = 5#
CAP_ELECTION = 6#
CASH_SALE = 7#
CLOSING_PRINTS = 8#
CROSS_TRADE = 9#
DERIVATIVELY_PRICED = 10#
DISTRIBUTION = 11#
FORM_T_EXTENDED_HOURS = 12#
EXTENDED_HOURS_OOS = 13#
STOCK_INTERMARKET_SWEEP = 14#
MARKET_CENTER_OFFICIAL_CLOSE = 15#
MARKET_CENTER_OFFICIAL_OPEN = 16#
MARKET_CENTER_OPENING_TRADE = 17#
MARKET_CENTER_REOPENING_TRADE = 18#
MARKET_CENTER_CLOSING_TRADE = 19#
NEXT_DAY = 20#
PRICE_VARIATION_TRADE = 21#
PRIOR_REFERENCE_PRICE = 22#
RULE_155_AMEX = 23#
RULE_127_NYSE = 24#
OPENING_PRINTS = 25#
OPENED = 26#
STOPPED_STOCK_REGULAR = 27#
REOPENING_PRINTS = 28#
SELLER = 29#
SOLD_LAST = 30#
SOLD_OUT = 32#
SOLD_OUT_OF_SEQUENCE = 33#
SPLIT_TRADE = 34#
STOCK_OPTION_TRADE = 35#
YELLOW_FLAG_REGULAR = 36#
ODD_LOT_TRADE = 37#
CORRECTED_CONSOLIDATED_CLOSE = 38#
UNKNOWN = 39#
HELD_TRADES = 40#
TRADE_THRU_EXEMPT = 41#
NON_ELIGIBLE = 42#
NON_ELIGIBLE_EXTENDED = 43#
CANCELLED = 44#
RECOVERY = 45#
CORRECTION = 46#
AS_OF = 47#
AS_OF_CORRECTION = 48#
AS_OF_CANCEL = 49#
OOB = 50#
SUMMARY = 51#
CONTINGENT_TRADE = 52#
QUALIFIED_CONTINGENT_TRADE = 53#
ERRORED = 54#
OPENING_REOPENING_TRADE_DETAIL = 55#
PLACEHOLDER_E_TBD = 56#
PLACEHOLDER_611_EXEMPT = 59#
SSR_IN_EFFECT = 60#
CANCEL = 201#
LATE_AND_OOS = 202#
LAST_AND_CANCELED = 203#
LATE = 204#
OPENING_AND_CANCELED = 205#
OPENING_LATE_AND_OOS = 206#
ONLY_TRADE_AND_CANCELED = 207#
OPENING_LATE = 208#
AUTOMATIC_EXECUTION = 209#
REOPENING_TRADE = 210#
INTERMARKET_SWEEP = 219#
SINGLE_LEG_AUCTION_NON_ISO = 227#
SINGLE_LEG_AUCTION_ISO = 228#
SINGLE_LEG_CROSS_NON_ISO = 229#
SINGLE_LEG_CROSS_ISO = 230#
SINGLE_LEG_FLOOR_TRADE = 231#
MULTI_LEG_AUTO = 232#
MULTI_LEG_AUCTION = 233#
MULTI_LEG_CROSS = 234#
MULTI_LEG_FLOOR_TRADE = 235#
MULTI_LEG_AUTO_AGAINST_SINGLE_LEG = 236#
STOCK_OPTIONS_AUCTION = 237#
MULTI_LEG_AUCTION_AGAINST_SINGLE_LEG = 238#
MULTI_LEG_FLOOR_TRADE_AGAINST_SINGLE_LEG = 239#
STOCK_OPTIONS_AUTO = 240#
STOCK_OPTIONS_CROSS = 241#
STOCK_OPTIONS_FLOOR_TRADE = 242#
STOCK_OPTIONS_AUTO_AGAINST_SINGLE_LEG = 243#
STOCK_OPTIONS_AUCTION_AGAINST_SINGLE_LEG = 244#
STOCK_OPTIONS_FLOOR_TRADE_AGAINST_SINGLE_LEG = 245#
MULTI_LEG_FLOOR_PROPRIETARY_3PLUS = 246#
MULTILATERAL_COMPRESSION_PROPRIETARY = 247#
EXTENDED_HOURS_TRADE = 248#
class quantdata.massive.trade_conds.ConditionFlag(*values)[source]#

Bases: IntFlag

Semantic bitmask (int32).

NONE = 0#
LATE = 1#
OUT_OF_SEQUENCE = 2#
CANCELLED = 4#
CORRECTION = 8#
AS_OF = 16#
ERRORED = 32#
ELECTRONIC = 64#
FLOOR = 128#
ISO = 256#
AUCTION = 512#
CROSS = 1024#
COMPLEX = 2048#
STOCK_OPTION = 4096#
EXTENDED_HOURS = 8192#
COMPRESSION = 16384#
PROPRIETARY_PRODUCT = 32768#
ODD_LOT = 65536#
OPENING_PRINT = 131072#
CLOSING_PRINT = 262144#
OFFICIAL_OPEN = 524288#
OFFICIAL_CLOSE = 1048576#
CONTINGENT = 2097152#
QCT = 4194304#
TRADE_THRU_EXEMPT = 8388608#
SSR = 16777216#
quantdata.massive.trade_conds.CODE_TO_FLAG: dict[ConditionCode, ConditionFlag] = {ConditionCode.CLOSING_PRINTS: <ConditionFlag.CLOSING_PRINT: 262144>, ConditionCode.CROSS_TRADE: <ConditionFlag.CROSS: 1024>, ConditionCode.FORM_T_EXTENDED_HOURS: <ConditionFlag.EXTENDED_HOURS: 8192>, ConditionCode.EXTENDED_HOURS_OOS: <ConditionFlag.OUT_OF_SEQUENCE|EXTENDED_HOURS: 8194>, ConditionCode.STOCK_INTERMARKET_SWEEP: <ConditionFlag.ISO: 256>, ConditionCode.MARKET_CENTER_OFFICIAL_CLOSE: <ConditionFlag.OFFICIAL_CLOSE: 1048576>, ConditionCode.MARKET_CENTER_OFFICIAL_OPEN: <ConditionFlag.OFFICIAL_OPEN: 524288>, ConditionCode.MARKET_CENTER_OPENING_TRADE: <ConditionFlag.OPENING_PRINT: 131072>, ConditionCode.MARKET_CENTER_REOPENING_TRADE: <ConditionFlag.OPENING_PRINT: 131072>, ConditionCode.MARKET_CENTER_CLOSING_TRADE: <ConditionFlag.CLOSING_PRINT: 262144>, ConditionCode.OPENING_PRINTS: <ConditionFlag.OPENING_PRINT: 131072>, ConditionCode.SOLD_OUT: <ConditionFlag.NONE: 0>, ConditionCode.SOLD_OUT_OF_SEQUENCE: <ConditionFlag.OUT_OF_SEQUENCE: 2>, ConditionCode.STOCK_OPTION_TRADE: <ConditionFlag.STOCK_OPTION: 4096>, ConditionCode.ODD_LOT_TRADE: <ConditionFlag.ODD_LOT: 65536>, ConditionCode.CORRECTED_CONSOLIDATED_CLOSE: <ConditionFlag.CORRECTION|OFFICIAL_CLOSE: 1048584>, ConditionCode.TRADE_THRU_EXEMPT: <ConditionFlag.TRADE_THRU_EXEMPT: 8388608>, ConditionCode.CANCELLED: <ConditionFlag.CANCELLED: 4>, ConditionCode.CORRECTION: <ConditionFlag.CORRECTION: 8>, ConditionCode.AS_OF: <ConditionFlag.AS_OF: 16>, ConditionCode.AS_OF_CORRECTION: <ConditionFlag.CORRECTION|AS_OF: 24>, ConditionCode.AS_OF_CANCEL: <ConditionFlag.CANCELLED|AS_OF: 20>, ConditionCode.CONTINGENT_TRADE: <ConditionFlag.CONTINGENT: 2097152>, ConditionCode.QUALIFIED_CONTINGENT_TRADE: <ConditionFlag.CONTINGENT|QCT: 6291456>, ConditionCode.ERRORED: <ConditionFlag.ERRORED: 32>, ConditionCode.SSR_IN_EFFECT: <ConditionFlag.SSR: 16777216>, ConditionCode.CANCEL: <ConditionFlag.CANCELLED: 4>, ConditionCode.LATE_AND_OOS: <ConditionFlag.LATE|OUT_OF_SEQUENCE: 3>, ConditionCode.LAST_AND_CANCELED: <ConditionFlag.CANCELLED: 4>, ConditionCode.LATE: <ConditionFlag.LATE: 1>, ConditionCode.OPENING_AND_CANCELED: <ConditionFlag.CANCELLED: 4>, ConditionCode.OPENING_LATE_AND_OOS: <ConditionFlag.LATE|OUT_OF_SEQUENCE: 3>, ConditionCode.ONLY_TRADE_AND_CANCELED: <ConditionFlag.CANCELLED: 4>, ConditionCode.OPENING_LATE: <ConditionFlag.LATE: 1>, ConditionCode.AUTOMATIC_EXECUTION: <ConditionFlag.ELECTRONIC: 64>, ConditionCode.REOPENING_TRADE: <ConditionFlag.NONE: 0>, ConditionCode.INTERMARKET_SWEEP: <ConditionFlag.ISO: 256>, ConditionCode.SINGLE_LEG_AUCTION_NON_ISO: <ConditionFlag.ELECTRONIC|AUCTION: 576>, ConditionCode.SINGLE_LEG_AUCTION_ISO: <ConditionFlag.ELECTRONIC|ISO|AUCTION: 832>, ConditionCode.SINGLE_LEG_CROSS_NON_ISO: <ConditionFlag.ELECTRONIC|CROSS: 1088>, ConditionCode.SINGLE_LEG_CROSS_ISO: <ConditionFlag.ELECTRONIC|ISO|CROSS: 1344>, ConditionCode.SINGLE_LEG_FLOOR_TRADE: <ConditionFlag.FLOOR: 128>, ConditionCode.MULTI_LEG_AUTO: <ConditionFlag.ELECTRONIC|COMPLEX: 2112>, ConditionCode.MULTI_LEG_AUCTION: <ConditionFlag.ELECTRONIC|AUCTION|COMPLEX: 2624>, ConditionCode.MULTI_LEG_CROSS: <ConditionFlag.ELECTRONIC|CROSS|COMPLEX: 3136>, ConditionCode.MULTI_LEG_FLOOR_TRADE: <ConditionFlag.FLOOR|COMPLEX: 2176>, ConditionCode.MULTI_LEG_AUTO_AGAINST_SINGLE_LEG: <ConditionFlag.ELECTRONIC|COMPLEX: 2112>, ConditionCode.STOCK_OPTIONS_AUCTION: <ConditionFlag.ELECTRONIC|AUCTION|COMPLEX|STOCK_OPTION: 6720>, ConditionCode.MULTI_LEG_AUCTION_AGAINST_SINGLE_LEG: <ConditionFlag.ELECTRONIC|AUCTION|COMPLEX: 2624>, ConditionCode.MULTI_LEG_FLOOR_TRADE_AGAINST_SINGLE_LEG: <ConditionFlag.FLOOR|COMPLEX: 2176>, ConditionCode.STOCK_OPTIONS_AUTO: <ConditionFlag.ELECTRONIC|COMPLEX|STOCK_OPTION: 6208>, ConditionCode.STOCK_OPTIONS_CROSS: <ConditionFlag.ELECTRONIC|CROSS|COMPLEX|STOCK_OPTION: 7232>, ConditionCode.STOCK_OPTIONS_FLOOR_TRADE: <ConditionFlag.FLOOR|COMPLEX|STOCK_OPTION: 6272>, ConditionCode.STOCK_OPTIONS_AUTO_AGAINST_SINGLE_LEG: <ConditionFlag.ELECTRONIC|COMPLEX|STOCK_OPTION: 6208>, ConditionCode.STOCK_OPTIONS_AUCTION_AGAINST_SINGLE_LEG: <ConditionFlag.ELECTRONIC|AUCTION|COMPLEX|STOCK_OPTION: 6720>, ConditionCode.STOCK_OPTIONS_FLOOR_TRADE_AGAINST_SINGLE_LEG: <ConditionFlag.FLOOR|COMPLEX|STOCK_OPTION: 6272>, ConditionCode.MULTI_LEG_FLOOR_PROPRIETARY_3PLUS: <ConditionFlag.FLOOR|COMPLEX|PROPRIETARY_PRODUCT: 34944>, ConditionCode.MULTILATERAL_COMPRESSION_PROPRIETARY: <ConditionFlag.COMPRESSION|PROPRIETARY_PRODUCT: 49152>, ConditionCode.EXTENDED_HOURS_TRADE: <ConditionFlag.EXTENDED_HOURS: 8192>}#

Map from detailed condition codes to unified flags

quantdata.massive.trade_conds.BAD_TRADE_CONDITIONS = <ConditionFlag.LATE|OUT_OF_SEQUENCE|CANCELLED: 7>#

cancelled, late reporting, or out-of-sequence. These are the most common data quality issues and are often filtered out in analyses.

Type:

Bad trade conditions

quantdata.massive.trade_conds.MICROSTRUCTURE_HARD_EXCLUDE = <ConditionFlag.LATE|OUT_OF_SEQUENCE|CANCELLED|CORRECTION|AS_OF|ERRORED|COMPRESSION: 16447>#

Microstructure conditions to exclude for clean trade/quote analysis. These include bad trade conditions compression, corrections, as-of trades, and errored trades.

We do not exclude ConditionFlag.EXTENDED_HOURS here as extended hours trades can be exluded easily later based on their time stamp, see filter_valid_trades() in quantdata.massive.processing.

quantdata.massive.trade_conds.NORMAL_TRADE_EXCLUDE_FLAGS = <ConditionFlag.LATE|OUT_OF_SEQUENCE|CANCELLED|CORRECTION|AS_OF|ERRORED|CROSS|COMPRESSION|OPENING_PRINT|CLOSING_PRINT|OFFICIAL_OPEN|OFFICIAL_CLOSE|CONTINGENT|QCT|TRADE_THRU_EXEMPT: 16663615>#

these conditions are commonly excluded when filtering for regular market trades. This includes all microstructure hard excludes plus cross trades, opening/closing prints, official open/closes, and contingent trades.

We do not exclude ConditionFlag.ODD_LOT here.

Type:

Flags for normal trade filtering

quantdata.massive.trade_conds.pack_conditions(codes)[source]#

Pack Massive/Polygon conditions (iterable of ints) into an int32 semantic mask. Unknown codes raise ValueError.