mirror of
https://github.com/freqtrade/freqtrade.git
synced 2025-12-02 10:03:05 +00:00
3223 lines
114 KiB
HTML
3223 lines
114 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<meta name="description" content="Freqtrade is a free and open source crypto trading bot written in Python, designed to support all major exchanges and be controlled via Telegram or builtin Web UI">
|
|
|
|
|
|
|
|
<link rel="canonical" href="https://www.freqtrade.io/en/stable/utils/">
|
|
|
|
|
|
<link rel="prev" href="../leverage/">
|
|
|
|
|
|
<link rel="next" href="../plotting/">
|
|
|
|
|
|
<link rel="icon" href="../images/logo.png">
|
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.22">
|
|
|
|
|
|
|
|
<title>Utility Sub-commands - Freqtrade</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
|
|
|
|
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-VH170LG9M5"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-VH170LG9M5",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-VH170LG9M5",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
|
|
|
|
<script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="tear">
|
|
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#utility-subcommands" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<header class="md-header md-header--shadow" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href=".." title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
|
|
|
|
<img src="../images/logo.png" alt="logo">
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
Freqtrade
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
Utility Sub-commands
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<form class="md-header__option" data-md-component="palette">
|
|
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="tear" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6m0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4M7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3"/></svg>
|
|
</label>
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="tear" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3"/></svg>
|
|
</label>
|
|
|
|
|
|
</form>
|
|
|
|
|
|
|
|
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-header__button md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
</label>
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
|
</label>
|
|
<nav class="md-search__options" aria-label="Search">
|
|
|
|
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
|
|
</a>
|
|
|
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
|
</button>
|
|
</nav>
|
|
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list" role="presentation"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-header__source">
|
|
<a href="https://github.com/freqtrade/freqtrade" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
GitHub
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
<!-- Main navigation -->
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href=".." title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
|
|
|
|
<img src="../images/logo.png" alt="logo">
|
|
|
|
</a>
|
|
Freqtrade
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
<a href="https://github.com/freqtrade/freqtrade" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
GitHub
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href=".." class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Home
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../docker_quickstart/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Quickstart with Docker
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Installation
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Installation
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../installation/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Linux/MacOS/Raspberry
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../windows_installation/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Windows
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../bot-basics/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Freqtrade Basics
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../configuration/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Configuration
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../strategy-101/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Strategy Quickstart
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../strategy-customization/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Strategy Customization
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../strategy-callbacks/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Strategy Callbacks
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../stoploss/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Stoploss
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../plugins/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Plugins
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../bot-usage/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Start the bot
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_12" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Control the bot
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_12">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Control the bot
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../telegram-usage/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Telegram
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../freq-ui/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
freqUI
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../rest-api/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
REST API
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../webhook-config/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Web Hook
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../data-download/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Data Downloading
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../backtesting/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Backtesting
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../hyperopt/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Hyperopt
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_16" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_16" id="__nav_16_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
FreqAI
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_16_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_16">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
FreqAI
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../freqai/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Introduction
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../freqai-configuration/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Configuration
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../freqai-parameter-table/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Parameter table
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../freqai-feature-engineering/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Feature engineering
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../freqai-running/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Running FreqAI
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Reinforcement Learning
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../freqai-developers/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Developer guide
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../leverage/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Short / Leverage
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Utility Sub-commands
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Utility Sub-commands
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#create-userdir" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Create userdir
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#create-new-config" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Create new config
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Create new config">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#create-config-examples" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Create config examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-config" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Show config
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#create-new-strategy" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Create new strategy
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Create new strategy">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#sample-usage-of-new-strategy" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Sample usage of new-strategy
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-strategies" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List Strategies
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-hyperopt-loss-functions" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List Hyperopt-Loss functions
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-freqai-models" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List freqAI models
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-exchanges" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List Exchanges
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-timeframes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List Timeframes
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-pairslist-markets" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List pairs/list markets
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="List pairs/list markets">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#test-pairlist" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Test pairlist
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Test pairlist">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples_1" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#convert-database" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Convert database
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#webserver-mode" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Webserver mode
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Webserver mode">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#webserver-mode-docker" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Webserver mode - docker
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-previous-backtest-results" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Show previous Backtest results
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#detailed-backtest-analysis" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Detailed backtest analysis
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-hyperopt-results" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List Hyperopt results
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="List Hyperopt results">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples_2" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-details-of-hyperopt-results" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Show details of Hyperopt results
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Show details of Hyperopt results">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples_3" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-trades" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Show trades
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Show trades">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples_4" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#strategy-updater" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Strategy-Updater
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../plotting/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Plotting
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../exchanges/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Exchange-specific Notes
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_21" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_21" id="__nav_21_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Data Analysis
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_21_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_21">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Data Analysis
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../data-analysis/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Jupyter Notebooks
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../strategy_analysis_example/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Strategy analysis
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../advanced-backtesting/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Backtest analysis
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_22" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_22" id="__nav_22_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced Topics
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_22_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_22">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Advanced Topics
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../advanced-setup/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced Post-installation Tasks
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../trade-object/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Trade Object
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../lookahead-analysis/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Lookahead analysis
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../recursive-analysis/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Recursive analysis
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../strategy-advanced/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced Strategy
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../advanced-hyperopt/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced Hyperopt
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../advanced-orderflow/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Orderflow
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../producer-consumer/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Producer/Consumer mode
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../sql_cheatsheet/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
SQL Cheat-sheet
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../faq/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
FAQ
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../strategy_migration/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Strategy migration
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../updating/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Updating Freqtrade
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../deprecated/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Deprecated Features
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../developer/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Contributors Guide
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<!-- Table of contents -->
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#create-userdir" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Create userdir
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#create-new-config" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Create new config
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Create new config">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#create-config-examples" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Create config examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-config" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Show config
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#create-new-strategy" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Create new strategy
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Create new strategy">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#sample-usage-of-new-strategy" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Sample usage of new-strategy
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-strategies" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List Strategies
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-hyperopt-loss-functions" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List Hyperopt-Loss functions
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-freqai-models" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List freqAI models
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-exchanges" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List Exchanges
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-timeframes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List Timeframes
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-pairslist-markets" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List pairs/list markets
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="List pairs/list markets">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#test-pairlist" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Test pairlist
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Test pairlist">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples_1" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#convert-database" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Convert database
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#webserver-mode" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Webserver mode
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Webserver mode">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#webserver-mode-docker" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Webserver mode - docker
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-previous-backtest-results" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Show previous Backtest results
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#detailed-backtest-analysis" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Detailed backtest analysis
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-hyperopt-results" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
List Hyperopt results
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="List Hyperopt results">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples_2" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-details-of-hyperopt-results" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Show details of Hyperopt results
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Show details of Hyperopt results">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples_3" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-trades" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Show trades
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Show trades">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples_4" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#strategy-updater" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Strategy-Updater
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/freqtrade/freqtrade/edit/develop/docs/utils.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<h1 id="utility-subcommands">Utility Subcommands<a class="headerlink" href="#utility-subcommands" title="Permanent link">¶</a></h1>
|
|
<p>Besides the Live-Trade and Dry-Run run modes, the <code>backtesting</code> and <code>hyperopt</code> optimization subcommands, and the <code>download-data</code> subcommand which prepares historical data, the bot contains a number of utility subcommands. They are described in this section.</p>
|
|
<h2 id="create-userdir">Create userdir<a class="headerlink" href="#create-userdir" title="Permanent link">¶</a></h2>
|
|
<p>Creates the directory structure to hold your files for freqtrade.
|
|
Will also create strategy and hyperopt examples for you to get started.
|
|
Can be used multiple times - using <code>--reset</code> will reset the sample strategy and hyperopt files to their default state.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade create-userdir [-h] [--userdir PATH] [--reset]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
<span class="go"> --reset Reset sample files to their original state.</span>
|
|
</code></pre></div>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Warning</p>
|
|
<p>Using <code>--reset</code> may result in loss of data, since this will overwrite all sample files without asking again.</p>
|
|
</div>
|
|
<div class="highlight"><pre><span></span><code>├── backtest_results
|
|
├── data
|
|
├── hyperopt_results
|
|
├── hyperopts
|
|
│ ├── sample_hyperopt_loss.py
|
|
├── notebooks
|
|
│ └── strategy_analysis_example.ipynb
|
|
├── plot
|
|
└── strategies
|
|
└── sample_strategy.py
|
|
</code></pre></div>
|
|
<h2 id="create-new-config">Create new config<a class="headerlink" href="#create-new-config" title="Permanent link">¶</a></h2>
|
|
<p>Creates a new configuration file, asking some questions which are important selections for a configuration.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade new-config [-h] [-c PATH]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever exists).</span>
|
|
<span class="go"> Multiple --config options may be used. Can be set to `-`</span>
|
|
<span class="go"> to read config from stdin.</span>
|
|
</code></pre></div>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Warning</p>
|
|
<p>Only vital questions are asked. Freqtrade offers a lot more configuration possibilities, which are listed in the <a href="../configuration/#configuration-parameters">Configuration documentation</a></p>
|
|
</div>
|
|
<h3 id="create-config-examples">Create config examples<a class="headerlink" href="#create-config-examples" title="Permanent link">¶</a></h3>
|
|
<div class="highlight"><pre><span></span><code>$ freqtrade new-config --config user_data/config_binance.json
|
|
|
|
? Do you want to enable Dry-run (simulated trades)? Yes
|
|
? Please insert your stake currency: BTC
|
|
? Please insert your stake amount: 0.05
|
|
? Please insert max_open_trades (Integer or -1 for unlimited open trades): 3
|
|
? Please insert your desired timeframe (e.g. 5m): 5m
|
|
? Please insert your display Currency (for reporting): USD
|
|
? Select exchange binance
|
|
? Do you want to enable Telegram? No
|
|
</code></pre></div>
|
|
<h2 id="show-config">Show config<a class="headerlink" href="#show-config" title="Permanent link">¶</a></h2>
|
|
<p>Show configuration file (with sensitive values redacted by default).
|
|
Especially useful with <a href="../configuration/#multiple-configuration-files">split configuration files</a> or <a href="../configuration/#environment-variables">environment variables</a>, where this command will show the merged configuration.</p>
|
|
<p><img alt="Show config output" src="../assets/show-config-output.png" /></p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade show-config [-h] [--userdir PATH] [-c PATH]</span>
|
|
<span class="go"> [--show-sensitive]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> --show-sensitive Show secrets in the output.</span>
|
|
</code></pre></div>
|
|
<div class="highlight"><pre><span></span><code><span class="go">Your combined configuration is:</span>
|
|
<span class="go">{</span>
|
|
<span class="go"> "exit_pricing": {</span>
|
|
<span class="go"> "price_side": "other",</span>
|
|
<span class="go"> "use_order_book": true,</span>
|
|
<span class="go"> "order_book_top": 1</span>
|
|
<span class="go"> },</span>
|
|
<span class="go"> "stake_currency": "USDT",</span>
|
|
<span class="go"> "exchange": {</span>
|
|
<span class="go"> "name": "binance",</span>
|
|
<span class="go"> "key": "REDACTED",</span>
|
|
<span class="go"> "secret": "REDACTED",</span>
|
|
<span class="go"> "ccxt_config": {},</span>
|
|
<span class="go"> "ccxt_async_config": {},</span>
|
|
<span class="go"> }</span>
|
|
<span class="go"> // ...</span>
|
|
<span class="go">}</span>
|
|
</code></pre></div>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Sharing information provided by this command</p>
|
|
<p>We try to remove all known sensitive information from the default output (without <code>--show-sensitive</code>).
|
|
Yet, please do double-check for sensitive values in your output to make sure you're not accidentally exposing some private info.</p>
|
|
</div>
|
|
<h2 id="create-new-strategy">Create new strategy<a class="headerlink" href="#create-new-strategy" title="Permanent link">¶</a></h2>
|
|
<p>Creates a new strategy from a template similar to SampleStrategy.
|
|
The file will be named inline with your class name, and will not overwrite existing files.</p>
|
|
<p>Results will be located in <code>user_data/strategies/<strategyclassname>.py</code>.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade new-strategy [-h] [--userdir PATH] [-s NAME]</span>
|
|
<span class="go"> [--strategy-path PATH]</span>
|
|
<span class="go"> [--template {full,minimal,advanced}]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
<span class="go"> -s, --strategy NAME Specify strategy class name which will be used by the</span>
|
|
<span class="go"> bot.</span>
|
|
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
|
|
<span class="go"> --template {full,minimal,advanced}</span>
|
|
<span class="go"> Use a template which is either `minimal`, `full`</span>
|
|
<span class="go"> (containing multiple sample indicators) or `advanced`.</span>
|
|
<span class="go"> Default: `full`.</span>
|
|
</code></pre></div>
|
|
<h3 id="sample-usage-of-new-strategy">Sample usage of new-strategy<a class="headerlink" href="#sample-usage-of-new-strategy" title="Permanent link">¶</a></h3>
|
|
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>new-strategy<span class="w"> </span>--strategy<span class="w"> </span>AwesomeStrategy
|
|
</code></pre></div>
|
|
<p>With custom user directory</p>
|
|
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>new-strategy<span class="w"> </span>--userdir<span class="w"> </span>~/.freqtrade/<span class="w"> </span>--strategy<span class="w"> </span>AwesomeStrategy
|
|
</code></pre></div>
|
|
<p>Using the advanced template (populates all optional functions and methods)</p>
|
|
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>new-strategy<span class="w"> </span>--strategy<span class="w"> </span>AwesomeStrategy<span class="w"> </span>--template<span class="w"> </span>advanced
|
|
</code></pre></div>
|
|
<h2 id="list-strategies">List Strategies<a class="headerlink" href="#list-strategies" title="Permanent link">¶</a></h2>
|
|
<p>Use the <code>list-strategies</code> subcommand to see all strategies in one particular directory.</p>
|
|
<p>This subcommand is useful for finding problems in your environment with loading strategies: modules with strategies that contain errors and failed to load are printed in red (LOAD FAILED), while strategies with duplicate names are printed in yellow (DUPLICATE NAME).</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade list-strategies [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
|
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH]</span>
|
|
<span class="go"> [--strategy-path PATH] [-1]</span>
|
|
<span class="go"> [--recursive-strategy-search]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
|
|
<span class="go"> -1, --one-column Print output in one column.</span>
|
|
<span class="go"> --recursive-strategy-search</span>
|
|
<span class="go"> Recursively search for a strategy in the strategies</span>
|
|
<span class="go"> folder.</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Warning</p>
|
|
<p>Using these commands will try to load all python files from a directory. This can be a security risk if untrusted files reside in this directory, since all module-level code is executed.</p>
|
|
</div>
|
|
<p>Example: Search default strategies directories (within the default userdir).</p>
|
|
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>list-strategies
|
|
</code></pre></div>
|
|
<p>Example: Search strategies directory within the userdir.</p>
|
|
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>list-strategies<span class="w"> </span>--userdir<span class="w"> </span>~/.freqtrade/
|
|
</code></pre></div>
|
|
<p>Example: Search dedicated strategy path.</p>
|
|
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>list-strategies<span class="w"> </span>--strategy-path<span class="w"> </span>~/.freqtrade/strategies/
|
|
</code></pre></div>
|
|
<h2 id="list-hyperopt-loss-functions">List Hyperopt-Loss functions<a class="headerlink" href="#list-hyperopt-loss-functions" title="Permanent link">¶</a></h2>
|
|
<p>Use the <code>list-hyperoptloss</code> subcommand to see all hyperopt loss functions available.</p>
|
|
<p>It provides a quick list of all available loss functions in your environment.</p>
|
|
<p>This subcommand can be useful for finding problems in your environment with loading loss functions: modules with Hyperopt-Loss functions that contain errors and failed to load are printed in red (LOAD FAILED), while hyperopt-Loss functions with duplicate names are printed in yellow (DUPLICATE NAME).</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade list-hyperoptloss [-h] [-v] [--no-color] [--logfile FILE]</span>
|
|
<span class="go"> [-V] [-c PATH] [-d PATH] [--userdir PATH]</span>
|
|
<span class="go"> [--hyperopt-path PATH] [-1]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --hyperopt-path PATH Specify additional lookup path for Hyperopt Loss</span>
|
|
<span class="go"> functions.</span>
|
|
<span class="go"> -1, --one-column Print output in one column.</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<h2 id="list-freqai-models">List freqAI models<a class="headerlink" href="#list-freqai-models" title="Permanent link">¶</a></h2>
|
|
<p>Use the <code>list-freqaimodels</code> subcommand to see all freqAI models available.</p>
|
|
<p>This subcommand is useful for finding problems in your environment with loading freqAI models: modules with models that contain errors and failed to load are printed in red (LOAD FAILED), while models with duplicate names are printed in yellow (DUPLICATE NAME).</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade list-freqaimodels [-h] [-v] [--no-color] [--logfile FILE]</span>
|
|
<span class="go"> [-V] [-c PATH] [-d PATH] [--userdir PATH]</span>
|
|
<span class="go"> [--freqaimodel-path PATH] [-1]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --freqaimodel-path PATH</span>
|
|
<span class="go"> Specify additional lookup path for freqaimodels.</span>
|
|
<span class="go"> -1, --one-column Print output in one column.</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<h2 id="list-exchanges">List Exchanges<a class="headerlink" href="#list-exchanges" title="Permanent link">¶</a></h2>
|
|
<p>Use the <code>list-exchanges</code> subcommand to see the exchanges available for the bot.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade list-exchanges [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
|
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH] [-1] [-a]</span>
|
|
<span class="go"> [--trading-mode {spot,margin,futures}]</span>
|
|
<span class="go"> [--dex-exchanges]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> -1, --one-column Print output in one column.</span>
|
|
<span class="go"> -a, --all Print all exchanges known to the ccxt library.</span>
|
|
<span class="go"> --trading-mode, --tradingmode {spot,margin,futures}</span>
|
|
<span class="go"> Select Trading mode</span>
|
|
<span class="go"> --dex-exchanges Print only DEX exchanges.</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<p>Example: see exchanges available for the bot:</p>
|
|
<div class="highlight"><pre><span></span><code>$ freqtrade list-exchanges
|
|
Exchanges available for Freqtrade:
|
|
Exchange name Supported Markets Reason
|
|
------------------ ----------- ---------------------- ------------------------------------------------------------------------
|
|
binance Official spot, isolated futures
|
|
bitmart Official spot
|
|
bybit spot, isolated futures
|
|
gate Official spot, isolated futures
|
|
htx Official spot
|
|
huobi spot
|
|
kraken Official spot
|
|
okx Official spot, isolated futures
|
|
</code></pre></div>
|
|
<div class="admonition info">
|
|
<p>Output reduced for clarity - supported and available exchanges may change over time.</p>
|
|
</div>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">missing opt exchanges</p>
|
|
<p>Values with "missing opt:" might need special configuration (e.g. using orderbook if <code>fetchTickers</code> is missing) - but should in theory work (although we cannot guarantee they will).</p>
|
|
</div>
|
|
<p>Example: see all exchanges supported by the ccxt library (including 'bad' ones, i.e. those that are known to not work with Freqtrade)</p>
|
|
<div class="highlight"><pre><span></span><code>$ freqtrade list-exchanges -a
|
|
All exchanges supported by the ccxt library:
|
|
Exchange name Valid Supported Markets Reason
|
|
------------------ ------- ----------- ---------------------- ---------------------------------------------------------------------------------
|
|
binance True Official spot, isolated futures
|
|
bitflyer False spot missing: fetchOrder. missing opt: fetchTickers.
|
|
bitmart True Official spot
|
|
bybit True spot, isolated futures
|
|
gate True Official spot, isolated futures
|
|
htx True Official spot
|
|
kraken True Official spot
|
|
okx True Official spot, isolated futures
|
|
</code></pre></div>
|
|
<div class="admonition info">
|
|
<p>Reduced output - supported and available exchanges may change over time.</p>
|
|
</div>
|
|
<h2 id="list-timeframes">List Timeframes<a class="headerlink" href="#list-timeframes" title="Permanent link">¶</a></h2>
|
|
<p>Use the <code>list-timeframes</code> subcommand to see the list of timeframes available for the exchange.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade list-timeframes [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
|
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH]</span>
|
|
<span class="go"> [--exchange EXCHANGE] [-1]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --exchange EXCHANGE Exchange name. Only valid if no config is provided.</span>
|
|
<span class="go"> -1, --one-column Print output in one column.</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<ul>
|
|
<li>Example: see the timeframes for the 'binance' exchange, set in the configuration file:</li>
|
|
</ul>
|
|
<div class="highlight"><pre><span></span><code>$ freqtrade list-timeframes -c config_binance.json
|
|
...
|
|
Timeframes available for the exchange `binance`: 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M
|
|
</code></pre></div>
|
|
<ul>
|
|
<li>Example: enumerate exchanges available for Freqtrade and print timeframes supported by each of them:
|
|
<div class="highlight"><pre><span></span><code>$ for i in `freqtrade list-exchanges -1`; do freqtrade list-timeframes --exchange $i; done
|
|
</code></pre></div></li>
|
|
</ul>
|
|
<h2 id="list-pairslist-markets">List pairs/list markets<a class="headerlink" href="#list-pairslist-markets" title="Permanent link">¶</a></h2>
|
|
<p>The <code>list-pairs</code> and <code>list-markets</code> subcommands allow to see the pairs/markets available on exchange.</p>
|
|
<p>Pairs are markets with the '/' character between the base currency part and the quote currency part in the market symbol.
|
|
For example, in the 'ETH/BTC' pair 'ETH' is the base currency, while 'BTC' is the quote currency.</p>
|
|
<p>For pairs traded by Freqtrade the pair quote currency is defined by the value of the <code>stake_currency</code> configuration setting.</p>
|
|
<p>You can print info about any pair/market with these subcommands - and you can filter output by quote-currency using <code>--quote BTC</code>, or by base-currency using <code>--base ETH</code> options correspondingly.</p>
|
|
<p>These subcommands have same usage and same set of available options:</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade list-pairs [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
|
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH]</span>
|
|
<span class="go"> [--exchange EXCHANGE] [--print-list]</span>
|
|
<span class="go"> [--print-json] [-1] [--print-csv]</span>
|
|
<span class="go"> [--base BASE_CURRENCY [BASE_CURRENCY ...]]</span>
|
|
<span class="go"> [--quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]] [-a]</span>
|
|
<span class="go"> [--trading-mode {spot,margin,futures}]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --exchange EXCHANGE Exchange name. Only valid if no config is provided.</span>
|
|
<span class="go"> --print-list Print list of pairs or market symbols. By default data</span>
|
|
<span class="go"> is printed in the tabular format.</span>
|
|
<span class="go"> --print-json Print list of pairs or market symbols in JSON format.</span>
|
|
<span class="go"> -1, --one-column Print output in one column.</span>
|
|
<span class="go"> --print-csv Print exchange pair or market data in the csv format.</span>
|
|
<span class="go"> --base BASE_CURRENCY [BASE_CURRENCY ...]</span>
|
|
<span class="go"> Specify base currency(-ies). Space-separated list.</span>
|
|
<span class="go"> --quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]</span>
|
|
<span class="go"> Specify quote currency(-ies). Space-separated list.</span>
|
|
<span class="go"> -a, --all Print all pairs or market symbols. By default only</span>
|
|
<span class="go"> active ones are shown.</span>
|
|
<span class="go"> --trading-mode, --tradingmode {spot,margin,futures}</span>
|
|
<span class="go"> Select Trading mode</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<p>By default, only active pairs/markets are shown. Active pairs/markets are those that can currently be traded on the exchange.
|
|
You can use the <code>-a</code>/<code>-all</code> option to see the list of all pairs/markets, including the inactive ones.
|
|
Pairs may be listed as untradeable if the smallest tradeable price for the market is very small, i.e. less than <code>1e-11</code> (<code>0.00000000001</code>)</p>
|
|
<p>Pairs/markets are sorted by its symbol string in the printed output.</p>
|
|
<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">¶</a></h3>
|
|
<ul>
|
|
<li>Print the list of active pairs with quote currency USD on exchange, specified in the default
|
|
configuration file (i.e. pairs on the "Binance" exchange) in JSON format:</li>
|
|
</ul>
|
|
<div class="highlight"><pre><span></span><code>$ freqtrade list-pairs --quote USD --print-json
|
|
</code></pre></div>
|
|
<ul>
|
|
<li>Print the list of all pairs on the exchange, specified in the <code>config_binance.json</code> configuration file
|
|
(i.e. on the "Binance" exchange) with base currencies BTC or ETH and quote currencies USDT or USD, as the
|
|
human-readable list with summary:</li>
|
|
</ul>
|
|
<div class="highlight"><pre><span></span><code>$ freqtrade list-pairs -c config_binance.json --all --base BTC ETH --quote USDT USD --print-list
|
|
</code></pre></div>
|
|
<ul>
|
|
<li>Print all markets on exchange "Kraken", in the tabular format:</li>
|
|
</ul>
|
|
<div class="highlight"><pre><span></span><code>$ freqtrade list-markets --exchange kraken --all
|
|
</code></pre></div>
|
|
<h2 id="test-pairlist">Test pairlist<a class="headerlink" href="#test-pairlist" title="Permanent link">¶</a></h2>
|
|
<p>Use the <code>test-pairlist</code> subcommand to test the configuration of <a href="../plugins/#pairlists">dynamic pairlists</a>.</p>
|
|
<p>Requires a configuration with specified <code>pairlists</code> attribute.
|
|
Can be used to generate static pairlists to be used during backtesting / hyperopt.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade test-pairlist [-h] [--userdir PATH] [-v] [-c PATH]</span>
|
|
<span class="go"> [--quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]]</span>
|
|
<span class="go"> [-1] [--print-json] [--exchange EXCHANGE]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> --quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]</span>
|
|
<span class="go"> Specify quote currency(-ies). Space-separated list.</span>
|
|
<span class="go"> -1, --one-column Print output in one column.</span>
|
|
<span class="go"> --print-json Print list of pairs or market symbols in JSON format.</span>
|
|
<span class="go"> --exchange EXCHANGE Exchange name. Only valid if no config is provided.</span>
|
|
</code></pre></div>
|
|
<h3 id="examples_1">Examples<a class="headerlink" href="#examples_1" title="Permanent link">¶</a></h3>
|
|
<p>Show whitelist when using a <a href="../plugins/#pairlists">dynamic pairlist</a>.</p>
|
|
<div class="highlight"><pre><span></span><code>freqtrade test-pairlist --config config.json --quote USDT BTC
|
|
</code></pre></div>
|
|
<h2 id="convert-database">Convert database<a class="headerlink" href="#convert-database" title="Permanent link">¶</a></h2>
|
|
<p><code>freqtrade convert-db</code> can be used to convert your database from one system to another (sqlite -> postgres, postgres -> other postgres), migrating all trades, orders and Pairlocks.</p>
|
|
<p>Please refer to the <a href="../advanced-setup/#use-a-different-database-system">corresponding documentation</a> to learn about requirements for different database systems.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade convert-db [-h] [--db-url PATH] [--db-url-from PATH]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --db-url PATH Override trades database URL, this is useful in custom</span>
|
|
<span class="go"> deployments (default: `sqlite:///tradesv3.sqlite` for</span>
|
|
<span class="go"> Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for</span>
|
|
<span class="go"> Dry Run).</span>
|
|
<span class="go"> --db-url-from PATH Source db url to use when migrating a database.</span>
|
|
</code></pre></div>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Warning</p>
|
|
<p>Please ensure to only use this on an empty target database. Freqtrade will perform a regular migration, but may fail if entries already existed.</p>
|
|
</div>
|
|
<h2 id="webserver-mode">Webserver mode<a class="headerlink" href="#webserver-mode" title="Permanent link">¶</a></h2>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Experimental</p>
|
|
<p>Webserver mode is an experimental mode to increase backesting and strategy development productivity.
|
|
There may still be bugs - so if you happen to stumble across these, please report them as github issues, thanks.</p>
|
|
</div>
|
|
<p>Run freqtrade in webserver mode.
|
|
Freqtrade will start the webserver and allow FreqUI to start and control backtesting processes.
|
|
This has the advantage that data will not be reloaded between backtesting runs (as long as timeframe and timerange remain identical).
|
|
FreqUI will also show the backtesting results.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade webserver [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
|
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<h3 id="webserver-mode-docker">Webserver mode - docker<a class="headerlink" href="#webserver-mode-docker" title="Permanent link">¶</a></h3>
|
|
<p>You can also use webserver mode via docker.
|
|
Starting a one-off container requires the configuration of the port explicitly, as ports are not exposed by default.
|
|
You can use <code>docker compose run --rm -p 127.0.0.1:8080:8080 freqtrade webserver</code> to start a one-off container that'll be removed once you stop it. This assumes that port 8080 is still available and no other bot is running on that port.</p>
|
|
<p>Alternatively, you can reconfigure the docker-compose file to have the command updated:</p>
|
|
<div class="highlight"><pre><span></span><code> command: >
|
|
webserver
|
|
--config /freqtrade/user_data/config.json
|
|
</code></pre></div>
|
|
<p>You can now use <code>docker compose up</code> to start the webserver.
|
|
This assumes that the configuration has a webserver enabled and configured for docker (listening port = <code>0.0.0.0</code>).</p>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Tip</p>
|
|
<p>Don't forget to reset the command back to the trade command if you want to start a live or dry-run bot. </p>
|
|
</div>
|
|
<h2 id="show-previous-backtest-results">Show previous Backtest results<a class="headerlink" href="#show-previous-backtest-results" title="Permanent link">¶</a></h2>
|
|
<p>Allows you to show previous backtest results.
|
|
Adding <code>--show-pair-list</code> outputs a sorted pair list you can easily copy/paste into your configuration (omitting bad pairs).</p>
|
|
<details class="warning">
|
|
<summary>Strategy overfitting</summary>
|
|
<p>Only using winning pairs can lead to an overfitted strategy, which will not work well on future data. Make sure to extensively test your strategy in dry-run before risking real money.</p>
|
|
</details>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade backtesting-show [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
|
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH]</span>
|
|
<span class="go"> [--backtest-filename PATH]</span>
|
|
<span class="go"> [--backtest-directory PATH]</span>
|
|
<span class="go"> [--show-pair-list]</span>
|
|
<span class="go"> [--breakdown {day,week,month,year,weekday} [{day,week,month,year,weekday} ...]]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --backtest-filename, --export-filename PATH</span>
|
|
<span class="go"> Use this filename for backtest results.Example:</span>
|
|
<span class="go"> `--backtest-</span>
|
|
<span class="go"> filename=backtest_results_2020-09-27_16-20-48.json`.</span>
|
|
<span class="go"> Assumes either `user_data/backtest_results/` or</span>
|
|
<span class="go"> `--export-directory` as base directory.</span>
|
|
<span class="go"> --backtest-directory, --export-directory PATH</span>
|
|
<span class="go"> Directory to use for backtest results. Example:</span>
|
|
<span class="go"> `--export-directory=user_data/backtest_results/`.</span>
|
|
<span class="go"> --show-pair-list Show backtesting pairlist sorted by profit.</span>
|
|
<span class="go"> --breakdown {day,week,month,year,weekday} [{day,week,month,year,weekday} ...]</span>
|
|
<span class="go"> Show backtesting breakdown per [day, week, month,</span>
|
|
<span class="go"> year, weekday].</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<h2 id="detailed-backtest-analysis">Detailed backtest analysis<a class="headerlink" href="#detailed-backtest-analysis" title="Permanent link">¶</a></h2>
|
|
<p>Advanced backtest result analysis.</p>
|
|
<p>More details in the <a href="../advanced-backtesting/#analyze-the-buyentry-and-sellexit-tags">Backtesting analysis</a> Section.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade backtesting-analysis [-h] [-v] [--no-color] [--logfile FILE]</span>
|
|
<span class="go"> [-V] [-c PATH] [-d PATH]</span>
|
|
<span class="go"> [--userdir PATH]</span>
|
|
<span class="go"> [--backtest-filename PATH]</span>
|
|
<span class="go"> [--backtest-directory PATH]</span>
|
|
<span class="go"> [--analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]]</span>
|
|
<span class="go"> [--enter-reason-list ENTER_REASON_LIST [ENTER_REASON_LIST ...]]</span>
|
|
<span class="go"> [--exit-reason-list EXIT_REASON_LIST [EXIT_REASON_LIST ...]]</span>
|
|
<span class="go"> [--indicator-list INDICATOR_LIST [INDICATOR_LIST ...]]</span>
|
|
<span class="go"> [--entry-only] [--exit-only]</span>
|
|
<span class="go"> [--timerange TIMERANGE]</span>
|
|
<span class="go"> [--rejected-signals] [--analysis-to-csv]</span>
|
|
<span class="go"> [--analysis-csv-path ANALYSIS_CSV_PATH]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --backtest-filename, --export-filename PATH</span>
|
|
<span class="go"> Use this filename for backtest results.Example:</span>
|
|
<span class="go"> `--backtest-</span>
|
|
<span class="go"> filename=backtest_results_2020-09-27_16-20-48.json`.</span>
|
|
<span class="go"> Assumes either `user_data/backtest_results/` or</span>
|
|
<span class="go"> `--export-directory` as base directory.</span>
|
|
<span class="go"> --backtest-directory, --export-directory PATH</span>
|
|
<span class="go"> Directory to use for backtest results. Example:</span>
|
|
<span class="go"> `--export-directory=user_data/backtest_results/`.</span>
|
|
<span class="go"> --analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]</span>
|
|
<span class="go"> grouping output - 0: simple wins/losses by enter tag,</span>
|
|
<span class="go"> 1: by enter_tag, 2: by enter_tag and exit_tag, 3: by</span>
|
|
<span class="go"> pair and enter_tag, 4: by pair, enter_ and exit_tag</span>
|
|
<span class="go"> (this can get quite large), 5: by exit_tag</span>
|
|
<span class="go"> --enter-reason-list ENTER_REASON_LIST [ENTER_REASON_LIST ...]</span>
|
|
<span class="go"> Space separated list of entry signals to analyse.</span>
|
|
<span class="go"> Default: all. e.g. 'entry_tag_a entry_tag_b'</span>
|
|
<span class="go"> --exit-reason-list EXIT_REASON_LIST [EXIT_REASON_LIST ...]</span>
|
|
<span class="go"> Space separated list of exit signals to analyse.</span>
|
|
<span class="go"> Default: all. e.g. 'exit_tag_a roi stop_loss</span>
|
|
<span class="go"> trailing_stop_loss'</span>
|
|
<span class="go"> --indicator-list INDICATOR_LIST [INDICATOR_LIST ...]</span>
|
|
<span class="go"> Space separated list of indicators to analyse. e.g.</span>
|
|
<span class="go"> 'close rsi bb_lowerband profit_abs'</span>
|
|
<span class="go"> --entry-only Only analyze entry signals.</span>
|
|
<span class="go"> --exit-only Only analyze exit signals.</span>
|
|
<span class="go"> --timerange TIMERANGE</span>
|
|
<span class="go"> Specify what timerange of data to use.</span>
|
|
<span class="go"> --rejected-signals Analyse rejected signals</span>
|
|
<span class="go"> --analysis-to-csv Save selected analysis tables to individual CSVs</span>
|
|
<span class="go"> --analysis-csv-path ANALYSIS_CSV_PATH</span>
|
|
<span class="go"> Specify a path to save the analysis CSVs if</span>
|
|
<span class="go"> --analysis-to-csv is enabled. Default:</span>
|
|
<span class="go"> user_data/basktesting_results/</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<h2 id="list-hyperopt-results">List Hyperopt results<a class="headerlink" href="#list-hyperopt-results" title="Permanent link">¶</a></h2>
|
|
<p>You can list the hyperoptimization epochs the Hyperopt module evaluated previously with the <code>hyperopt-list</code> sub-command.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade hyperopt-list [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
|
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH] [--best]</span>
|
|
<span class="go"> [--profitable] [--min-trades INT]</span>
|
|
<span class="go"> [--max-trades INT] [--min-avg-time FLOAT]</span>
|
|
<span class="go"> [--max-avg-time FLOAT] [--min-avg-profit FLOAT]</span>
|
|
<span class="go"> [--max-avg-profit FLOAT]</span>
|
|
<span class="go"> [--min-total-profit FLOAT]</span>
|
|
<span class="go"> [--max-total-profit FLOAT]</span>
|
|
<span class="go"> [--min-objective FLOAT] [--max-objective FLOAT]</span>
|
|
<span class="go"> [--print-json] [--no-details]</span>
|
|
<span class="go"> [--hyperopt-filename FILENAME]</span>
|
|
<span class="go"> [--export-csv FILE]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --best Select only best epochs.</span>
|
|
<span class="go"> --profitable Select only profitable epochs.</span>
|
|
<span class="go"> --min-trades INT Select epochs with more than INT trades.</span>
|
|
<span class="go"> --max-trades INT Select epochs with less than INT trades.</span>
|
|
<span class="go"> --min-avg-time FLOAT Select epochs above average time.</span>
|
|
<span class="go"> --max-avg-time FLOAT Select epochs below average time.</span>
|
|
<span class="go"> --min-avg-profit FLOAT</span>
|
|
<span class="go"> Select epochs above average profit.</span>
|
|
<span class="go"> --max-avg-profit FLOAT</span>
|
|
<span class="go"> Select epochs below average profit.</span>
|
|
<span class="go"> --min-total-profit FLOAT</span>
|
|
<span class="go"> Select epochs above total profit.</span>
|
|
<span class="go"> --max-total-profit FLOAT</span>
|
|
<span class="go"> Select epochs below total profit.</span>
|
|
<span class="go"> --min-objective FLOAT</span>
|
|
<span class="go"> Select epochs above objective.</span>
|
|
<span class="go"> --max-objective FLOAT</span>
|
|
<span class="go"> Select epochs below objective.</span>
|
|
<span class="go"> --print-json Print output in JSON format.</span>
|
|
<span class="go"> --no-details Do not print best epoch details.</span>
|
|
<span class="go"> --hyperopt-filename FILENAME</span>
|
|
<span class="go"> Hyperopt result filename.Example: `--hyperopt-</span>
|
|
<span class="go"> filename=hyperopt_results_2020-09-27_16-20-48.pickle`</span>
|
|
<span class="go"> --export-csv FILE Export to CSV-File. This will disable table print.</span>
|
|
<span class="go"> Example: --export-csv hyperopt.csv</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p><code>hyperopt-list</code> will automatically use the latest available hyperopt results file.
|
|
You can override this using the <code>--hyperopt-filename</code> argument, and specify another, available filename (without path!).</p>
|
|
</div>
|
|
<h3 id="examples_2">Examples<a class="headerlink" href="#examples_2" title="Permanent link">¶</a></h3>
|
|
<p>List all results, print details of the best result at the end:
|
|
<div class="highlight"><pre><span></span><code>freqtrade hyperopt-list
|
|
</code></pre></div></p>
|
|
<p>List only epochs with positive profit. Do not print the details of the best epoch, so that the list can be iterated in a script:
|
|
<div class="highlight"><pre><span></span><code>freqtrade hyperopt-list --profitable --no-details
|
|
</code></pre></div></p>
|
|
<h2 id="show-details-of-hyperopt-results">Show details of Hyperopt results<a class="headerlink" href="#show-details-of-hyperopt-results" title="Permanent link">¶</a></h2>
|
|
<p>You can show the details of any hyperoptimization epoch previously evaluated by the Hyperopt module with the <code>hyperopt-show</code> subcommand.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade hyperopt-show [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
|
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH] [--best]</span>
|
|
<span class="go"> [--profitable] [-n INT] [--print-json]</span>
|
|
<span class="go"> [--hyperopt-filename FILENAME] [--no-header]</span>
|
|
<span class="go"> [--disable-param-export]</span>
|
|
<span class="go"> [--breakdown {day,week,month,year,weekday} [{day,week,month,year,weekday} ...]]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --best Select only best epochs.</span>
|
|
<span class="go"> --profitable Select only profitable epochs.</span>
|
|
<span class="go"> -n, --index INT Specify the index of the epoch to print details for.</span>
|
|
<span class="go"> --print-json Print output in JSON format.</span>
|
|
<span class="go"> --hyperopt-filename FILENAME</span>
|
|
<span class="go"> Hyperopt result filename.Example: `--hyperopt-</span>
|
|
<span class="go"> filename=hyperopt_results_2020-09-27_16-20-48.pickle`</span>
|
|
<span class="go"> --no-header Do not print epoch details header.</span>
|
|
<span class="go"> --disable-param-export</span>
|
|
<span class="go"> Disable automatic hyperopt parameter export.</span>
|
|
<span class="go"> --breakdown {day,week,month,year,weekday} [{day,week,month,year,weekday} ...]</span>
|
|
<span class="go"> Show backtesting breakdown per [day, week, month,</span>
|
|
<span class="go"> year, weekday].</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p><code>hyperopt-show</code> will automatically use the latest available hyperopt results file.
|
|
You can override this using the <code>--hyperopt-filename</code> argument, and specify another, available filename (without path!).</p>
|
|
</div>
|
|
<h3 id="examples_3">Examples<a class="headerlink" href="#examples_3" title="Permanent link">¶</a></h3>
|
|
<p>Print details for the epoch 168 (the number of the epoch is shown by the <code>hyperopt-list</code> subcommand or by Hyperopt itself during hyperoptimization run):</p>
|
|
<div class="highlight"><pre><span></span><code>freqtrade hyperopt-show -n 168
|
|
</code></pre></div>
|
|
<p>Prints JSON data with details for the last best epoch (i.e., the best of all epochs):</p>
|
|
<div class="highlight"><pre><span></span><code>freqtrade hyperopt-show --best -n -1 --print-json --no-header
|
|
</code></pre></div>
|
|
<h2 id="show-trades">Show trades<a class="headerlink" href="#show-trades" title="Permanent link">¶</a></h2>
|
|
<p>Print selected (or all) trades from database to screen.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade show-trades [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
|
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH]</span>
|
|
<span class="go"> [--db-url PATH]</span>
|
|
<span class="go"> [--trade-ids TRADE_IDS [TRADE_IDS ...]]</span>
|
|
<span class="go"> [--print-json]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --db-url PATH Override trades database URL, this is useful in custom</span>
|
|
<span class="go"> deployments (default: `sqlite:///tradesv3.sqlite` for</span>
|
|
<span class="go"> Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for</span>
|
|
<span class="go"> Dry Run).</span>
|
|
<span class="go"> --trade-ids TRADE_IDS [TRADE_IDS ...]</span>
|
|
<span class="go"> Specify the list of trade ids.</span>
|
|
<span class="go"> --print-json Print output in JSON format.</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
<h3 id="examples_4">Examples<a class="headerlink" href="#examples_4" title="Permanent link">¶</a></h3>
|
|
<p>Print trades with id 2 and 3 as json</p>
|
|
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>show-trades<span class="w"> </span>--db-url<span class="w"> </span>sqlite:///tradesv3.sqlite<span class="w"> </span>--trade-ids<span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="m">3</span><span class="w"> </span>--print-json
|
|
</code></pre></div>
|
|
<h2 id="strategy-updater">Strategy-Updater<a class="headerlink" href="#strategy-updater" title="Permanent link">¶</a></h2>
|
|
<p>Updates listed strategies or all strategies within the strategies folder to be v3 compliant.
|
|
If the command runs without --strategy-list then all strategies inside the strategies folder will be converted.
|
|
Your original strategy will remain available in the <code>user_data/strategies_orig_updater/</code> directory.</p>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Conversion results</p>
|
|
<p>Strategy updater will work on a "best effort" approach. Please do your due diligence and verify the results of the conversion.
|
|
We also recommend to run a python formatter (e.g. <code>black</code>) to format results in a sane manner.</p>
|
|
</div>
|
|
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade strategy-updater [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
|
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH]</span>
|
|
<span class="go"> [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]</span>
|
|
<span class="go"> [--strategy-path PATH]</span>
|
|
<span class="go"> [--recursive-strategy-search]</span>
|
|
|
|
<span class="go">options:</span>
|
|
<span class="go"> -h, --help show this help message and exit</span>
|
|
<span class="go"> --strategy-list STRATEGY_LIST [STRATEGY_LIST ...]</span>
|
|
<span class="go"> Provide a space-separated list of strategies to</span>
|
|
<span class="go"> backtest. Please note that timeframe needs to be set</span>
|
|
<span class="go"> either in config or via command line. When using this</span>
|
|
<span class="go"> together with `--export trades`, the strategy-name is</span>
|
|
<span class="go"> injected into the filename (so `backtest-data.json`</span>
|
|
<span class="go"> becomes `backtest-data-SampleStrategy.json`</span>
|
|
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
|
|
<span class="go"> --recursive-strategy-search</span>
|
|
<span class="go"> Recursively search for a strategy in the strategies</span>
|
|
<span class="go"> folder.</span>
|
|
|
|
<span class="go">Common arguments:</span>
|
|
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
|
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
|
<span class="go"> useful if you are redirecting output to a file.</span>
|
|
<span class="go"> --logfile, --log-file FILE</span>
|
|
<span class="go"> Log to the file specified. Special values are:</span>
|
|
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
|
<span class="go"> details.</span>
|
|
<span class="go"> -V, --version show program's version number and exit</span>
|
|
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
|
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
|
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
|
<span class="go"> set to `-` to read config from stdin.</span>
|
|
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
|
<span class="go"> Path to the base directory of the exchange with</span>
|
|
<span class="go"> historical backtesting data. To see futures data, use</span>
|
|
<span class="go"> trading-mode additionally.</span>
|
|
<span class="go"> --userdir, --user-data-dir PATH</span>
|
|
<span class="go"> Path to userdata directory.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
|
|
|
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
</div>
|
|
|
|
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
|
Back to top
|
|
</button>
|
|
|
|
</main>
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
|
|
|
|
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
|
|
|
|
|
<a href="../leverage/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Short / Leverage">
|
|
<div class="md-footer__button md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
|
</div>
|
|
<div class="md-footer__title">
|
|
<span class="md-footer__direction">
|
|
Previous
|
|
</span>
|
|
<div class="md-ellipsis">
|
|
Short / Leverage
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="../plotting/" class="md-footer__link md-footer__link--next" aria-label="Next: Plotting">
|
|
<div class="md-footer__title">
|
|
<span class="md-footer__direction">
|
|
Next
|
|
</span>
|
|
<div class="md-ellipsis">
|
|
Plotting
|
|
</div>
|
|
</div>
|
|
<div class="md-footer__button md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-copyright">
|
|
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs
|
|
</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
|
|
<!-- Place this tag in your head or just before your close body tag. -->
|
|
<script src="https://code.jquery.com/jquery-3.4.1.min.js"
|
|
integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
|
|
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
|
|
|
|
|
|
<script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
|
|
|
|
<script src="../javascripts/config.js"></script>
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |