Hide navigation sidebar

Hide table of contents sidebar

Toggle site navigation sidebar

Trading Strategy documentation

Toggle table of contents sidebar

Documention home
Getting started
Overview
Toggle child pages in navigation
Developing strategies
Toggle child pages in navigation
- Setting up development environment
  Toggle child pages in navigation
- Trading strategy examples
- Code examples
  Toggle child pages in navigation
- Market data format details
  Toggle child pages in navigation
- Troubleshooting
- Internal development process
Architecture
Toggle child pages in navigation
Deploying live trading strategies
Toggle child pages in navigation
Learn algorithmic trading
Toggle child pages in navigation
Glossary
API reference
Toggle child pages in navigation
- Market data client
  Toggle child pages in navigation
  - client
    Toggle child pages in navigation
    - BaseClient
    - Client
  - chain
    Toggle child pages in navigation
    - ChainId
  - exchange
    Toggle child pages in navigation
  - pair
    Toggle child pages in navigation
  - candle
    Toggle child pages in navigation
  - liquidity
    Toggle child pages in navigation
  - trade
    Toggle child pages in navigation
    - Trade
  - timebucket
    Toggle child pages in navigation
    - TimeBucket
  - token
    Toggle child pages in navigation
    - Token
  - reader
    Toggle child pages in navigation
    - read_parquet
  - priceimpact
    Toggle child pages in navigation
  - stablecoin
    Toggle child pages in navigation
    - is_stablecoin_like
  - types
  - utils
    Toggle child pages in navigation
    - aggregate_ohlcv
      Toggle child pages in navigation
    - columnar
      Toggle child pages in navigation
      - iterate_columnar_dicts
    - df_index
      Toggle child pages in navigation
      - flatten_dataframe_datetime_index
      - get_timestamp_index
    - format
      Toggle child pages in navigation
    - forward_fill
      Toggle child pages in navigation
    - groupeduniverse
      Toggle child pages in navigation
    - jupyter
      Toggle child pages in navigation
    - liquidity_filter
      Toggle child pages in navigation
    - logging_retry
      Toggle child pages in navigation
      - LoggingRetry
    - mapper
    - schema
      Toggle child pages in navigation
    - time
      Toggle child pages in navigation
    - token_extra_data
      Toggle child pages in navigation
      - filter_scams
      - load_extra_metadata
    - token_filter
      Toggle child pages in navigation
    - wrangle
      Toggle child pages in navigation
  - transport
    Toggle child pages in navigation
    - base
      Toggle child pages in navigation
      - BaseTransport
    - cache
      Toggle child pages in navigation
    - data_trigger
      Toggle child pages in navigation
      - wait_for_data
    - jsonl
      Toggle child pages in navigation
      - load_candles_jsonl
      - load_trading_strategy_like_jsonl_data
    - progress_enabled_download
      Toggle child pages in navigation
      - download_with_tqdm_progress_bar
    - pyodide
  - charting
    Toggle child pages in navigation
    - candle_chart
      Toggle child pages in navigation
  - testing
    Toggle child pages in navigation
    - mock_client
      Toggle child pages in navigation
      - MockClient
    - uniswap_v2_mock_client
      Toggle child pages in navigation
      - UniswapV2MockClient
  - top
    Toggle child pages in navigation
  - binance
    Toggle child pages in navigation
    - constants
      Toggle child pages in navigation
      - split_binance_symbol
    - downloader
      Toggle child pages in navigation
    - utils
      Toggle child pages in navigation
  - alternative_data
  - direct_feed
    Toggle child pages in navigation
    - candle_feed
      Toggle child pages in navigation
      - CandleFeed
      - prepare_raw_candle_data
    - conversion
      Toggle child pages in navigation
      - CurrencyConversion
      - convert_to_float
    - dash
    - direct_feed_pair
    - ohlcv_aggregate
      Toggle child pages in navigation
    - store
      Toggle child pages in navigation
      - DirectFeedStore
    - synthetic_feed
      Toggle child pages in navigation
      - SyntheticTradeFeed
    - timeframe
      Toggle child pages in navigation
      - Timeframe
    - trade_feed
      Toggle child pages in navigation
      - SaveHook
      - Trade
      - TradeDelta
      - TradeFeed
    - trade_store
      Toggle child pages in navigation
      - ParquetFileStore
      - TradeFeedStore
    - uniswap_v2
      Toggle child pages in navigation
    - warn
      Toggle child pages in navigation
      - disable_pandas_warnings
- Trade execution engine
  Toggle child pages in navigation
  - state
    Toggle child pages in navigation
    - balance_update
      Toggle child pages in navigation
    - blockhain_transaction
      Toggle child pages in navigation
    - freeze
      Toggle child pages in navigation
      - freeze_position_on_failed_trade
    - generic_position
      Toggle child pages in navigation
      - GenericPosition
    - identifier
      Toggle child pages in navigation
    - interest
      Toggle child pages in navigation
      - Interest
    - interest_distribution
      Toggle child pages in navigation
    - loan
      Toggle child pages in navigation
      - Loan
      - LoanSide
    - other_data
      Toggle child pages in navigation
      - OtherData
    - pickle_over_json
      Toggle child pages in navigation
      - decode_pickle_over_json
      - encode_pickle_over_json
    - portfolio
      Toggle child pages in navigation
      - Portfolio
    - position
      Toggle child pages in navigation
      - TradingPosition
      - TriggerPriceUpdate
    - repair
      Toggle child pages in navigation
    - reserve
      Toggle child pages in navigation
      - ReservePosition
    - retry
      Toggle child pages in navigation
      - rebroadcast_trade
      - retry_trades
    - revaluation
      Toggle child pages in navigation
      - RevalueEvent
    - size_risk
      Toggle child pages in navigation
      - SizeRisk
      - SizingType
    - state
      Toggle child pages in navigation
      - BacktestData
      - State
    - statistics
      Toggle child pages in navigation
    - store
      Toggle child pages in navigation
    - sync
      Toggle child pages in navigation
    - trade
      Toggle child pages in navigation
    - trigger
      Toggle child pages in navigation
    - types
    - uptime
      Toggle child pages in navigation
      - Uptime
    - validator
      Toggle child pages in navigation
    - valuation
      Toggle child pages in navigation
      - ValuationUpdate
    - visualisation
      Toggle child pages in navigation
      - Plot
      - PlotKind
      - PlotLabel
      - PlotShape
      - RecordingTime
      - Visualisation
  - strategy
    Toggle child pages in navigation
    - alpha_model
      Toggle child pages in navigation
    - approval
      Toggle child pages in navigation
    - asset
      Toggle child pages in navigation
    - cycle
      Toggle child pages in navigation
    - default_routing_options
      Toggle child pages in navigation
      - TradeRouting
    - dummy
      Toggle child pages in navigation
      - DummyExecutionModel
    - dust
      Toggle child pages in navigation
    - engine_version
    - execution_context
      Toggle child pages in navigation
      - ExecutionContext
      - ExecutionMode
    - execution_model
      Toggle child pages in navigation
    - fixed_size_risk
      Toggle child pages in navigation
      - FixedSizeRiskModel
    - lending_protocol_leverage
      Toggle child pages in navigation
    - output
      Toggle child pages in navigation
    - pandas_trader
      Toggle child pages in navigation
      - alternative_market_data
        Toggle child pages in navigation
        
        get_resample_frequency
        
        load_candle_universe_from_dataframe
        
        load_candle_universe_from_parquet
        
        load_candles_from_dataframe
        
        load_candles_from_parquet
        
        replace_candles
        
        resample_multi_pair
        
        resample_single_pair
      - decision_trigger
        Toggle child pages in navigation
        
        UpdatedUniverseResult
        
        fetch_availability
        
        fetch_lending_data
        
        fetch_price_data
        
        update_universe
        
        validate_latest_candles
        
        wait_for_universe_data_availability_jsonl
      - indicator
        Toggle child pages in navigation
        
        CreateIndicatorsProtocolV1
        
        CreateIndicatorsProtocolV2
        
        DiskIndicatorStorage
        
        IndicatorDefinition
        
        IndicatorDependencyResolver
        
        IndicatorKey
        
        IndicatorResult
        
        IndicatorSet
        
        IndicatorSource
        
        IndicatorStorage
        
        MemoryIndicatorStorage
        
        calculate_and_load_indicators
        
        calculate_and_load_indicators_inline
        
        calculate_indicators
        
        call_create_indicators
        
        group_indicators
        
        load_indicators
        
        prepare_indicators
        
        setup_indicator_multiprocessing
        
        validate_function_kwargs
        
        warm_up_indicator_cache
        
        wrap_nones
      - indicator_decorator
        Toggle child pages in navigation
        
        IndicatorDecoration
        
        IndicatorRegistry
        
        detect_source
        
        extract_args
      - position_manager
        Toggle child pages in navigation
        
        PositionManager
        
        explain_open_position_failure
        
        explain_portfolio_contents
      - rebalance
        Toggle child pages in navigation
        
        get_existing_portfolio_weights
        
        get_weight_diffs
        
        rebalance_portfolio_old
      - strategy_input
        Toggle child pages in navigation
        
        StrategyInput
        
        StrategyInputIndicators
      - token_mapper
        Toggle child pages in navigation
        
        TokenTuple
        
        create_trading_universe_for_tokens
        
        find_best_pairs_for_tokens
    - parameters
      Toggle child pages in navigation
    - pricing_model
      Toggle child pages in navigation
    - qstrader
      Toggle child pages in navigation
      - alpha_model
        Toggle child pages in navigation
        
        AlphaModel
      - order_sizer
        Toggle child pages in navigation
        
        CashBufferedOrderSizer
      - portfolio_construction_model
        Toggle child pages in navigation
        
        PortfolioConstructionModel
    - reserve_currency
      Toggle child pages in navigation
      - ReserveCurrency
    - reverse_universe
      Toggle child pages in navigation
    - routing
      Toggle child pages in navigation
      - RoutingModel
      - RoutingState
    - size_risk_model
      Toggle child pages in navigation
      - SizeRiskModel
    - stop_loss
      Toggle child pages in navigation
    - strategy_cycle_trigger
      Toggle child pages in navigation
      - StrategyCycleTrigger
    - strategy_type
      Toggle child pages in navigation
      - StrategyType
    - tag
      Toggle child pages in navigation
      - StrategyTag
    - trade_pricing
      Toggle child pages in navigation
    - trading_strategy_universe
      Toggle child pages in navigation
    - tvl_size_risk
      Toggle child pages in navigation
    - universe_model
      Toggle child pages in navigation
    - valuation
      Toggle child pages in navigation
    - weighting
      Toggle child pages in navigation
  - analysis
    Toggle child pages in navigation
    - advanced_metrics
      Toggle child pages in navigation
    - alpha_model_analyser
      Toggle child pages in navigation
    - curve
      Toggle child pages in navigation
      - CurveType
    - fee_analyser
      Toggle child pages in navigation
      - analyse_trading_fees
      - create_pair_trading_fee_summary_table
    - multi_asset_benchmark
      Toggle child pages in navigation
    - multipair
      Toggle child pages in navigation
    - position
      Toggle child pages in navigation
    - regime
      Toggle child pages in navigation
    - returns
      Toggle child pages in navigation
      - calculate_returns
    - single_pair
      Toggle child pages in navigation
      - expand_entries_and_exits
    - slippage
      Toggle child pages in navigation
      - display_slippage
    - stop_loss
      Toggle child pages in navigation
      - analyse_stop_losses
      - analyse_trigger_updates
    - timemap
      Toggle child pages in navigation
      - ScoringMethod
      - visualise_weekly_time_heatmap
    - trade_analyser
      Toggle child pages in navigation
    - universe
      Toggle child pages in navigation
      - analyse_long_short_universe
    - weights
      Toggle child pages in navigation
  - visual
    Toggle child pages in navigation
    - asset_correlation
      Toggle child pages in navigation
      - visualise_asset_correlation
    - benchmark
      Toggle child pages in navigation
    - bullbear
      Toggle child pages in navigation
      - visualise_market_regime_filter
      - visualise_raw_market_regime_indicator
    - custom_indicators
      Toggle child pages in navigation
      - calculate_on_balance_volume
    - equity_curve
      Toggle child pages in navigation
    - image_output
      Toggle child pages in navigation
    - multiple_pairs
      Toggle child pages in navigation
    - qs_wrapper
      Toggle child pages in navigation
      - import_quantstats_wrapped
    - single_pair
      Toggle child pages in navigation
    - strategy_state
      Toggle child pages in navigation
    - technical_indicator
      Toggle child pages in navigation
    - utils
      Toggle child pages in navigation
    - web_chart
      Toggle child pages in navigation
  - backtest
    Toggle child pages in navigation
    - backtest_routing
      Toggle child pages in navigation
    - notebook
    - simulated_wallet
      Toggle child pages in navigation
      - SimulatedWallet
    - tearsheet
      Toggle child pages in navigation
      - BacktestReporter
      - export_backtest_report
  - ethereum
    Toggle child pages in navigation
    - aave_v3
      Toggle child pages in navigation
      - analysis
        Toggle child pages in navigation
        
        analyse_credit_trade_by_receipt
    - enzyme
      Toggle child pages in navigation
      - asset
        Toggle child pages in navigation
        
        EnzymeAsset
        
        EnzymeAssetType
        
        load_enzyme_asset_list
      - tx
        Toggle child pages in navigation
        
        EnzymeTransactionBuilder
    - eth_pricing_model
      Toggle child pages in navigation
      - EthereumPricingModel
    - eth_valuation
      Toggle child pages in navigation
      - EthereumPoolRevaluator
    - ethereum_protocol_adapters
      Toggle child pages in navigation
    - ethereumtrader
      Toggle child pages in navigation
    - execution
      Toggle child pages in navigation
    - one_delta
      Toggle child pages in navigation
      - analysis
        Toggle child pages in navigation
        
        analyse_credit_trade_by_receipt
        
        analyse_leverage_trade_by_receipt
        
        analyse_one_delta_trade
        
        decode_path
      - one_delta_execution
        Toggle child pages in navigation
        
        OneDeltaExecution
    - rebroadcast
      Toggle child pages in navigation
      - rebroadcast_all
    - revert
      Toggle child pages in navigation
      - clean_revert_reason_message
    - routing_data
      Toggle child pages in navigation
    - routing_model
      Toggle child pages in navigation
      - EthereumRoutingModel
    - routing_state
      Toggle child pages in navigation
    - swap
      Toggle child pages in navigation
    - token
      Toggle child pages in navigation
    - tvl
      Toggle child pages in navigation
    - tx
      Toggle child pages in navigation
      - HotWalletTransactionBuilder
      - TransactionBuilder
    - uniswap_v2
      Toggle child pages in navigation
      - uniswap_v2_execution
        Toggle child pages in navigation
        
        UniswapV2Execution
        
        get_current_price
      - uniswap_v2_execution_v0
        Toggle child pages in navigation
        
        UniswapV2ExecutionModelVersion0
        
        UniswapV2RoutingInstructions
        
        broadcast_and_resolve
        
        resolve_trades
      - uniswap_v2_live_pricing
        Toggle child pages in navigation
        
        UniswapV2LivePricing
        
        uniswap_v2_live_pricing_factory
      - uniswap_v2_routing
        Toggle child pages in navigation
        
        UniswapV2Routing
        
        UniswapV2RoutingState
        
        get_uniswap_for_pair
      - uniswap_v2_valuation
        Toggle child pages in navigation
        
        UniswapV2PoolRevaluator
        
        uniswap_v2_sell_valuation_factory
      - uniswap_v2_valuation_v0
        Toggle child pages in navigation
        
        UniswapV2PoolValuationMethodV0
        
        uniswap_v2_sell_valuation_factory
    - uniswap_v3
      Toggle child pages in navigation
      - uniswap_v3_execution
        Toggle child pages in navigation
        
        UniswapV3Execution
        
        get_current_price
      - uniswap_v3_live_pricing
        Toggle child pages in navigation
        
        UniswapV3LivePricing
        
        uniswap_v3_live_pricing_factory
      - uniswap_v3_routing
        Toggle child pages in navigation
        
        UniswapV3Routing
        
        UniswapV3RoutingState
        
        get_uniswap_for_pair
      - uniswap_v3_valuation
        Toggle child pages in navigation
        
        UniswapV3PoolRevaluator
        
        uniswap_v3_sell_valuation_factory
    - universe
      Toggle child pages in navigation
      - create_exchange_universe
      - create_pair_universe
    - web3config
      Toggle child pages in navigation
      - Web3Config
  - cli
    Toggle child pages in navigation
    - approval
      Toggle child pages in navigation
      - CLIApprovalModel
    - commands
      Toggle child pages in navigation
      - pair_mapping
        Toggle child pages in navigation
        
        construct_identifier_from_pair
        
        parse_pair_data
      - shared_options
        Toggle child pages in navigation
        
        parse_comma_separated_list
        
        required_option
    - discord
      Toggle child pages in navigation
      - get_discord_logging_handler
      - post_logging_discord_image
    - guard
      Toggle child pages in navigation
      - generate_whitelist
      - get_enzyme_deployment
    - latest_release
      Toggle child pages in navigation
      - main
    - log
      Toggle child pages in navigation
    - version_info
      Toggle child pages in navigation
      - VersionInfo
    - watchdog
      Toggle child pages in navigation
  - utils
    Toggle child pages in navigation
    - accuracy
      Toggle child pages in navigation
    - binance
      Toggle child pages in navigation
      - create_binance_universe
      - fetch_binance_dataset
    - blockchain
      Toggle child pages in navigation
      - get_block_timestamp
      - get_latest_block_timestamp
    - cpu
      Toggle child pages in navigation
      - get_safe_max_workers_count
    - crossover
      Toggle child pages in navigation
      - contains_cross_over
      - contains_cross_under
    - dataclass
      Toggle child pages in navigation
      - EthereumAddress
      - UTCFriendlyDataClassJsonMixin
    - dedent
      Toggle child pages in navigation
      - dedent_any
      - strip_except_newlines
    - default_strategies
      Toggle child pages in navigation
      - get_default_strategies_path
    - format
      Toggle child pages in navigation
      - calculate_percentage
    - fullname
      Toggle child pages in navigation
      - get_object_full_name
    - increasing
      Toggle child pages in navigation
      - is_monotonically_decreasing
      - is_monotonically_increasing
    - jupyter_notebook_folder
      Toggle child pages in navigation
      - get_strategies_folder
    - jupyter_notebook_name
      Toggle child pages in navigation
      - get_notebook_name
      - path
    - leverage_calculations
      Toggle child pages in navigation
    - list
      Toggle child pages in navigation
      - get_linearly_sampled_items
    - notebook
      Toggle child pages in navigation
      - OutputMode
      - setup_charting_and_output
    - price
      Toggle child pages in navigation
      - is_legit_price_value
    - profile
      Toggle child pages in navigation
      - profiled
    - python_function
      Toggle child pages in navigation
      - hash_function
    - python_module_loader
      Toggle child pages in navigation
      - extract_module_members
      - import_python_source_file
    - ring_buffer_logging_handler
      Toggle child pages in navigation
      - ExportedRecord
      - RingBufferHandler
    - slippage
      Toggle child pages in navigation
      - get_slippage_in_bps
    - sort
      Toggle child pages in navigation
      - unique_sort
    - state_downloader
      Toggle child pages in navigation
      - download_state
    - summarydataframe
      Toggle child pages in navigation
      - Format
      - Value
      - as_bars
      - as_decimal
      - as_dollar
      - as_duration
      - as_integer
      - as_missing
      - as_percent
      - create_summary_table
      - format_value
      - format_values
    - timer
      Toggle child pages in navigation
      - timed_task
    - timestamp
      Toggle child pages in navigation
    - token
    - typing
    - url
      Toggle child pages in navigation
      - get_url_domain
      - redact_url_password
  - webhook
    Toggle child pages in navigation
    - error
      Toggle child pages in navigation
    - events
      Toggle child pages in navigation
      - add_cors_headers
    - http_log
      Toggle child pages in navigation
      - configure_http_request_logging
      - log_tween_factory
  - testing
    Toggle child pages in navigation
    - ethereumtrader_uniswap_v2
      Toggle child pages in navigation
      - UniswapV2TestTrader
    - ethereumtrader_uniswap_v3
      Toggle child pages in navigation
      - UniswapV3TestTrader
    - pairuniversetrader
      Toggle child pages in navigation
      - PairUniverseTestTrader
    - pytest_helpers
      Toggle child pages in navigation
      - is_failed_test
    - simulated_trader
      Toggle child pages in navigation
      - SimulatedTestTrader
    - synthetic_ethereum_data
      Toggle child pages in navigation
      - generate_random_ethereum_address
    - synthetic_exchange_data
      Toggle child pages in navigation
      - generate_exchange
      - generate_simple_routing_model
    - synthetic_lending_data
      Toggle child pages in navigation
      - generate_lending_reserve
      - generate_lending_universe
    - synthetic_pair_data
      Toggle child pages in navigation
      - generate_pair
    - synthetic_price_data
      Toggle child pages in navigation
    - synthetic_universe_data
      Toggle child pages in navigation
      - create_synthetic_single_pair_universe
    - unit_test_trader
      Toggle child pages in navigation
      - UnitTestTrader
  - monkeypatch
    Toggle child pages in navigation
    - cloudpickle_patch
      Toggle child pages in navigation
      - reducer_override
    - dataclasses_json
      Toggle child pages in navigation
      - patch_dataclasses_json
    - web3
      Toggle child pages in navigation
      - construct_sign_and_send_raw_middleware
- Technical analysis
  Toggle child pages in navigation
  - Statistics
    Toggle child pages in navigation
    - entropy
    - kurtosis
    - mad
    - median
    - skew
    - stdev
    - tos_stdevall
    - variance
    - zscore
  - Overlap and moving averages
    Toggle child pages in navigation
    - alma
    - dema
    - ema
    - fwma
    - hilo
    - hl2
    - hlc3
    - hma
    - hwma
    - ichimoku
    - jma
    - kama
    - linreg
    - ma
    - mcgd
    - midpoint
    - midprice
    - ohlc4
    - pwma
    - rma
    - sinwma
    - sma
    - ssf
    - supertrend
    - swma
    - t3
    - tema
    - trima
    - vidya
    - vwap
    - vwma
    - wcp
    - wma
    - zlma
  - Trend indicators
    Toggle child pages in navigation
    - adx
    - amat
    - aroon
    - chop
    - cksp
    - decay
    - decreasing
    - dpo
    - increasing
    - long_run
    - psar
    - qstick
    - short_run
    - tsignals
    - ttm_trend
    - vhf
    - vortex
    - xsignals
  - Momentum indicators
    Toggle child pages in navigation
    - ao
    - apo
    - bias
    - bop
    - brar
    - cci
    - cfo
    - cg
    - cmo
    - coppock
    - cti
    - dm
    - er
    - eri
    - fisher
    - inertia
    - kdj
    - kst
    - macd
    - mom
    - pgo
    - ppo
    - psl
    - pvo
    - qqe
    - roc
    - rsi
    - rsx
    - rvgi
    - slope
    - smi
    - squeeze
    - squeeze_pro
    - stc
    - stoch
    - stochrsi
    - td_seq
    - trix
    - tsi
    - uo
    - willr
  - Volatility indicators
    Toggle child pages in navigation
    - aberration
    - accbands
    - atr
    - bbands
    - donchian
    - hwc
    - kc
    - massi
    - natr
    - pdist
    - rvi
    - thermo
    - true_range
    - ui
  - Volume based indicators
    Toggle child pages in navigation
    - ad
    - adosc
    - aobv
    - cmf
    - efi
    - eom
    - kvo
    - mfi
    - nvi
    - obv
    - pvi
    - pvol
    - pvr
    - pvt
    - vp
  - Candle pattern indicators
    Toggle child pages in navigation
    - cdl_doji
    - cdl_inside
    - cdl_pattern
    - cdl_z
    - ha
  - Market cycles
    Toggle child pages in navigation
    - ebsw
  - Portfolio performance
    Toggle child pages in navigation
- Web3 Ethereum DeFi

Toggle table of contents sidebar

Tags overview#

Trading Strategy is in beta and still under development. Any documentation is preliminary and not final.