freqtrade

(★ 53,491)

Free, open source crypto trading bot

File Explorer

Download Latest Version (.zip)

- devcontainer.json
- - devcontainer.json
  - Dockerfile
- - bug_report.md
  - config.yml
  - feature_request.md
  - question.md
- - binance-lev-tier-update.yml
  - ci.yml
  - deploy-docs.yml
  - devcontainer-build.yml
  - docker-build.yml
  - docker-update-readme.yml
  - packages-cleanup.yml
  - pre-commit-types-update.yml
  - pre-commit-update.yml
  - zizmor_action.yml
- dependabot.yml
- FUNDING.yml
- PULL_REQUEST_TEMPLATE.md
- extensions.json
- binance_update_lev_tiers.py
- create_command_partials.py
- extract_config_json_schema.py
- freqtrade_client_version_align.py
- pre_commit_update.py
- pyarrow-25.0.1-cp311-cp311-linux_armv7l.whl
- schema.json
- ta_lib-0.6.8-cp313-cp313-manylinux_2_31_armv7l.whl
- ta_lib-0.7.1-cp311-cp311-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl
- config_binance.example.json
- config_freqai.example.json
- config_full.example.json
- config_kraken.example.json
- docker-compose-freqai.yml
- docker-compose-jupyter.yml
- Dockerfile.armhf
- Dockerfile.custom
- Dockerfile.freqai
- Dockerfile.freqai_rl
- Dockerfile.jupyter
- Dockerfile.plot
- - binance_futures_settings.png
  - ccxt-logo.svg
  - discord_notification.png
  - freqai_algo.jpg
  - freqai_algorithm-diagram.jpg
  - freqai_dbscan.jpg
  - freqai_DI.jpg
  - freqai_doc_logo.svg
  - freqai_inlier-metric.jpg
  - freqai_moving-window.jpg
  - freqai_pytorch-diagram.png
  - freqai_weight-factor.jpg
  - freqtrade-screenshot.png
  - freqtrade_poweredby.svg
  - freqUI-backtesting-dark.png
  - freqUI-backtesting-light.png
  - freqUI-chart-annotations-dark.png
  - freqUI-chart-annotations-light.png
  - frequi-login-CORS-light.png
  - frequi-login-CORS.png
  - freqUI-plot-configurator-dark.png
  - freqUI-plot-configurator-light.png
  - frequi-settings-dark.png
  - frequi-settings-light.png
  - freqUI-trade-pane-dark.png
  - freqUI-trade-pane-light.png
  - freqUI-trade-pane.png
  - frequi_url.png
  - plot-dataframe.png
  - plot-dataframe2.png
  - plot-profit.png
  - pycharm_debug.png
  - show-config-output.png
  - telegram_forcebuy.png
  - tensorboard.jpg
  - windows_install.png
- - backtesting-analysis.md
  - backtesting-show.md
  - backtesting.md
  - convert-data.md
  - convert-db.md
  - convert-trade-data.md
  - create-userdir.md
  - download-data.md
  - edge.md
  - freqtrade-client.md
  - hyperopt-list.md
  - hyperopt-show.md
  - hyperopt.md
  - install-ui.md
  - list-data.md
  - list-exchanges.md
  - list-freqaimodels.md
  - list-hyperoptloss.md
  - list-markets.md
  - list-pairs.md
  - list-strategies.md
  - list-timeframes.md
  - lookahead-analysis.md
  - main.md
  - new-config.md
  - new-strategy.md
  - plot-dataframe.md
  - plot-profit.md
  - recursive-analysis.md
  - show-config.md
  - show-trades.md
  - strategy-updater.md
  - test-pairlist.md
  - trade.md
  - trades-to-ohlcv.md
  - webserver.md
- - logo.png
- - cors.md
  - exchange-features.md
  - pairlists.md
  - pricing.md
  - protections.md
  - release_template.md
  - showcase.md
  - strategy-exit-comparisons.md
  - strategy-imports.md
- - config.js
- - main.html
- - ft.extra.css
- advanced-backtesting.md
- advanced-hyperopt.md
- advanced-orderflow.md
- advanced-setup.md
- backtesting.md
- bot-basics.md
- bot-usage.md
- configuration.md
- data-analysis.md
- data-download.md
- deprecated.md
- developer.md
- docker_quickstart.md
- exchanges.md
- faq.md
- freq-ui.md
- freqai-configuration.md
- freqai-developers.md
- freqai-feature-engineering.md
- freqai-parameter-table.md
- freqai-reinforcement-learning.md
- freqai-running.md
- freqai.md
- hyperopt.md
- index.md
- installation.md
- leverage.md
- lookahead-analysis.md
- plotting.md
- plugins.md
- producer-consumer.md
- recursive-analysis.md
- requirements-docs.txt
- rest-api.md
- sql_cheatsheet.md
- stoploss.md
- strategy-101.md
- strategy-advanced.md
- strategy-callbacks.md
- strategy-customization.md
- strategy_analysis_example.md
- strategy_migration.md
- telegram-usage.md
- trade-object.md
- updating.md
- utils.md
- webhook-config.md
- - __init__.py
  - analyze_commands.py
  - arguments.py
  - build_config_commands.py
  - cli_options.py
  - data_commands.py
  - db_commands.py
  - deploy_commands.py
  - deploy_ui.py
  - hyperopt_commands.py
  - list_commands.py
  - optimize_commands.py
  - pairlist_commands.py
  - plot_commands.py
  - strategy_utils_commands.py
  - trade_commands.py
  - webserver_commands.py
- - __init__.py
  - config_schema.py
- - __init__.py
  - config_secrets.py
  - config_setup.py
  - config_validation.py
  - configuration.py
  - deploy_config.py
  - deprecated_settings.py
  - detect_environment.py
  - directory_operations.py
  - environment_vars.py
  - load_config.py
  - timerange.py
- - __init__.py
  - dataprovider.py
  - entryexitanalysis.py
  - metrics.py
- - __init__.py
  - backteststate.py
  - candletype.py
  - exitchecktuple.py
  - exittype.py
  - hyperoptstate.py
  - marginmode.py
  - marketstatetype.py
  - ordertypevalue.py
  - pricetype.py
  - rpcmessagetype.py
  - runmode.py
  - signaltype.py
  - state.py
  - tradingmode.py
- - __init__.py
  - binance.py
  - binance_leverage_tiers.json
  - binance_public_data.py
  - bingx.py
  - bitget.py
  - bitpanda.py
  - bitvavo.py
  - bybit.py
  - check_exchange.py
  - coinex.py
  - common.py
  - cryptocom.py
  - exchange.py
  - exchange_types.py
  - exchange_utils.py
  - exchange_utils_timeframe.py
  - exchange_ws.py
  - gate.py
  - hitbtc.py
  - htx.py
  - hyperliquid.py
  - idex.py
  - kraken.py
  - krakenfutures.py
  - kucoin.py
  - lbank.py
  - luno.py
  - modetrade.py
  - okx.py
- - __init__.py
  - data_drawer.py
  - data_kitchen.py
  - freqai_interface.py
  - utils.py
- - __init__.py
  - backtest_result_type.py
  - plot_annotation_type.py
  - valid_exchanges_type.py
- - __init__.py
  - interest.py
  - liquidation_price.py
- - __init__.py
  - buffering_handler.py
  - ft_rich_handler.py
  - json_formatter.py
  - rich_console.py
  - set_log_levels.py
  - std_err_stream_handler.py
- - __init__.py
  - logging_mixin.py
- - __init__.py
  - backtest_caching.py
  - backtesting.py
  - hyperopt_epoch_filters.py
  - hyperopt_tools.py
- - __init__.py
  - base.py
  - custom_data.py
  - db_migration.py
  - key_value_store.py
  - migrations.py
  - models.py
  - pairlock.py
  - pairlock_middleware.py
  - trade_model.py
  - usedb_context.py
  - wallet_history.py
- - __init__.py
  - plotting.py
- - __init__.py
  - pairlistmanager.py
  - protectionmanager.py
- - __init__.py
  - exchange_resolver.py
  - freqaimodel_resolver.py
  - hyperopt_resolver.py
  - iresolver.py
  - pairlist_resolver.py
  - protection_resolver.py
  - strategy_resolver.py
- - __init__.py
  - discord.py
  - external_message_consumer.py
  - fiat_convert.py
  - rpc.py
  - rpc_manager.py
  - rpc_types.py
  - telegram.py
  - webhook.py
- - __init__.py
  - hyper.py
  - informative_decorator.py
  - interface.py
  - parameters.py
  - strategy_helper.py
  - strategy_validation.py
  - strategy_wrapper.py
  - strategyupdater.py
- - __init__.py
  - asyncio_config.py
  - gc_setup.py
  - set_mp_start_method.py
  - version_info.py
- - __init__.py
  - base_config.json.j2
  - base_strategy.py.j2
  - FreqaiExampleHybridStrategy.py
  - FreqaiExampleStrategy.py
  - sample_hyperopt_loss.py
  - sample_strategy.py
  - strategy_analysis_example.ipynb
- - __init__.py
  - coin_gecko.py
  - datetime_helpers.py
  - dry_run_wallet.py
  - formatters.py
  - ft_precise.py
  - ft_ttlcache.py
  - measure_time.py
  - periodic_cache.py
  - progress_tracker.py
  - rich_progress.py
  - rich_tables.py
  - singleton.py
  - template_renderer.py
- - __init__.py
- __init__.py
- __main__.py
- constants.py
- exceptions.py
- freqtradebot.py
- main.py
- misc.py
- wallets.py
- worker.py
- - __init__.py
  - ft_client.py
  - ft_rest_client.py
- - __init__.py
  - test_rest_client.py
- LICENSE
- MANIFEST.in
- pyproject.toml
- README.md
- requirements.txt
- rest_client.py
- ws_client.py
- - __init__.py
  - test_build_config.py
  - test_commands.py
  - test_startup_time.py
- - __init__.py
  - test_btanalysis.py
  - test_converter.py
  - test_converter_orderflow.py
  - test_datahandler.py
  - test_dataprovider.py
  - test_download_data.py
  - test_entryexitanalysis.py
  - test_historic_precision.py
  - test_history.py
  - test_metrics.py
  - test_trade_converter_kraken.py
  - test_trade_parallelism.py
- - __init__.py
  - test_binance.py
  - test_binance_public_data.py
  - test_bitget.py
  - test_bitpanda.py
  - test_bybit.py
  - test_exchange.py
  - test_exchange_utils.py
  - test_exchange_ws.py
  - test_gate.py
  - test_htx.py
  - test_hyperliquid.py
  - test_kraken.py
  - test_krakenfutures.py
  - test_kucoin.py
  - test_okx.py
- - __init__.py
  - conftest.py
  - test_ccxt_compat.py
  - test_ccxt_ws_compat.py
- - conftest.py
  - test_freqai_backtesting.py
  - test_freqai_datadrawer.py
  - test_freqai_datakitchen.py
  - test_freqai_interface.py
- - __init__.py
  - test_freqtradebot.py
  - test_integration.py
  - test_stoploss_on_exchange.py
  - test_worker.py
- - test_candletype.py
  - test_interest.py
  - test_update_liquidation_price.py
- - __init__.py
  - conftest.py
  - test_backtest_detail.py
  - test_backtesting.py
  - test_backtesting_adjust_position.py
  - test_hyperopt.py
  - test_hyperopt_tools.py
  - test_hyperoptloss.py
  - test_lookahead_analysis.py
  - test_optimize_reports.py
  - test_recursive_analysis.py
- - __init__.py
  - test_db_context.py
  - test_db_migration.py
  - test_key_value_store.py
  - test_migrations.py
  - test_persistence.py
  - test_trade_custom_data.py
  - test_trade_fromjson.py
- - __init__.py
  - test_pairinformationfilter.py
  - test_pairlist.py
  - test_pairlocks.py
  - test_percentchangepairlist.py
  - test_protections.py
  - test_remotepairlist.py
- - __init__.py
  - test_fiat_convert.py
  - test_rpc.py
  - test_rpc_apiserver.py
  - test_rpc_emc.py
  - test_rpc_manager.py
  - test_rpc_telegram.py
  - test_rpc_webhook.py
- - __init__.py
  - test_default_strategy.py
  - test_interface.py
  - test_strategy_helpers.py
  - test_strategy_loading.py
  - test_strategy_parameters.py
  - test_strategy_safe_wrapper.py
- - ADA_BTC-5m.feather
  - BTC_USDT-5m.feather
  - config.tests.json
  - config.tests.usdt.json
  - DASH_BTC-5m.feather
  - ETC_BTC-5m.feather
  - ETH_BTC-5m.feather
  - hyperopt_results_SampleStrategy.pickle
  - LTC_BTC-5m.feather
  - NOPAIR_XXX-4m.json
  - NXT_BTC-5m.feather
  - pairs.json
  - strategy_SampleStrategy.fthypt
  - TRX_BTC-5m.feather
  - UNITTEST_BTC-1m.feather
  - UNITTEST_BTC-1m.json
  - UNITTEST_BTC-30m.feather
  - UNITTEST_BTC-5m.feather
  - UNITTEST_BTC-8m.feather
  - UNITTEST_BTC-8m.json.gz
  - XLM_BTC-5m.feather
  - XMR_BTC-5m.feather
  - XRP_ETH-1m.feather
  - XRP_ETH-5m.feather
  - XRP_ETH-trades.feather
  - XRP_ETH-trades.json.gz
  - XRP_ETH-trades.parquet
  - XRP_OLD-trades.json.gz
  - XRP_USDT-5m.feather
  - ZEC_BTC-5m.feather
- - test_ccxt_precise.py
  - test_datetime_helpers.py
  - test_formatters.py
  - test_funding_rate_migration.py
  - test_historic_wallets_migration.py
  - test_measure_time.py
  - test_periodiccache.py
  - test_rendering_utils.py
  - test_wallet_util.py
- __init__.py
- config_test_comments.json
- conftest.py
- conftest_hyperopt.py
- conftest_trades.py
- conftest_trades_usdt.py
- pytest.sh
- setup.Tests.ps1
- test_arguments.py
- test_configuration.py
- test_directory_operations.py
- test_docs.sh
- test_indicators.py
- test_log_setup.py
- test_main.py
- test_misc.py
- test_pip_audit.py
- test_plotting.py
- test_strategy_updater.py
- test_talib.py
- test_timerange.py
- test_wallets.py
- - .gitkeep
- - .gitkeep
- - .gitkeep
- - .gitkeep
- - .gitkeep
- - .gitkeep
.coveragerc
.dockerignore
.gitattributes
.gitignore
.pre-commit-config.yaml
.pylintrc
.readthedocs.yml
CONTRIBUTING.md
docker-compose.yml
Dockerfile
freqtrade.service
freqtrade.service.watchdog
LICENSE
MANIFEST.in
mkdocs.yml
pyproject.toml
README.md
requirements-dev.txt
requirements-freqai-rl.txt
requirements-freqai.txt
requirements-hyperopt.txt
requirements-plot.txt
requirements.txt
setup.ps1
setup.sh

# Installation Guide

1. Get the code

git clone https://github.com/freqtrade/freqtrade

Downloads the entire project code from GitHub to your computer.

cd freqtrade

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r ft_client/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

jupyter notebook

Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

freqtrade

File Explorer

# Installation Guide

2. Docker

3. Python

Today's picks

Was this content helpful?

Recent Feedback

freqtrade

File Explorer

# Installation Guide

2. Docker

3. Python

Today's picks

Was this content helpful?

Recent Feedback

Download README