Class hierarchy¶
This section documents every public class in the library, one page per module. On each page the module comes first, then each class in the order the module defines it, and under each class every property and method in the order it appears in the code, each with examples. The example programs for a class follow its members. The menu on the right of a module page lists its classes with their members beneath them.
The tree below shows all 231 classes by inheritance. A class hangs under its base when it has exactly one base in this library. A class whose bases all come from outside the library, or that inherits several of the library's classes side by side, starts a new branch, and those bases are named beside it.
Accountintradingmachine.accounts.accountAssetBasketintradingmachine.asset_baskets.asset_basket, inheritingPriceStatistics,OverlapStudies,MomentumIndicators,VolumeIndicators,CycleIndicators,PriceTransforms,VolatilityIndicators,StatisticFunctions,MathTransforms,MathOperators,CandlestickPatterns,Signals,StrategyBacktests,PerformanceMeasuresExchangeTradedFundConstituentsintradingmachine.asset_baskets.exchange_traded_fund_constituentsIndexintradingmachine.asset_baskets.indexMutualFundConstituentsintradingmachine.asset_baskets.mutual_fund_constituentsPortfoliointradingmachine.asset_baskets.portfolioWatchlistintradingmachine.asset_baskets.watchlist
BasketCsvImporterintradingmachine.asset_baskets.basket_csv_importerBasketMemberintradingmachine.asset_baskets.basket_memberBasketStoreintradingmachine.asset_baskets.basket_storeAssetBasketErrorintradingmachine.asset_baskets.exceptions, fromExceptionBasketNotFoundErrorintradingmachine.asset_baskets.exceptionsBasketMemberErrorintradingmachine.asset_baskets.exceptionsBasketCsvImportErrorintradingmachine.asset_baskets.exceptions
MemberResolverintradingmachine.asset_baskets.member_resolverPriceAnalysisintradingmachine.assets.analysis.price_analysisCandlestickPatternsintradingmachine.assets.analysis.candlestick_patternsCycleIndicatorsintradingmachine.assets.analysis.cycle_indicatorsMathOperatorsintradingmachine.assets.analysis.math_operatorsMathTransformsintradingmachine.assets.analysis.math_transformsMomentumIndicatorsintradingmachine.assets.analysis.momentum_indicatorsOverlapStudiesintradingmachine.assets.analysis.overlap_studiesPerformanceMeasuresintradingmachine.assets.analysis.performance_measuresPriceStatisticsintradingmachine.assets.analysis.price_statisticsPriceTransformsintradingmachine.assets.analysis.price_transformsSignalsintradingmachine.assets.analysis.signalsStatisticFunctionsintradingmachine.assets.analysis.statistic_functionsStrategyBacktestsintradingmachine.assets.analysis.strategy_backtestsVolatilityIndicatorsintradingmachine.assets.analysis.volatility_indicatorsVolumeIndicatorsintradingmachine.assets.analysis.volume_indicators
InstrumentErrorintradingmachine.assets.exceptions, fromExceptionTradeableInstrumentErrorintradingmachine.assets.exceptionsNonTradeableInstrumentErrorintradingmachine.assets.exceptionsDerivativeErrorintradingmachine.assets.exceptionsFuturesErrorintradingmachine.assets.exceptionsOptionErrorintradingmachine.assets.exceptionsIndexFuturesErrorintradingmachine.assets.exceptionsIndexOptionErrorintradingmachine.assets.exceptionsUnderlyingErrorintradingmachine.assets.exceptionsPositionErrorintradingmachine.assets.exceptionsHoldingErrorintradingmachine.assets.exceptionsEquityErrorintradingmachine.assets.exceptionsEquityFuturesErrorintradingmachine.assets.exceptionsEquityOptionErrorintradingmachine.assets.exceptionsEquityIndexErrorintradingmachine.assets.exceptionsEquityIndexFuturesErrorintradingmachine.assets.exceptionsEquityIndexOptionErrorintradingmachine.assets.exceptionsFixedIncomeErrorintradingmachine.assets.exceptionsFixedIncomeFuturesErrorintradingmachine.assets.exceptionsFixedIncomeOptionErrorintradingmachine.assets.exceptionsFixedIncomeIndexErrorintradingmachine.assets.exceptionsFixedIncomeIndexFuturesErrorintradingmachine.assets.exceptionsFixedIncomeIndexOptionErrorintradingmachine.assets.exceptionsCommodityErrorintradingmachine.assets.exceptionsCommodityFuturesErrorintradingmachine.assets.exceptionsCommodityOptionErrorintradingmachine.assets.exceptionsCommodityIndexErrorintradingmachine.assets.exceptionsCommodityIndexFuturesErrorintradingmachine.assets.exceptionsCommodityIndexOptionErrorintradingmachine.assets.exceptionsCurrencyErrorintradingmachine.assets.exceptionsCurrencyFuturesErrorintradingmachine.assets.exceptionsCurrencyOptionErrorintradingmachine.assets.exceptionsCurrencyIndexErrorintradingmachine.assets.exceptionsCurrencyIndexFuturesErrorintradingmachine.assets.exceptionsCurrencyIndexOptionErrorintradingmachine.assets.exceptionsExchangeTradedFundErrorintradingmachine.assets.exceptionsInvestmentTrustErrorintradingmachine.assets.exceptionsMutualFundErrorintradingmachine.assets.exceptions
Instrumentintradingmachine.assets.instruments, inheritingPriceStatistics,OverlapStudies,MomentumIndicators,VolumeIndicators,CycleIndicators,PriceTransforms,VolatilityIndicators,StatisticFunctions,MathTransforms,MathOperators,CandlestickPatterns,Signals,StrategyBacktests,PerformanceMeasuresTradeableInstrumentintradingmachine.assets.instrumentsCommodityintradingmachine.assets.commoditiesCurrencyintradingmachine.assets.currenciesEquityintradingmachine.assets.equitiesFixedIncomeintradingmachine.assets.fixed_incomeExchangeTradedFundintradingmachine.assets.fundsInvestmentTrustintradingmachine.assets.fundsDerivativeintradingmachine.assets.instrumentsFuturesintradingmachine.assets.instrumentsCommodityFuturesintradingmachine.assets.commoditiesCurrencyFuturesintradingmachine.assets.currenciesEquityFuturesintradingmachine.assets.equitiesFixedIncomeFuturesintradingmachine.assets.fixed_incomeIndexFuturesintradingmachine.assets.instrumentsCommodityIndexFuturesintradingmachine.assets.commoditiesCurrencyIndexFuturesintradingmachine.assets.currenciesEquityIndexFuturesintradingmachine.assets.equitiesFixedIncomeIndexFuturesintradingmachine.assets.fixed_income
Optionintradingmachine.assets.instrumentsCommodityOptionintradingmachine.assets.commoditiesCurrencyOptionintradingmachine.assets.currenciesEquityOptionintradingmachine.assets.equitiesFixedIncomeOptionintradingmachine.assets.fixed_incomeIndexOptionintradingmachine.assets.instrumentsCommodityIndexOptionintradingmachine.assets.commoditiesCurrencyIndexOptionintradingmachine.assets.currenciesEquityIndexOptionintradingmachine.assets.equitiesFixedIncomeIndexOptionintradingmachine.assets.fixed_income
MutualFundintradingmachine.assets.mutual_funds
NonTradeableInstrumentintradingmachine.assets.instrumentsCommodityIndexintradingmachine.assets.commoditiesCurrencyIndexintradingmachine.assets.currenciesEquityIndexintradingmachine.assets.equitiesFixedIncomeIndexintradingmachine.assets.fixed_income
OptionPricingModelintradingmachine.assets.option_pricingBlackScholesintradingmachine.assets.option_pricingBlack76intradingmachine.assets.option_pricing
ExposureWatchintradingmachine.orders.exposure_watchOrderCandidateintradingmachine.orders.order_candidatePlanPartintradingmachine.orders.plan_parts.plan_partAccountConditionintradingmachine.orders.plan_parts.account_conditionAllAtOnceExecutionintradingmachine.orders.plan_parts.all_at_once_executionAllConditionsintradingmachine.orders.plan_parts.all_conditionsAnyConditionintradingmachine.orders.plan_parts.any_conditionBookDepthExecutionintradingmachine.orders.plan_parts.book_depth_executionCandleClosesintradingmachine.orders.plan_parts.candle_closesCapModifierintradingmachine.orders.plan_parts.cap_modifierChasePricingintradingmachine.orders.plan_parts.chase_pricingDailyExecutionintradingmachine.orders.plan_parts.daily_executionDiscretionModifierintradingmachine.orders.plan_parts.discretion_modifierEitherPartintradingmachine.orders.plan_parts.either_partFixedPricingintradingmachine.orders.plan_parts.fixed_pricingFollowInstrumentPricingintradingmachine.orders.plan_parts.follow_instrument_pricingFreezeLimitExecutionintradingmachine.orders.plan_parts.freeze_limit_executionFromFillPricingintradingmachine.orders.plan_parts.from_fill_pricingFromParentFillPricingintradingmachine.orders.plan_parts.from_parent_fill_pricingFrontLoadedExecutionintradingmachine.orders.plan_parts.front_loaded_executionIcebergExecutionintradingmachine.orders.plan_parts.iceberg_executionLadderExecutionintradingmachine.orders.plan_parts.ladder_executionLifetimeintradingmachine.orders.plan_parts.lifetimeLimitMarketableintradingmachine.orders.plan_parts.limit_marketableMarketablePricingintradingmachine.orders.plan_parts.marketable_pricingNativeStopPricingintradingmachine.orders.plan_parts.native_stop_pricingOptionModelPricingintradingmachine.orders.plan_parts.option_model_pricingOrderPartintradingmachine.orders.plan_parts.order_partPaperVenueintradingmachine.orders.plan_parts.paper_venueParentFillDeltaQuantityintradingmachine.orders.plan_parts.parent_fill_delta_quantityParentFillQuantityintradingmachine.orders.plan_parts.parent_fill_quantityParticipationExecutionintradingmachine.orders.plan_parts.participation_executionPegPricingintradingmachine.orders.plan_parts.peg_pricingPositionQuantityintradingmachine.orders.plan_parts.position_quantityPostOnlyGuardintradingmachine.orders.plan_parts.post_only_guardPreOpenVenueintradingmachine.orders.plan_parts.pre_open_venuePresetintradingmachine.orders.plan_parts.presetPriceCrossesintradingmachine.orders.plan_parts.price_crossesRepeatPartintradingmachine.orders.plan_parts.repeat_partSequencePartintradingmachine.orders.plan_parts.sequence_partStageRuleintradingmachine.orders.plan_parts.stage_ruleStagesPricingintradingmachine.orders.plan_parts.stages_pricingThenPartintradingmachine.orders.plan_parts.then_partTimeAfterintradingmachine.orders.plan_parts.time_afterTimeAtintradingmachine.orders.plan_parts.time_atTimeBeforeintradingmachine.orders.plan_parts.time_beforeTimeFromintradingmachine.orders.plan_parts.time_fromTogetherPartintradingmachine.orders.plan_parts.together_partTopUpExecutionintradingmachine.orders.plan_parts.top_up_executionTrailPricingintradingmachine.orders.plan_parts.trail_pricingTrailsintradingmachine.orders.plan_parts.trailsTwapExecutionintradingmachine.orders.plan_parts.twap_executionUsingPartintradingmachine.orders.plan_parts.using_partVwapExecutionintradingmachine.orders.plan_parts.vwap_execution
SyntheticOrderintradingmachine.orders.synthetic_orderAccountConditionalOrderintradingmachine.orders.account_conditionalAccumulationOrderintradingmachine.orders.accumulationAttachedHedgeOrderintradingmachine.orders.attached_hedgeAverageTrueRangeTrailOrderintradingmachine.orders.average_true_range_trailBasketOrderintradingmachine.orders.basketBracketOrderintradingmachine.orders.bracketCandleCloseStopOrderintradingmachine.orders.candle_close_stopChaserOrderintradingmachine.orders.chaserCloseOnTriggerOrderintradingmachine.orders.close_on_triggerClosingPriceOrderintradingmachine.orders.closing_priceCoverOrderintradingmachine.orders.coverCrossInstrumentOrderintradingmachine.orders.cross_instrumentDailyStopOrderintradingmachine.orders.daily_stopDiscretionaryOrderintradingmachine.orders.discretionaryExposureHedgeOrderintradingmachine.orders.exposure_hedgeFreezeSlicerOrderintradingmachine.orders.freeze_slicerGoodTillTimeOrderintradingmachine.orders.good_till_timeGoodTillTriggeredOrderintradingmachine.orders.good_till_triggeredGridOrderintradingmachine.orders.gridHiddenStopOrderintradingmachine.orders.hidden_stopIcebergOrderintradingmachine.orders.icebergImplementationShortfallOrderintradingmachine.orders.implementation_shortfallIndicatorTriggeredOrderintradingmachine.orders.indicator_triggeredLadderOrderintradingmachine.orders.ladderLeggedSpreadOrderintradingmachine.orders.legged_spreadLimitIfTouchedOrderintradingmachine.orders.limit_if_touchedLiquiditySeekingOrderintradingmachine.orders.liquidity_seekingMarketIfTouchedOrderintradingmachine.orders.market_if_touchedMarketableLimitOrderintradingmachine.orders.marketable_limitOneCancelsAllOrderintradingmachine.orders.one_cancels_allOneCancelsOtherOrderintradingmachine.orders.one_cancels_otherOneTriggersOtherOrderintradingmachine.orders.one_triggers_otherOpeningAuctionOrderintradingmachine.orders.opening_auctionParticipationOrderintradingmachine.orders.participationPegOrderintradingmachine.orders.pegPlanOrderintradingmachine.orders.planPostOnlyOrderintradingmachine.orders.post_onlyScaleOutOrderintradingmachine.orders.scale_outScaleWithProfitTakerOrderintradingmachine.orders.scale_with_profit_takerScheduledOrderintradingmachine.orders.scheduledSimpleOrderintradingmachine.orders.simpleSquareOffOrderintradingmachine.orders.square_offSteppedStopOrderintradingmachine.orders.stepped_stopStopAndReverseOrderintradingmachine.orders.stop_and_reverseStrategyStopOrderintradingmachine.orders.strategy_stopTimeStopOrderintradingmachine.orders.time_stopTimeWeightedAveragePriceOrderintradingmachine.orders.time_weighted_average_priceTrailingEntryOrderintradingmachine.orders.trailing_entryTrailingStopOrderintradingmachine.orders.trailing_stopTwoSidedBreakoutOrderintradingmachine.orders.two_sided_breakoutTwoSidedQuoteOrderintradingmachine.orders.two_sided_quoteUnderlyingPegOrderintradingmachine.orders.underlying_pegVirtualLimitOrderintradingmachine.orders.virtual_limitVolatilityOrderintradingmachine.orders.volatilityVolumeWeightedAveragePriceOrderintradingmachine.orders.volume_weighted_average_price
UnifiedBrokerInterfaceintradingmachine.unified_broker_interface.clientUnifiedBrokerInterfaceErrorintradingmachine.unified_broker_interface.exceptions, fromExceptionBadRequestErrorintradingmachine.unified_broker_interface.exceptionsAuthenticationErrorintradingmachine.unified_broker_interface.exceptionsLossLockoutErrorintradingmachine.unified_broker_interface.exceptionsNotFoundErrorintradingmachine.unified_broker_interface.exceptionsConflictErrorintradingmachine.unified_broker_interface.exceptionsOrderRejectedErrorintradingmachine.unified_broker_interface.exceptionsRateLimitErrorintradingmachine.unified_broker_interface.exceptionsBrokerErrorintradingmachine.unified_broker_interface.exceptionsServiceUnavailableErrorintradingmachine.unified_broker_interface.exceptionsOrderOutcomeUnknownErrorintradingmachine.unified_broker_interface.exceptionsServerErrorintradingmachine.unified_broker_interface.exceptionsUnreachableErrorintradingmachine.unified_broker_interface.exceptions
Configurationintradingmachine.utilities.configuration