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
    - flexible_pickle
      Toggle child pages in navigation
    - format
      Toggle child pages in navigation
    - forward_fill
      Toggle child pages in navigation
    - gap
      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
    - 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
    - cache_utils
      Toggle child pages in navigation
      - wait_other_writers
    - data_trigger
      Toggle child pages in navigation
      - wait_for_data
    - jsonl
      Toggle child pages in navigation
    - pair_candle_cache
      Toggle child pages in navigation
    - progress_enabled_download
      Toggle child pages in navigation
      - download_with_tqdm_progress_bar
    - pyodide
    - token_cache
      Toggle child pages in navigation
  - 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
  - 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
    Toggle child pages in navigation
    - coingecko
      Toggle child pages in navigation
    - vault
      Toggle child pages in navigation
  - qstrader
    Toggle child pages in navigation
  - direct_feed
    Toggle child pages in navigation
    - conversion
      Toggle child pages in navigation
      - CurrencyConversion
      - convert_to_float
    - dash
    - direct_feed_pair
    - ohlcv_aggregate
      Toggle child pages in navigation
    - timeframe
      Toggle child pages in navigation
      - Timeframe
    - trade_store
      Toggle child pages in navigation
      - ParquetFileStore
      - TradeFeedStore
    - warn
      Toggle child pages in navigation
      - disable_pandas_warnings
- Trade execution engine
  Toggle child pages in navigation
  - state
    Toggle child pages in navigation
    - other_data
      Toggle child pages in navigation
      - OtherData
    - pickle_over_json
      Toggle child pages in navigation
      - decode_pickle_over_json
      - encode_pickle_over_json
    - position_internal_share_price
      Toggle child pages in navigation
      - PositionInternalSharePriceState
    - revaluation
      Toggle child pages in navigation
      - RevalueEvent
    - trigger
      Toggle child pages in navigation
    - types
    - valuation
      Toggle child pages in navigation
      - ValuationUpdate
  - strategy
    Toggle child pages in navigation
    - chart
      Toggle child pages in navigation
      - standard
    - default_routing_options
      Toggle child pages in navigation
      - TradeRouting
    - engine_version
    - freqtrade
      Toggle child pages in navigation
      - config
        Toggle child pages in navigation
        
        AsterExchangeConfig
        
        FreqtradeConfig
        
        FreqtradeDepositMethod
        
        FreqtradeWithdrawalMethod
        
        HyperliquidExchangeConfig
        
        OnChainTransferExchangeConfig
        
        OrderlyExchangeConfig
      - freqtrade_client
        Toggle child pages in navigation
        
        FreqtradeClient
    - pandas_trader
    - qstrader
    - reserve_currency
      Toggle child pages in navigation
      - ReserveCurrency
    - strategy_cycle_trigger
      Toggle child pages in navigation
      - StrategyCycleTrigger
    - strategy_type
      Toggle child pages in navigation
      - StrategyType
    - tag
      Toggle child pages in navigation
      - StrategyTag
    - weighting
      Toggle child pages in navigation
  - analysis
    Toggle child pages in navigation
    - curve
      Toggle child pages in navigation
      - CurveType
    - grid_search_format
      Toggle child pages in navigation
    - regime
      Toggle child pages in navigation
  - visual
    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
    - image_output
      Toggle child pages in navigation
    - palette
      Toggle child pages in navigation
    - qs_wrapper
      Toggle child pages in navigation
      - import_quantstats_wrapped
  - backtest
    Toggle child pages in navigation
    - notebook
  - ethereum
    Toggle child pages in navigation
    - aave_v3
    - cctp
    - cowswap
    - enzyme
    - one_delta
    - revert
      Toggle child pages in navigation
      - clean_revert_reason_message
    - uniswap_v2
    - uniswap_v3
    - vault
  - cli
    Toggle child pages in navigation
    - 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
        
        PositionType
        
        TradeType
        
        parse_comma_separated_list
        
        required_option
    - discord
      Toggle child pages in navigation
      - get_discord_logging_handler
      - post_logging_discord_image
    - 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
    - cpu
      Toggle child pages in navigation
      - get_safe_max_workers_count
      - is_running_in_ipython
    - 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
    - hex
      Toggle child pages in navigation
      - hexbytes_to_hex_str
    - 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
    - list
      Toggle child pages in navigation
      - get_linearly_sampled_items
    - notebook
      Toggle child pages in navigation
    - 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
    - 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
    - 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
    - json_helper
      Toggle child pages in navigation
      - NaNToNullEncoder
  - testing
    Toggle child pages in navigation
    - pytest_helpers
      Toggle child pages in navigation
      - is_failed_test
    - synthetic_ethereum_data
      Toggle child pages in navigation
      - generate_random_ethereum_address
  - monkeypatch
    Toggle child pages in navigation
    - cloudpickle_patch
      Toggle child pages in navigation
      - reducer_override
    - plotly
      Toggle child pages in navigation
      - fix_trace_x_axis_dates
    - quantstats
- 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

vault#

API documentation for tradeexecutor.ethereum.vault Python module in Trading Strategy.

Module description#

Submodules#

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

Contents

vault
- Module description
- Submodules