From 48b7b0cf3c1c77516e0467b013ae6dca8166e91e Mon Sep 17 00:00:00 2001
From: Quant Freedom 1022 <quantfreedom1022@gmail.com>
Date: Wed, 13 Mar 2024 05:24:53 -0700
Subject: [PATCH] Deployed a17b471 with MkDocs version: 1.5.3

---
 404.html                                        |   8 ++++----
 beginners/index.html                            |  14 +++++++-------
 free_bot_finish/index.html                      |   8 ++++----
 free_trading_bots copy/index.html               |   8 ++++----
 free_trading_bots/index.html                    |  14 +++++++-------
 index.html                                      |   8 ++++----
 nav_file/index.html                             |  12 ++++++------
 quantfreedom/enums/index.html                   |   8 ++++----
 .../exchanges/apex_exchange/apex/index.html     |   8 ++++----
 .../binance_exchange/binance_us/index.html      |   8 ++++----
 .../binance_exchange/binance_usdm/index.html    |   8 ++++----
 .../exchanges/bybit_exchange/bybit/index.html   |   8 ++++----
 .../exchanges/mufex_exchange/mufex/index.html   |   8 ++++----
 quantfreedom/helper_funcs/index.html            |   8 ++++----
 .../indicators/tv_indicators/index.html         |   8 ++++----
 .../nb_indicators/nb_indicators/index.html      |   8 ++++----
 .../nb_increase_position/index.html             |   8 ++++----
 .../nb_order_handler/nb_stop_loss/index.html    |   8 ++++----
 .../nb_funcs/nb_simulate/nb_sim_base/index.html |   8 ++++----
 .../nb_funcs/nb_simulate/nb_sim_df/index.html   |   8 ++++----
 .../nb_strategies/nb_strategy/index.html        |   8 ++++----
 .../order_handler/increase_position/index.html  |   8 ++++----
 quantfreedom/order_handler/order/index.html     |   8 ++++----
 quantfreedom/order_handler/stop_loss/index.html |   8 ++++----
 quantfreedom/simulate/index.html                |   8 ++++----
 quantfreedom/utils/index.html                   |   8 ++++----
 search/search_index.json                        |   2 +-
 sitemap.xml.gz                                  | Bin 127 -> 127 bytes
 28 files changed, 113 insertions(+), 113 deletions(-)

diff --git a/404.html b/404.html
index c94a8116..acb591d0 100755
--- a/404.html
+++ b/404.html
@@ -190,7 +190,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -207,7 +207,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -316,7 +316,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -336,7 +336,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/beginners/index.html b/beginners/index.html
index 2e88306e..3d3b39b8 100755
--- a/beginners/index.html
+++ b/beginners/index.html
@@ -20,7 +20,7 @@
     
     
       
-        <title>Beginners - QuantFreedom Docs</title>
+        <title>Beginners Guide - QuantFreedom Docs</title>
       
     
     
@@ -100,7 +100,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
             
-              Beginners
+              Beginners Guide
             
           </span>
         </div>
@@ -194,7 +194,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -213,7 +213,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -322,7 +322,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -349,7 +349,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
@@ -1467,7 +1467,7 @@
   
 
 
-  <h1>Beginners</h1>
+  <h1>Beginners Guide</h1>
 
 <p>BEGINNERS GUIDE</p>
 <p>these are just suggestion playlists ... if you don't like the videos please find your own playlists that you like</p>
diff --git a/free_bot_finish/index.html b/free_bot_finish/index.html
index 511e5eb5..77381e6b 100755
--- a/free_bot_finish/index.html
+++ b/free_bot_finish/index.html
@@ -195,7 +195,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -212,7 +212,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -321,7 +321,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -341,7 +341,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/free_trading_bots copy/index.html b/free_trading_bots copy/index.html
index d7021e68..6c92e11d 100755
--- a/free_trading_bots copy/index.html	
+++ b/free_trading_bots copy/index.html	
@@ -195,7 +195,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -212,7 +212,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -321,7 +321,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -341,7 +341,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/free_trading_bots/index.html b/free_trading_bots/index.html
index c4128557..36e0f131 100755
--- a/free_trading_bots/index.html
+++ b/free_trading_bots/index.html
@@ -20,7 +20,7 @@
     
     
       
-        <title>Free Trading Bot - QuantFreedom Docs</title>
+        <title>Free Bot Sign Up - QuantFreedom Docs</title>
       
     
     
@@ -105,7 +105,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
             
-              Free Trading Bot
+              Free Bot Sign Up
             
           </span>
         </div>
@@ -201,7 +201,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -218,7 +218,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -336,7 +336,7 @@
           
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -495,7 +495,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/index.html b/index.html
index 8f25e1a6..e34e5ab9 100755
--- a/index.html
+++ b/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -425,7 +425,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -445,7 +445,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/nav_file/index.html b/nav_file/index.html
index bd9e7ba6..95964308 100755
--- a/nav_file/index.html
+++ b/nav_file/index.html
@@ -190,7 +190,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -207,7 +207,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -316,7 +316,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -336,7 +336,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
@@ -1457,8 +1457,8 @@ <h1>Nav file</h1>
 
 <ul>
 <li><a href="../">Installation</a></li>
-<li><a href="../free_trading_bots/">Free Trading Bot</a></li>
-<li><a href="../beginners/">Beginners</a></li>
+<li><a href="../free_trading_bots/">Free Bot Sign Up</a></li>
+<li><a href="../beginners/">Beginners Guide</a></li>
 <li>Functions<ul>
 <li><a href="../quantfreedom/enums/">enums</a></li>
 <li>exchanges<ul>
diff --git a/quantfreedom/enums/index.html b/quantfreedom/enums/index.html
index fa119799..f43a7971 100755
--- a/quantfreedom/enums/index.html
+++ b/quantfreedom/enums/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/exchanges/apex_exchange/apex/index.html b/quantfreedom/exchanges/apex_exchange/apex/index.html
index a87c4c35..c0359107 100755
--- a/quantfreedom/exchanges/apex_exchange/apex/index.html
+++ b/quantfreedom/exchanges/apex_exchange/apex/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/exchanges/binance_exchange/binance_us/index.html b/quantfreedom/exchanges/binance_exchange/binance_us/index.html
index d54c36d4..4fccac8c 100755
--- a/quantfreedom/exchanges/binance_exchange/binance_us/index.html
+++ b/quantfreedom/exchanges/binance_exchange/binance_us/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/exchanges/binance_exchange/binance_usdm/index.html b/quantfreedom/exchanges/binance_exchange/binance_usdm/index.html
index 2aa2d70b..2bab9d8e 100755
--- a/quantfreedom/exchanges/binance_exchange/binance_usdm/index.html
+++ b/quantfreedom/exchanges/binance_exchange/binance_usdm/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/exchanges/bybit_exchange/bybit/index.html b/quantfreedom/exchanges/bybit_exchange/bybit/index.html
index c215dfb7..1d6c6ec9 100755
--- a/quantfreedom/exchanges/bybit_exchange/bybit/index.html
+++ b/quantfreedom/exchanges/bybit_exchange/bybit/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/exchanges/mufex_exchange/mufex/index.html b/quantfreedom/exchanges/mufex_exchange/mufex/index.html
index deff519e..db731f85 100755
--- a/quantfreedom/exchanges/mufex_exchange/mufex/index.html
+++ b/quantfreedom/exchanges/mufex_exchange/mufex/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/helper_funcs/index.html b/quantfreedom/helper_funcs/index.html
index daf8f530..6a0dec45 100755
--- a/quantfreedom/helper_funcs/index.html
+++ b/quantfreedom/helper_funcs/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/indicators/tv_indicators/index.html b/quantfreedom/indicators/tv_indicators/index.html
index 887a1d81..7fbace3d 100755
--- a/quantfreedom/indicators/tv_indicators/index.html
+++ b/quantfreedom/indicators/tv_indicators/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/nb_funcs/nb_indicators/nb_indicators/index.html b/quantfreedom/nb_funcs/nb_indicators/nb_indicators/index.html
index af9c4fed..6a0acac4 100755
--- a/quantfreedom/nb_funcs/nb_indicators/nb_indicators/index.html
+++ b/quantfreedom/nb_funcs/nb_indicators/nb_indicators/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/index.html b/quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/index.html
index 552f97f6..b544b2b2 100755
--- a/quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/index.html
+++ b/quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/index.html b/quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/index.html
index 02530f98..b03e4c67 100755
--- a/quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/index.html
+++ b/quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/nb_funcs/nb_simulate/nb_sim_base/index.html b/quantfreedom/nb_funcs/nb_simulate/nb_sim_base/index.html
index 3388180a..817ec95b 100755
--- a/quantfreedom/nb_funcs/nb_simulate/nb_sim_base/index.html
+++ b/quantfreedom/nb_funcs/nb_simulate/nb_sim_base/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/nb_funcs/nb_simulate/nb_sim_df/index.html b/quantfreedom/nb_funcs/nb_simulate/nb_sim_df/index.html
index 3cd7cacd..1ca35e6c 100755
--- a/quantfreedom/nb_funcs/nb_simulate/nb_sim_df/index.html
+++ b/quantfreedom/nb_funcs/nb_simulate/nb_sim_df/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/nb_funcs/nb_strategies/nb_strategy/index.html b/quantfreedom/nb_funcs/nb_strategies/nb_strategy/index.html
index 1d032f15..df671a83 100755
--- a/quantfreedom/nb_funcs/nb_strategies/nb_strategy/index.html
+++ b/quantfreedom/nb_funcs/nb_strategies/nb_strategy/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/order_handler/increase_position/index.html b/quantfreedom/order_handler/increase_position/index.html
index 413b8941..330924fa 100755
--- a/quantfreedom/order_handler/increase_position/index.html
+++ b/quantfreedom/order_handler/increase_position/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/order_handler/order/index.html b/quantfreedom/order_handler/order/index.html
index b4b0c72d..5f8730db 100755
--- a/quantfreedom/order_handler/order/index.html
+++ b/quantfreedom/order_handler/order/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/order_handler/stop_loss/index.html b/quantfreedom/order_handler/stop_loss/index.html
index 3a9d76c9..7d28d0de 100755
--- a/quantfreedom/order_handler/stop_loss/index.html
+++ b/quantfreedom/order_handler/stop_loss/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/simulate/index.html b/quantfreedom/simulate/index.html
index a67c3357..43d23e2f 100755
--- a/quantfreedom/simulate/index.html
+++ b/quantfreedom/simulate/index.html
@@ -199,7 +199,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -216,7 +216,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -327,7 +327,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -347,7 +347,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/quantfreedom/utils/index.html b/quantfreedom/utils/index.html
index 714506c6..c4eb275c 100755
--- a/quantfreedom/utils/index.html
+++ b/quantfreedom/utils/index.html
@@ -197,7 +197,7 @@
   
     
   
-  Free Trading Bot
+  Free Bot Sign Up
 
       </a>
     </li>
@@ -214,7 +214,7 @@
   
     
   
-  Beginners
+  Beginners Guide
 
       </a>
     </li>
@@ -325,7 +325,7 @@
         
   
   <span class="md-ellipsis">
-    Free Trading Bot
+    Free Bot Sign Up
   </span>
   
 
@@ -345,7 +345,7 @@
         
   
   <span class="md-ellipsis">
-    Beginners
+    Beginners Guide
   </span>
   
 
diff --git a/search/search_index.json b/search/search_index.json
index e79f2e0a..060ca646 100755
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Installation","text":"<p>Make sure you read the entire bullet point before you start doing what the bullet point says.</p>"},{"location":"#step-1-creating-a-github-account","title":"Step 1: Creating a github account","text":"<p>Watch this video to get an idea of what you are about to do. But do not follow this is just for informations: https://www.youtube.com/watch?v=Gn3w1UvTx0A</p> <ul> <li>Make a github account and remember or copy what your username and email you used to sign up with is     https://github.com/</li> <li>Creating a repo: watch this video up until min 1:21 just for information do not follow it https://www.youtube.com/watch?v=f26KI43FK58</li> <li>click the plus icon like in the video and click new repository </li> <li>give your repo a name</li> <li>make sure it is public</li> <li>add a readme file</li> <li>add a python gitignore by click on the add gitignore dropdown and type python and select it</li> <li>click on the choose license and choose the Apache license 2.0</li> <li>click create repository </li> </ul>"},{"location":"#step-2-installing-python","title":"Step 2: Installing Python","text":"<ul> <li>Helper video: example video of someone installing python ... but do not follow along with what he is doing, just watch this to get an idea of what you will be doing https://www.youtube.com/watch?v=m9I-YpOjXVQ</li> <li>Download python 3.10.10 - If you already have another version of python installed that is fine because you can have multiple versions of python installed - https://www.python.org/downloads/release/python-31010/</li> <li>To download Scroll down to the bottom of the page or where it says files and click on either the mac version or windows version and install it </li> <li>when you start the install make sure you click add python.exe to path at the bottom of the installer window </li> <li>click on customize install</li> <li>click next</li> <li>check install python 3.10 for all users</li> <li>click on install</li> </ul>"},{"location":"#step-3-installing-git-bash","title":"Step 3: Installing Git Bash","text":"<p>Git Bash is how you allow your computer to talk to github.</p> <ul> <li>Please watch this helper video first before doing anything \u2026 but it important to note Helper video: https://www.youtube.com/watch?v=2j7fD92g-gE</li> <li>Download git and at the end of install make sure you check Launch git bash</li> <li>https://git-scm.com/downloads </li> <li>Copy paste the the following in the window and replace @@@@@@@@ with your github username and make sure it has quotes around your username. For me copying it from here and right clicking in the gitbash window is how i actually past it.</li> <li>git config --global user.name \"@@@@@@@@\"</li> <li>Now type the following and change the email to the email you used to sign up with github</li> <li>git config --global user.email johndoe@example.com</li> </ul>"},{"location":"#step-4-download-visual-studio-code","title":"Step 4: Download Visual Studio Code","text":"<p>This is the program I use to code</p> <ul> <li>Watch this helper video first so you have an idea of what you are about to do: https://www.youtube.com/watch?v=JPZsB_6yHVo</li> <li>Click this link and download for your operating system, then lanuch VSC https://code.visualstudio.com/download</li> <li>In the top left corner, in the menu bar click file, then make sure autosave is checked, if it isn't click it to set it</li> <li></li> </ul>"},{"location":"#installing-extensions","title":"Installing Extensions","text":"<ul> <li>Click the extensions tab which is the 5th icon from the top that looks like 3 squares with the upper right square coming off a little bit.</li> <li></li> <li>Install the following extensions Type in the following extensions one by in the search bar \u2026 if you already have it installed then move to the next on the list</li> <li></li> <li>Python - python</li> <li>Black formatter - this will allow you to format your code</li> <li>Gitlens - this is to help with github stuff</li> <li>jupyter - lets you run jupyter notebooks</li> <li>Magic python - helps with formatting</li> <li>Material icon theme - makes your icons nice</li> <li>Prettier - helps with formatting</li> <li>Pylance - python stuff</li> <li>Python indent - indents your python code properly</li> <li>Now that you are done bring up the vs code menu by pressing cntrl shift p and type in the words activate icons</li> <li>Now click on material icons: activate icons \u2026 this will make your file icons look a lot better</li> <li></li> </ul>"},{"location":"#creating-virtual-environment","title":"Creating virtual environment","text":"<p>Ctl shift p and type in default profile and then select terminal select default profile Click on cmd prompt In the menu bar click on terminal New terminal</p> <p>Create a folder called coding wherever you want on your computer Create a folder inside that folder called venvs - venv stands for virtual enviromnet Now you want to change your terminal directory to the coding folder Change to the correct drive by typing something like C: or E: or whatever your drive letter is Then copy the path to your coding folder something like this quantfreedom\\coding\\venvs And in the terminal paste cd  quantfreedom\\coding\\venvs\\</p> <p>Change directory to venvs Create venv python -m venv qfree qfree\\Scripts\\activate.bat - this will activate the virtual enviromnelt Now you will see we have free to the left of the thing</p> <p>Ctrlp shift p type in word interpreter Select python interpreter Then enter interpreter path Then find Then go to the coding folder then venvs then qfree then scripts then click on python.exe</p> <p>Github part Click on green code button and copy url to clipboard from https</p> <p>Then go to vscode and ctrl shift p then type in clone and click github clone and then paste the repo And if vs code asks you to log into github click yes</p> <p>Then when it asks you for a folder you open the coding folder you created and then click yes or ok</p> <p>Ctrl shift p and type interpreter  select python inter</p> <p>Then choose qfree</p> <p>Vscode file autosave Vscode search clone git repo then paste \u2026 select folder Now create new file called test.ipynb</p> <p>Select kernel python en</p> <p>Add this to settings.json \"editor.parameterHints.enabled\": false, \"python.terminal.activateEnvironment\": true,</p> <p>For me \u2026 show them how to print in a python file \u2026 and also show them how to do math in the python file</p> <p>python beginners playlist ... https://www.youtube.com/playlist?list=PL-osiE80TeTskrapNbzXhwoFUiLCjGgY7</p> <p>Create github Create repo Then download python Download vs code Then clone repo Then create venv Pip install quantfreedom Then select inpertere Then menu terminal new terminal</p>"},{"location":"beginners/","title":"Beginners","text":"<p>BEGINNERS GUIDE</p> <p>these are just suggestion playlists ... if you don't like the videos please find your own playlists that you like</p> <p>study the basics of python https://www.youtube.com/playlist?list=PL-osiE80TeTskrapNbzXhwoFUiLCjGgY7</p> <p>working with classes  https://www.youtube.com/playlist?list=PL-osiE80TeTsqhIuOqKhwlXsIBIdSeYtc</p> <p>learn the basics of pandas https://www.youtube.com/playlist?list=PL-osiE80TeTsWmV9i9c58mdDCSskIFdDS</p> <p>study plotly https://www.youtube.com/playlist?list=PLBSCvBlTOLa8rf2kGkP_Bx5xXqT-er4Yq</p> <p>then study the basics of numpy https://www.youtube.com/playlist?list=PLZGM26Bt_cku3VRraPDwzzqrav0_u8pDC https://www.youtube.com/playlist?list=PLc_Ps3DdrcTuf3e-BBpDv8r9jbOB5Wdv- https://www.youtube.com/playlist?list=PLCC34OHNcOtpalASMlX2HHdsLNipyyhbK</p> <p>once you are done with this then follow my latest video going over a strategy</p> <p>then make your own signals from doing an ema cross over ... just make the proper signals and graph the signals</p> <p>once you make the signals then let me know in the general chat and send me a link to your github and i will check it out and then we can move on from there </p>"},{"location":"free_bot_finish/","title":"Free Bot Finish","text":"<p>Make sure you read the entire bullet point before you start doing what the bullet point says.</p>"},{"location":"free_bot_finish/#donnload-winscp","title":"Donnload WINSCP","text":"<ul> <li>Download winscp https://winscp.net/eng/downloads.php</li> <li>Scroll down and click the download winscp green button and it should auto download, then launch the install</li> <li>Click install for all users</li> <li>Click on accept</li> <li>Choose typical then next</li> <li>Then commander then next</li> <li>Then install</li> <li>Uncheck open get started page and uncheck launch then hit finish</li> </ul>"},{"location":"free_bot_finish/#github-token","title":"Github token","text":"<ul> <li>In the upper right corner of github click on your profile icon and go to settings at the bottom of the menu</li> <li>now go all the way down to the bottom and on the left side click dev settings</li> <li>then on the left side click personal access tokens then click on token classics</li> <li>now click on generate a new token on the upper right side next to revoke all and click on generate new token classic</li> <li>then select the main repo that will select all the options under repo </li> <li>then scroll to the bottom and choose create token</li> <li>make sure you copy and save this somewhere because you will need it to run the strategy</li> </ul>"},{"location":"free_bot_finish/#aws-launch-template","title":"AWS Launch Template","text":"<ul> <li>Log into AWS and go to the console home page and click on EC2</li> <li>On the left side click on security groups under network and security </li> <li>Click on the blue name under secuirty group id which should have the name default under secuirty group name </li> <li>Now we are going to edit the inbound rules in the inbound rules then click edit inbound rules </li> <li>Type will be ssh ... source will be ipv4 and then hit save rule </li> <li>Now click on the outbound tab click edit outbound rules</li> <li>change the type to all traffic and destination to anywhere ipv4 then save rules </li> <li>On the left side menu click on launch templates under instances and then click the orange create launch template in the upper right corner </li> <li>Give your template a name under launch template name </li> <li>In the next section choose ubuntu </li> <li>For instance type choose the t2 free tier option </li> <li>next in key pair login click on create new key pair </li> <li>Then name the key pair something and select ppk and then click create key pair </li> <li>Make sure you save the download somewhere other than your desktop because you will need to use it later on.</li> <li>In network settings choose the security group that we made earlier </li> </ul>"},{"location":"free_bot_finish/#adding-github-token","title":"Adding Github Token","text":"<ul> <li>Open this script</li> <li>On line 7 change where is says %%%%%%%GITHUB_TOKEN with yoru github token</li> <li>On line 13 replace %%%%%%%STRAT_FOLDER with the name of the folder of the strat you want to run ... Ex: 02_rsi_rising_falling ... you can get the name of the folder from the main repo https://github.com/QuantFreedom1022/live_bots</li> <li>On line 14 replace %%%%%%%RUN_FILE.py with the main.py in the folder of the strat you want to run ... Ex: rsi_main.py it will always be a file with main in the name of it</li> <li>Now replace the %%%%%%%API_KEY with your api key</li> <li>Replace the %%%%%%%SECRET_KEY with your secret key</li> <li>Now replace %%%%%%%USE_TEST_NET with a true if you want to use the testnet and a false if you want to use the main net ... all lower case</li> <li>Finally replace %%%%%%%%EXCHANGE_NAME with the name of the exchange you want to trade on ... Ex: mufex ... all lower case</li> <li></li> <li>Go back to the amazon template website</li> </ul>"},{"location":"free_bot_finish/#aes-advanced-details","title":"AES Advanced Details","text":"<ul> <li>Scroll down to the bottom and open advanced details </li> <li>Scroll down to the part that says Metadata version and make sure you have v2 only selected </li> <li>Then go down to the bottom and paste in the aws sript that you made</li> <li>Click on the create template create launch template</li> </ul>"},{"location":"free_bot_finish/#running-the-bot","title":"Running The Bot","text":"<ul> <li>now in the green section click on the link </li> <li>then click on actions on the right side and click launch instance from template </li> <li>then on the right side click on the orange button launch instance</li> <li>then in the green success box click the link</li> <li>then under instance id you click that blue link </li> <li>copy the ipv4 dns </li> </ul>"},{"location":"free_bot_finish/#winscp","title":"WINSCP","text":"<ul> <li>Open winscp</li> <li>in the login screen if you can't edit the host name click edit</li> <li>in the host name field past in the public ipv4 dns</li> <li>Paste it into the host name </li> <li>change the user name to ubuntu</li> <li>clcik on the button advanced and on the left side go to ssh authentication</li> <li>now find the private key file that you downloaded and hit ok </li> <li>now hit save and then hit login and hit yes</li> </ul>"},{"location":"free_bot_finish/#checking-the-logs","title":"Checking The Logs","text":"<ul> <li>You may have to wait 3 to 5 mins for the live bots folder to appear </li> <li>Once the folder shows up you can open the folder and then inside of that folder there should be a logs folder </li> <li>If you don't see a logs folder just wait another min or two and click the refresh button until you see the logs folder.</li> <li>Click on the log file to see what the bot is doing. open logs and you should see that the bot is running </li> </ul>"},{"location":"free_trading_bots%20copy/","title":"Free trading bots copy","text":""},{"location":"free_trading_bots%20copy/#table-of-contents","title":"Table of Contents","text":"<ul> <li>Prerequisites</li> <li>ByBit</li> <li>AWS Launch Template</li> <li>Connect to AWS Instance</li> <li>Github token</li> <li>Get Access To Strat</li> <li>Add Token To Script</li> </ul> <p>--====================================================</p>"},{"location":"free_trading_bots%20copy/#prerequisites","title":"Prerequisites","text":"<ul> <li>If you don't have one Create a github account</li> <li>You will need to sign up to the EC2 Free Tier</li> <li>Install Winscp</li> <li>download winscp https://winscp.net/eng/downloads.php then launch the install</li> <li>choose typical and then commander then install</li> <li>uncheck open get started page</li> <li>Install PuTTY</li> <li>Make sure you have a working credit card and finish the whole sign up process before you continue.</li> </ul> <p>(back to top)</p>"},{"location":"free_trading_bots%20copy/#bybit","title":"ByBit","text":"<p>(include in Bybit section - added from WINSCP) * for bybit you have to make sure you are in a uinfied account ... log into bybit and go to the trading pair btcusdt and on the right side below the open and short and above the contract details and price pool ... if you see the word upgrade make sure</p> <p></p> <p>(back to top )</p>"},{"location":"free_trading_bots%20copy/#aws-launch-template","title":"AWS Launch Template","text":"<ul> <li>Log into AWS and go to the console home page and click on EC2</li> <li>On the left side menu click on Security Groups under Network and Security.</li> <li>Crerate new security group (in my case: wizard 1), and make sure the Inbound and Outbound rules are setup correctly, and create new security group. </li> <li>Go back to EC2 main page, on the left side menu click on launch templates under instances and then click the orange create launch template</li> <li> <p>Name your template under launch template name   </p> </li> <li> <p>In the next section choose latest ubuntu version   </p> </li> <li> <p>For instance type choose the .micro Free tier eligible option   </p> </li> <li> <p>next in key pair login click on create new key pair   </p> </li> <li> <p>Then name the key pair something and select ppk and then click create key pair   </p> </li> <li> <p>Make sure you save the download somewhere other than your desktop because you will need to use it later on.</p> </li> <li>in network settings choose the security groups as (created begore) wizard 1   </li> </ul> <p>(Added from Adding Github Token) * create launch template * now in the green sction click on the link * then click on actions and launch instance from template * then in lower right corner click launch instance * thne in the green click the link to see the instance details</p> <p>(back to top )</p>"},{"location":"free_trading_bots%20copy/#connect-to-aws-instance","title":"Connect to AWS Instance","text":"<ul> <li>Go to EC2 main page</li> <li>then under instance id you click that link</li> <li>copy the ipv4 dns and paste it into the host name for the winscp, use SFTP file protocol port 22 and ubuntu as username</li> <li>clcik on the name advanced and on the left side go to SSH / Autnetication</li> <li>now find the private key file that you downloaded during creation of AWS template. </li> <li>then hit OK and login, (make sure the IP from Instance ID and security group inbound and outbound are corrct)</li> <li>click on the live bots folder and then open logs and you should see that the bot is running</li> </ul> <p>(back to top )</p>"},{"location":"free_trading_bots%20copy/#github-token","title":"Github token","text":"<ul> <li>In the upper right corner of github click on your profile icon and go to settings at the bottom of the menu</li> <li>now go all the way down to the bottom and on the left side click dev settings</li> <li>then on the left side click personal access tokens then click on token classics</li> <li>now click on generate a new token on the upper right side next to revoke all and click on generate new token classic</li> <li> <p>then select the main repo that will select all the options under repo alt text </p> </li> <li> <p>then scroll to the bottom and choose create token</p> </li> <li>make sure you copy and save this somewhere because you will need it to run the strategy</li> </ul> <p>(back to top )</p>"},{"location":"free_trading_bots%20copy/#get-access-to-strat","title":"Get Access To Strat","text":"<p>So at this point you should have everything done and you have the following</p> <ul> <li> You have at least 100 dollars in your crpyto exchange account</li> <li> You have a AWS account that is ready to be used</li> <li> You have a github account and token</li> <li> you have your api keys ready and for bybit users that you have verified your account is unified</li> <li> now you will go to the discord and let me know you signed up in the bot sign up channel</li> <li> You will send the following: A screen shot of you following me on all the social media accounts and a link to your github account.</li> <li> Once you have got confirmation from me that I added you to the repo go to this repo and approve being a collaborator. Bot Github Repo</li> </ul> <p>(back to top )</p>"},{"location":"free_trading_bots%20copy/#add-token-to-script","title":"Add Token To Script","text":"<p>no chane</p> <p>(back to top )</p>"},{"location":"free_trading_bots/","title":"Free Live Trading Bots","text":"<p>I am giving away bots that are ready to go live FOR FREE ... All you will have to do is provide your API keys in the code and hit run</p> <p>You don't need to have any skill with python but you do need to be able to follow directions to get them to work.</p>"},{"location":"free_trading_bots/#follow-my-social-media-pages","title":"Follow My Social Media Pages","text":"<ul> <li>If you don't have a twitter or IG just make a burner account (I will probably never use these platforms. I am only doing this so that if i ever need to DM a bigger influencer that they will see i have followers and respond)</li> <li>Click here to follow me on Twitter</li> <li>Click here to follow me on Instagram</li> <li>Click here to follow me on Youtube</li> <li>Star the github project </li> <li>Make sure you screen shot all of these so I know that you have actually followed me because you will need to put the screen shots in the discord.</li> </ul>"},{"location":"free_trading_bots/#crypto-exchange","title":"Crypto Exchange","text":"<ul> <li>First and formost you need to make sure you have at least 100 dollars of USDT ... if you don't have that then you can go to gemini or coinbase to buy some crypto like USDT or ETH or something and then switch it over to USDT on an exchange like phemex. If you really have no idea then contact me in discord and I can try to help you.</li> <li>you also need to do a quick trade on BTCUSDT just market in for the smallest amount possible and market out. The bot needs to see a recent pnl to work properly</li> <li>You need to have an account on one of the following exchanges because the bots only work on those exchanges for now. If you don't have one of these accounts then use the links below to sign up.<ul> <li>Mufex</li> <li>Bybit</li> </ul> </li> </ul>"},{"location":"free_trading_bots/#my-prefered-exchange-is-mufex","title":"My Prefered Exchange Is Mufex","text":"<ul> <li>Mufex is a DEX (Decentrilized Exchange) and requires no KYC and has no country restrictions</li> <li>If you already have a mufex account then send me your UID. If you don't have one keep reading</li> <li>In order to use this exchange you will need to sign up using your e-mail address so that way you can create your api key.</li> <li>After you have signed up you will need to connect your meta mask wallet</li> </ul>"},{"location":"free_trading_bots/#meta-mask","title":"Meta Mask","text":"<ul> <li>Meta Mask is an Etherum wallet where you can store all of your crypto yourself.</li> <li>Pleaes Follow this youtube video to setup your meta mask wallet. Click Here</li> <li>Once you have setup your wallet you will need to connect it to mufex. Just click on the wallet in the upper right and sign the connection in meta mask.</li> <li>Once it is connected you will need to do the following<ul> <li>Add BNB Chain and switch to BNB chain.</li> <li>Send yourself some USDT. * I highly highly highly suggest only sending 2 or 3 dollars the first time to make sure you actually did it right, then send yourself the rest.</li> <li>Import USDT as a coin</li> <li>Here is a video tutorial</li> </ul> </li> <li>Now that you have some USDT you need to get some BNB.</li> <li>I normally get BNB by sending myself 5 USDT to my phemex account and then spot buy some BNB then send the BNB from phemex to my metamask wallet via the bsc20 / BNB Chain.</li> <li>If you don't have access to a crypto account with BNB or any other account then sign up to phemex using this link because as of right now phemex has no country restrictions ... then do what i said in the previous point. If you already have some other account then get the bnb then send it to your meta mask wallet.</li> <li>Now that you have some USDT and some BNB you need to deposit to your mufex account.</li> </ul>"},{"location":"free_trading_bots/#deposit-to-mufex","title":"Deposit to Mufex","text":"<ul> <li>Hover your mouse over your mufex wallet in the upper right corenr and click on deposit. </li> <li>Now select USDT as your token then select bnb smart chain and then copy the address </li> <li>Go back to meta mask and make sure you are on the bnb chain and click send </li> <li>Then you put in the address you copied from mufex </li> <li>Select the asset as usdt, then choose your amount * I highly highly highly suggest choosing 3 dollars just to make sure it works. Then send the rest after you have confirmed it works. </li> <li>After you have picked the amount you want you click next and then confirm and the transfer will happen shortly</li> <li>To make sure it worked you hover over your wallet in the upper right corner and then click on assets and then you should see how much usdt you have </li> </ul>"},{"location":"free_trading_bots/#mufex-api","title":"Mufex API","text":"<ul> <li>Hover your mouse over your wallet and then click api managment and setup your 2 factor authentication </li> <li>Give your api a name and select reading and trading and you don't need to put anything in the ip address and click save</li> <li>Now send your code to your email and put in your 2FA</li> <li>Make sure you copy and paste your api keys somewhere because you can't see it again</li> </ul>"},{"location":"free_trading_bots/#bybit","title":"Bybit","text":"<ul> <li>Bybit is a CEX (Centrilized Exchange) and requires KYC (Know Your Customer) and has country restrictions</li> <li>You will need to make sure your bybit account is a unified account. You can follow this guide to upgrade</li> <li>Now that your account is unified you need to create your api key.</li> </ul>"},{"location":"free_trading_bots/#bybit-api","title":"Bybit API","text":"<ul> <li>Click on your account profile in the upper right and click on API </li> <li>Now click the orange button in the opper right corner that says create new key, then click on system generated api keys</li> <li>Give your thing a name</li> <li>Then make sure you have read write checked</li> <li>Make sure no ip restrictions is checked</li> <li>click the check box next to unified trading then click submit at the bottom </li> <li>after you have confirmed your 2FA then make sure you copy the api and secret key and keep it saved because you wont be able to see it again unless you make another api key</li> </ul> <p>once you have done all of this then put the following info in the bot sign up channel Click here</p>"},{"location":"free_trading_bots/#aws-and-github","title":"AWS and Github","text":"<ul> <li>If you don't have one Create a github account</li> <li>You will need to sign up to the EC2 Free Tier</li> <li>Make sure you have a working credit card and finish the whole sign up process before you continue.</li> </ul>"},{"location":"free_trading_bots/#get-access-to-strat","title":"Get Access To Strat","text":"<ul> <li>So at this point you should have everything done and you have the following</li> <li>You have at least 100 dollars in your crpyto exchange account</li> <li>You have a AWS account that is ready to be used</li> <li>You have a github account</li> <li>you have your api keys ready and for bybit users that you have verified your account is unified</li> <li>now you will go to the discord and let me know you got this far in the general chat. Just make sure you @ me</li> <li>Then i will give you access to the bot sign up channel</li> <li>In here you will post the following: A screen shot of you following me on all the social media accounts and a link to your github account.</li> <li>Once you have got confirmation from me I will add you to the free bot runner group and send you the link to the final parts of running the free bot.</li> </ul>"},{"location":"nav_file/","title":"Nav file","text":"<ul> <li>Installation</li> <li>Free Trading Bot</li> <li>Beginners</li> <li>Functions<ul> <li>enums</li> <li>exchanges<ul> <li>apex_exchange<ul> <li>apex</li> </ul> </li> <li>binance_exchange<ul> <li>binance_us</li> <li>binance_usdm</li> </ul> </li> <li>bybit_exchange<ul> <li>bybit</li> </ul> </li> <li>mufex_exchange<ul> <li>mufex</li> </ul> </li> </ul> </li> <li>helper_funcs</li> <li>indicators<ul> <li>tv_indicators</li> </ul> </li> <li>nb_funcs<ul> <li>nb_indicators<ul> <li>nb_indicators</li> </ul> </li> <li>nb_order_handler<ul> <li>nb_increase_position</li> <li>nb_stop_loss</li> </ul> </li> <li>nb_simulate<ul> <li>nb_sim_base</li> <li>nb_sim_df</li> </ul> </li> <li>nb_strategies<ul> <li>nb_strategy</li> </ul> </li> </ul> </li> <li>order_handler<ul> <li>increase_position</li> <li>order</li> <li>stop_loss</li> </ul> </li> <li>simulate</li> <li>utils</li> </ul> </li> </ul>"},{"location":"quantfreedom/enums/","title":"enums","text":""},{"location":"quantfreedom/enums/#quantfreedom.enums-classes","title":"Classes","text":""},{"location":"quantfreedom/enums/#quantfreedom.enums.BacktestSettings","title":"BacktestSettings","text":"<p>             Bases: <code>NamedTuple</code></p> <p>Settings for filtering the results of your backtest. The main purpose of this is to save on memory and also there is sometimes no point in wanting to see strategies that are negative gains or below a specific qf score because they are useless.</p> <p>Parameters:</p> Name Type Description Default <code>gains_pct_filter</code> <code>float = -np.inf</code> <p>Will not record any strategies whos gains % result is below gains_pct_filter</p> required <code>qf_filter</code> <code>float = -np.inf</code> <p>Will not record any strategies whos qf score result is below the qf filter. qf_score is between -1 to 1,</p> required <code>total_trade_filter</code> <code>int = -1</code> <p>Will not record any strategies whos total trades result is below total trades filter.</p> required <code>record_size</code> <code>int = 10000</code> <p>The amount of records you want to to save. Keep this number as low as possible to save memory.</p> required"},{"location":"quantfreedom/enums/#quantfreedom.enums.IncreasePositionTypeT","title":"IncreasePositionTypeT","text":"<p>             Bases: <code>NamedTuple</code></p> <p>The different ways you can increase your position</p> <p>Parameters:</p> Name Type Description Default <code>AmountEntrySize</code> <code>int= 0</code> <p>How much you want your position size to be per trade in USDT</p> required <code>PctAccountEntrySize</code> <code>int = 1</code> <p>If you have an equity of 1000 and you want your pct account entry size to be 1% then that means each trade will be a position size of 10 usdt</p> required <code>RiskAmountEntrySize</code> <code>int = 2</code> <p>How much you will risk per trade. You must have a stop loss in order to use this mode.</p> required <code>RiskPctAccountEntrySize</code> <code>int = 3</code> <p>How much of your account you want to risk per trade. If you have an equtiy of 1000 and you want to risk 1% then each trade would be risking $10. You must have a stop loss in order to use this mode</p> required <code>SmalletEntrySizeAsset</code> <code>int = 4</code> <p>What ever the exchange smallest asset size is that is what your position size will be for each trade. Let's say the smallest is .001 for btcusdt, then each trade will be worth .001 btc</p> required"},{"location":"quantfreedom/enums/#quantfreedom.enums.LeverageStrategyTypeT","title":"LeverageStrategyTypeT","text":"<p>             Bases: <code>NamedTuple</code></p> <p>Choosing which leverage strategy you would like to use.</p> <p>Parameters:</p> Name Type Description Default <code>Dynamic</code> <code>int = 0</code> <p>This will automatically adjust your leverage to be .001 percent further than your stop loss. The reason behind this is to that it will keep your used cash amount down as much as possible so you can place more trades on the same or other assets.</p> required <code>Static</code> <code>int = 1</code> <p>Static leverage</p> required"},{"location":"quantfreedom/enums/#quantfreedom.enums.TakeProfitStrategyTypeT","title":"TakeProfitStrategyTypeT","text":"<p>             Bases: <code>NamedTuple</code></p> <p>How you want to process the take profit</p> <p>Parameters:</p> Name Type Description Default <code>RiskReward</code> <code>int = 0</code> <p>Risk to reward</p> required <code>Provided</code> <code>int = 1</code> <p>Your strategy will provide the exit prices</p> required <code>Nothing</code> <code>int = 2</code> <p>No take profits.</p> required"},{"location":"quantfreedom/helper_funcs/","title":"helper_funcs","text":""},{"location":"quantfreedom/helper_funcs/#quantfreedom.helper_funcs-classes","title":"Classes","text":""},{"location":"quantfreedom/helper_funcs/#quantfreedom.helper_funcs-functions","title":"Functions","text":""},{"location":"quantfreedom/helper_funcs/#quantfreedom.helper_funcs.candles_to_df","title":"candles_to_df","text":"<pre><code>candles_to_df(\n    candles,\n)\n</code></pre> <p>Converts your numpy array candles to a pandas dataframe</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p> required <p>Returns:</p> Type Description <code>DataFrame</code> <p>columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\" with an index of pandas datetimes</p>"},{"location":"quantfreedom/helper_funcs/#quantfreedom.helper_funcs.dl_ex_candles","title":"dl_ex_candles","text":"<pre><code>dl_ex_candles(\n    symbol,\n    exchange,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=None,\n)\n</code></pre> <p>Download candles from the exchange of your choice</p> <p>Parameters:</p> Name Type Description Default <code>exchange</code> <code>str</code> <p>binance us = 'binance_us' | default candles to dl is 1500</p> <p>binance futures = 'binance_usdm' | default candles to dl is 1500</p> <p>apex = 'apex' | default candles to dl is 200</p> <p>mufex = 'mufex' | default candles to dl is 1500</p> <p>bybit = 'bybit' | default candles to dl is 1000</p> required <code>symbol</code> <code>str</code> <p>Check the api of the exchange or get all the symbols of the exchange to see which ones you need to put here</p> required <code>timeframe</code> <code>str</code> <pre><code>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"\n</code></pre> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>None</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/simulate/","title":"simulate","text":""},{"location":"quantfreedom/simulate/#quantfreedom.simulate-classes","title":"Classes","text":""},{"location":"quantfreedom/simulate/#quantfreedom.simulate-functions","title":"Functions","text":""},{"location":"quantfreedom/utils/","title":"utils","text":""},{"location":"quantfreedom/utils/#quantfreedom.utils-functions","title":"Functions","text":""},{"location":"quantfreedom/utils/#quantfreedom.utils.clear_cache","title":"clear_cache","text":"<pre><code>clear_cache()\n</code></pre> <p>clears the python cache and numba cache</p>"},{"location":"quantfreedom/utils/#quantfreedom.utils.delete_dir","title":"delete_dir","text":"<pre><code>delete_dir(\n    p,\n)\n</code></pre> <p>Delete info in directory</p> <p>Parameters:</p> Name Type Description Default <code>p</code> <code>path</code> <p>path to directory</p> required"},{"location":"quantfreedom/utils/#quantfreedom.utils.generate_candles","title":"generate_candles","text":"<pre><code>generate_candles(\n    number_of_candles=100,\n    plot_candles=False,\n    seed=None,\n)\n</code></pre> <p>Generate a dataframe filled with random candles</p> <p>Parameters:</p> Name Type Description Default <code>number_of_candles</code> <code>(int, 100)</code> <p>number of candles you want to create</p> <code>100</code> <code>seed</code> <code>(int, None)</code> <p>random seed number</p> <code>None</code> <code>plot_candles</code> <code>(bool, False)</code> <p>If the candles should be graphed or not.</p> <code>False</code> <p>Returns:</p> Type Description <code>pdFrame</code> <p>Dataframe of open high low close</p>"},{"location":"quantfreedom/utils/#quantfreedom.utils.pretty_qf","title":"pretty_qf","text":"<pre><code>pretty_qf(\n    named_tuple,\n)\n</code></pre> <p>Prints named tuples in a pretty way</p> <p>Parameters:</p> Name Type Description Default <code>named_tuple</code> <code>namedtuple</code> <p>must only be a named tuple</p> required"},{"location":"quantfreedom/exchanges/apex_exchange/apex/","title":"apex","text":""},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex","title":"Apex","text":"<p>             Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.__init__","title":"__init__","text":"<pre><code>__init__(\n    use_test_net,\n    api_key=None,\n    secret_key=None,\n    passphrase=None,\n    stark_key_public=None,\n    stark_key_private=None,\n    stark_key_y=None,\n)\n</code></pre> <p>main docs page https://api-docs.pro.apex.exchange</p>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.create_order","title":"create_order","text":"<pre><code>create_order(\n    symbol,\n    buy_sell,\n    order_type,\n    asset_size,\n    limitFeeRate=None,\n    limitFee=None,\n    price=None,\n    accountId=None,\n    time_in_force=\"GOOD_TIL_CANCEL\",\n    reduceOnly=False,\n    triggerPrice=None,\n    triggerPriceType=None,\n    trailingPercent=None,\n    clientId=None,\n    expiration=None,\n    isPositionTpsl=False,\n    signature=None,\n    sourceFlag=None,\n)\n</code></pre> <p>Apex API for Creating Orders</p>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.get_candles","title":"get_candles","text":"<pre><code>get_candles(\n    symbol,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=200,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.get_candles--summary","title":"Summary","text":"<p>Apex candle docs</p>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.get_candles--explainer-video","title":"Explainer Video","text":"<p>Coming Soon but if you want/need it now please let me know in discord or telegram and i will make it for you</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Use APEX API for symbol list</p> required <code>timeframe</code> <code>str</code> <p>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"</p> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>200</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.set_leverage","title":"set_leverage","text":"<pre><code>set_leverage(\n    symbol,\n    leverage,\n)\n</code></pre> <p>Apex API for initial margin rate of a contract</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/","title":"binance_us","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us.BinanceUS","title":"BinanceUS","text":"<p>             Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us.BinanceUS-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us.BinanceUS.get_candles","title":"get_candles","text":"<pre><code>get_candles(\n    symbol,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=1500,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us.BinanceUS.get_candles--summary","title":"Summary","text":"<p>Biance US candle docs</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us.BinanceUS.get_candles--explainer-video","title":"Explainer Video","text":"<p>Coming Soon but if you want/need it now please let me know in discord or telegram and i will make it for you</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Use Binance US API for symbol list</p> required <code>timeframe</code> <code>str</code> <p>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"</p> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>1500</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/","title":"binance_usdm","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM","title":"BinanceUSDM","text":"<p>             Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.__init__","title":"__init__","text":"<pre><code>__init__(\n    use_test_net,\n    api_key=None,\n    secret_key=None,\n)\n</code></pre> <p>main docs page</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.create_order","title":"create_order","text":"<pre><code>create_order(\n    symbol,\n    side,\n    type,\n    quantity=None,\n    positionSide=None,\n    timeInForce=\"GTC\",\n    reduceOnly=None,\n    price=None,\n    newClientOrderId=None,\n    stopPrice=None,\n    closePosition=None,\n    activationPrice=None,\n    callbackRate=None,\n    workingType=None,\n    priceProtect=None,\n    newOrderRespType=None,\n    priceMatch=None,\n    selfTradePreventionMode=None,\n    goodTillDate=None,\n    recvWindow=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_all_symbols_info","title":"get_all_symbols_info","text":"<pre><code>get_all_symbols_info()\n</code></pre> <p>Binance Exchange Information</p> <p>Parameters:</p> Name Type Description Default <code>None</code> required <p>Returns:</p> Type Description <code>Dictionary</code> <p>dictionary of info about the symbols</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_candles","title":"get_candles","text":"<pre><code>get_candles(\n    symbol,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=1500,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_candles--summary","title":"Summary","text":"<p>Biance USDM candle docs</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_candles--explainer-video","title":"Explainer Video","text":"<p>Coming Soon but if you want/need it now please let me know in discord or telegram and i will make it for you</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Use Binance USDM API for symbol list</p> required <code>timeframe</code> <code>str</code> <p>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"</p> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>1500</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_exchange_info","title":"get_exchange_info","text":"<pre><code>get_exchange_info()\n</code></pre> <p>Binance Exchange Information</p> <p>Parameters:</p> Name Type Description Default <code>None</code> required <p>Returns:</p> Type Description <code>Dictionary</code> <p>dictionary of info about the exchange</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_symbols_list","title":"get_symbols_list","text":"<pre><code>get_symbols_list()\n</code></pre> <p>Binance Exchange Information</p> <p>Parameters:</p> Name Type Description Default <code>None</code> required <p>Returns:</p> Type Description <code>List</code> <p>List of exchange symbols</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/","title":"bybit","text":""},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit","title":"Bybit","text":"<p>             Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.__init__","title":"__init__","text":"<pre><code>__init__(\n    use_test_net,\n    api_key=None,\n    secret_key=None,\n)\n</code></pre> <p>main docs page https://bybit-exchange.github.io/docs/v5/intro upgrade to unified account</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.adjust_order","title":"adjust_order","text":"<pre><code>adjust_order(\n    symbol,\n    asset_size=None,\n    category=\"linear\",\n    custom_order_id=None,\n    orderIv=None,\n    order_id=None,\n    price=None,\n    slLimitPrice=None,\n    slTriggerBy=None,\n    stopLoss=None,\n    takeProfit=None,\n    tpLimitPrice=None,\n    tpslMode=None,\n    tpTriggerBy=None,\n    triggerBy=None,\n    triggerPrice=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.cancel_all_open_orders","title":"cancel_all_open_orders","text":"<pre><code>cancel_all_open_orders(\n    symbol=None,\n    category=\"linear\",\n    baseCoin=None,\n    settleCoin=None,\n    orderFilter=None,\n    stopOrderType=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.create_order","title":"create_order","text":"<pre><code>create_order(\n    symbol,\n    buy_sell,\n    position_mode,\n    order_type,\n    asset_size,\n    category=\"linear\",\n    time_in_force=\"GTC\",\n    price=None,\n    triggerDirection=None,\n    triggerPrice=None,\n    triggerBy=None,\n    tpTriggerBy=None,\n    slTriggerBy=None,\n    custom_order_id=None,\n    takeProfit=None,\n    stopLoss=None,\n    reduce_only=None,\n    closeOnTrigger=None,\n    isLeverage=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_all_symbols_info","title":"get_all_symbols_info","text":"<pre><code>get_all_symbols_info(\n    category=\"linear\",\n    limit=500,\n    symbol=None,\n    status=None,\n    baseCoin=None,\n)\n</code></pre> <p>Bybit API link to Get Instrument Info</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_candles","title":"get_candles","text":"<pre><code>get_candles(\n    symbol,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=1000,\n    category=\"linear\",\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_candles--summary","title":"Summary","text":"<p>Bybit candle docs</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_candles--explainer-video","title":"Explainer Video","text":"<p>Coming Soon but if you want/need it now please let me know in discord or telegram and i will make it for you</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Use Bybit API for symbol list</p> required <code>timeframe</code> <code>str</code> <p>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"</p> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>1000</code> <code>category</code> <code>str</code> <p>Bybit categories link</p> <code>'linear'</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_closed_pnl","title":"get_closed_pnl","text":"<pre><code>get_closed_pnl(\n    symbol,\n    limit=50,\n    since_datetime=None,\n    until_datetime=None,\n    category=\"linear\",\n)\n</code></pre> <p>Bybit API link to Get Closed Profit and Loss</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_open_orders","title":"get_open_orders","text":"<pre><code>get_open_orders(\n    baseCoin=None,\n    category=\"linear\",\n    custom_order_id=None,\n    limit=50,\n    orderFilter=None,\n    orderStatus=None,\n    order_id=None,\n    settleCoin=None,\n    since_datetime=None,\n    symbol=None,\n    until_datetime=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_order_history","title":"get_order_history","text":"<pre><code>get_order_history(\n    baseCoin=None,\n    category=\"linear\",\n    custom_order_id=None,\n    limit=50,\n    orderFilter=None,\n    orderStatus=None,\n    order_id=None,\n    settleCoin=None,\n    since_datetime=None,\n    symbol=None,\n    until_datetime=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_position_info","title":"get_position_info","text":"<pre><code>get_position_info(\n    symbol,\n    baseCoin=None,\n    category=\"linear\",\n    limit=50,\n    settleCoin=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_risk_limit_info","title":"get_risk_limit_info","text":"<pre><code>get_risk_limit_info(\n    symbol,\n    category=\"linear\",\n)\n</code></pre> <p>Bybit API link to Get Risk Limit</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_symbols_list","title":"get_symbols_list","text":"<pre><code>get_symbols_list()\n</code></pre> <p>Returns a list of the symbols in alphabetical order</p> <p>Parameters:</p> Name Type Description Default <code>None</code> required <p>Returns:</p> Type Description <code>list</code> <p>symbols</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_trading_fee_rates","title":"get_trading_fee_rates","text":"<pre><code>get_trading_fee_rates(\n    symbol=None,\n    baseCoin=None,\n    category=\"linear\",\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_wallet_info","title":"get_wallet_info","text":"<pre><code>get_wallet_info(\n    accountType=\"UNIFIED\",\n    trading_with=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.set_leverage","title":"set_leverage","text":"<pre><code>set_leverage(\n    symbol,\n    leverage,\n    category=\"linear\",\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.set_leverage_mode","title":"set_leverage_mode","text":"<pre><code>set_leverage_mode(\n    setMarginMode=\"ISOLATED_MARGIN\",\n)\n</code></pre> <p>ISOLATED_MARGIN, REGULAR_MARGIN(i.e. Cross margin), PORTFOLIO_MARGIN</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.set_position_mode","title":"set_position_mode","text":"<pre><code>set_position_mode(\n    position_mode,\n    symbol,\n    category=\"linear\",\n    trading_with=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/","title":"mufex","text":""},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex","title":"Mufex","text":"<p>             Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.__init__","title":"__init__","text":"<pre><code>__init__(\n    use_test_net,\n    api_key=None,\n    secret_key=None,\n)\n</code></pre> <p>main docs page https://www.mufex.finance/apidocs/derivatives/contract/index.html</p> <p>Make sure you have your position mode set to hedge or else a lot of functions will not work. https://www.mufex.finance/apidocs/derivatives/contract/index.html?console#t-dv_switchpositionmode</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.adjust_order","title":"adjust_order","text":"<pre><code>adjust_order(\n    params={},\n)\n</code></pre> <p>you basically have to use the same info that you would for create order https://www.mufex.finance/apidocs/derivatives/contract/index.html#t-dv_placeorder</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.cancel_all_open_orders_per_symbol","title":"cancel_all_open_orders_per_symbol","text":"<pre><code>cancel_all_open_orders_per_symbol(\n    symbol,\n)\n</code></pre> <p>no link yet</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.cancel_open_order","title":"cancel_open_order","text":"<pre><code>cancel_open_order(\n    symbol,\n    order_id=None,\n    custom_order_id=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.create_order","title":"create_order","text":"<pre><code>create_order(\n    symbol,\n    buy_sell,\n    position_mode,\n    order_type,\n    asset_size,\n    time_in_force=\"GoodTillCancel\",\n    price=None,\n    triggerDirection=None,\n    triggerPrice=None,\n    triggerBy=None,\n    tpTriggerBy=None,\n    slTriggerBy=None,\n    custom_order_id=None,\n    takeProfit=None,\n    stopLoss=None,\n    reduce_only=None,\n    closeOnTrigger=None,\n)\n</code></pre> <p>time_in_force:     GoodTillCancel     ImmediateOrCancel     FillOrKill     PostOnly</p> <p>position_mode: used to identify positions in different position modes. Required if you are under Hedge Mode:     0-One-Way Mode     1-Buy side of both side mode     2-Sell side of both side mode</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_all_symbols_info","title":"get_all_symbols_info","text":"<pre><code>get_all_symbols_info(\n    category=\"linear\",\n    limit=1000,\n    symbol=None,\n)\n</code></pre> <p>Mufex API link to Get Instrument Info</p> <p>Parameters:</p> Name Type Description Default <code>category</code> <code>str</code> <p>If category is not passed, then return \"\"For now, default:linear</p> <code>'linear'</code> <code>limit</code> <code>int</code> <p>Limit for data size per page, max size is 1000. Default as showing 500 pieces of data per page.It's not sorted by time</p> <code>1000</code> <code>symbol</code> <code>str</code> <p>Symbol</p> <code>None</code> <p>Returns:</p> Type Description <code>_type_</code> <p>description</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_candles","title":"get_candles","text":"<pre><code>get_candles(\n    symbol,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=1500,\n    category=\"linear\",\n)\n</code></pre> <p>mufex candle docs</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Mufex Symbol List</p> required <code>timeframe</code> <code>str</code> <p>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"</p> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>1500</code> <code>category</code> <code>str</code> <p>mufex categories link</p> <code>'linear'</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_closed_pnl","title":"get_closed_pnl","text":"<pre><code>get_closed_pnl(\n    symbol,\n    limit=200,\n    since_datetime=None,\n    until_datetime=None,\n)\n</code></pre> <p>Mufex API link to Get Closed Profit and Loss</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_filled_orders","title":"get_filled_orders","text":"<pre><code>get_filled_orders(\n    symbol,\n    limit=200,\n    since_datetime=None,\n    until_datetime=None,\n    execType=None,\n    order_id=None,\n)\n</code></pre> <p>Get user's trading records. The results are ordered in descending order (the first item is the latest). Returns records up to 2 years old.</p> <p>use link to see all Request Parameters</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_open_orders","title":"get_open_orders","text":"<pre><code>get_open_orders(\n    symbol,\n    limit=50,\n    order_id=None,\n    custom_order_id=None,\n    orderFilter=None,\n)\n</code></pre> <p>Query real-time order information. If only orderId or orderLinkId are passed, a single order will be returned; otherwise, returns up to 500 unfilled orders</p> <p>orderId limit</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_order_history","title":"get_order_history","text":"<pre><code>get_order_history(\n    symbol,\n    limit=50,\n    order_id=None,\n    custom_order_id=None,\n    orderStatus=None,\n    orderFilter=None,\n)\n</code></pre> <p>use link to see all Request Parameters</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_position_info","title":"get_position_info","text":"<pre><code>get_position_info(\n    symbol=None,\n    settleCoin=None,\n    limit=50,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_risk_limit_info","title":"get_risk_limit_info","text":"<pre><code>get_risk_limit_info(\n    symbol,\n    category=\"linear\",\n)\n</code></pre> <p>Mufex API link to Get Risk Limit</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Symbol</p> required <code>category</code> <code>str</code> <p>If category is not passed, then return \"\"For now, default:linear</p> <code>'linear'</code> <p>Returns:</p> Type Description <code>_type_</code> <p>description</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_symbol_trading_fee_rates","title":"get_symbol_trading_fee_rates","text":"<pre><code>get_symbol_trading_fee_rates(\n    symbol=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_symbols_list","title":"get_symbols_list","text":"<pre><code>get_symbols_list()\n</code></pre> <p>Returns a list of the symbols in alphabetical order</p> <p>Parameters:</p> Name Type Description Default <code>None</code> required <p>Returns:</p> Type Description <code>list</code> <p>symbols</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_trading_fee_rates","title":"get_trading_fee_rates","text":"<pre><code>get_trading_fee_rates(\n    symbol=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_wallet_info","title":"get_wallet_info","text":"<pre><code>get_wallet_info(\n    trading_with=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.set_leverage","title":"set_leverage","text":"<pre><code>set_leverage(\n    symbol,\n    leverage,\n)\n</code></pre> <p>No link yet</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.set_leverage_mode","title":"set_leverage_mode","text":"<pre><code>set_leverage_mode(\n    symbol,\n    leverage_mode,\n    leverage=5,\n)\n</code></pre> <p>Cross/isolated mode. 0: cross margin mode; 1: isolated margin mode</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.set_position_mode","title":"set_position_mode","text":"<pre><code>set_position_mode(\n    position_mode,\n    trading_with=None,\n    symbol=None,\n)\n</code></pre>"},{"location":"quantfreedom/indicators/tv_indicators/","title":"tv_indicators","text":""},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators-functions","title":"Functions","text":""},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.atr_tv","title":"atr_tv","text":"<pre><code>atr_tv(\n    candles,\n    length,\n    smoothing_type=rma_tv,\n)\n</code></pre> <p>Average true range smoothing from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <code>smoothing_type</code> <code>Callable</code> <p>function to process the smoothing of the atr</p> <code>rma_tv</code> <p>Returns:</p> Type Description <code>array</code> <p>atr</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.bb_tv","title":"bb_tv","text":"<pre><code>bb_tv(\n    length,\n    multi,\n    source,\n    basis_ma_type=sma_tv,\n)\n</code></pre> <p>Bollinger bands from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <code>multi</code> <code>float</code> <p>Standard deviation factor</p> required <code>basis_ma_type</code> <code>Callable</code> <p>Function to process basic ma</p> <code>sma_tv</code> <p>Returns:</p> Type Description <code>tuple[array, array, array]</code> <p>basis, upper, lower</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.donchain_channels_tv","title":"donchain_channels_tv","text":"<pre><code>donchain_channels_tv(\n    candles,\n    length,\n)\n</code></pre> <p>Donchain channels</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <code>length</code> <code>int</code> <p>Number of bars of donchain lookback</p> required <p>Returns:</p> Type Description <code>tuple[array, array, array]</code> <p>upper, basis, lower</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.ema_tv","title":"ema_tv","text":"<pre><code>ema_tv(\n    source,\n    length,\n)\n</code></pre> <p>Exponential Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>ema</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.linear_regression_candles_ugurvu_tv","title":"linear_regression_candles_ugurvu_tv","text":"<pre><code>linear_regression_candles_ugurvu_tv(\n    candles,\n    lin_reg_length,\n    smoothing_length,\n    smoothing_type=sma_tv,\n)\n</code></pre> <p>Linear regression indicator</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <code>lin_reg_length</code> <code>int</code> <p>Number of bars for lin reg</p> required <code>smoothing_length</code> <code>int</code> <p>Number of bars for singal line</p> required <code>smoothing_type</code> <code>Callable</code> <p>function to process the smoothing of the singal line</p> <code>sma_tv</code> <p>Returns:</p> Type Description <code>tuple[array, array]</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume], signal</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.macd_tv","title":"macd_tv","text":"<pre><code>macd_tv(\n    source,\n    fast_length,\n    slow_length,\n    signal_smoothing,\n    oscillator_type=ema_tv,\n    signal_ma_type=ema_tv,\n)\n</code></pre> <p>Moving average convergence divergence from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>fast_length</code> <code>int</code> <p>Number of bars</p> required <code>slow_length</code> <code>int</code> <p>Number of bars</p> required <code>signal_smoothing</code> <code>int</code> <p>Number of bars</p> required <code>oscillator_type</code> <code>Callable</code> <p>Function to process fast and slow ma</p> <code>ema_tv</code> <code>signal_ma_type</code> <code>Callable</code> <p>Function to process signal ma</p> <code>ema_tv</code> <p>Returns:</p> Type Description <code>(array, array, array)</code> <p>histogram, macd, signal</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.rma_tv","title":"rma_tv","text":"<pre><code>rma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Relative strength index Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>rma</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.rma_tv_2","title":"rma_tv_2","text":"<pre><code>rma_tv_2(\n    source_1,\n    source_2,\n    length,\n)\n</code></pre> <p>Relative strength index Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source_1</code> <code>array</code> <p>Values to process</p> required <code>source_2</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>rma_1, rma_2</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.rsi_tv","title":"rsi_tv","text":"<pre><code>rsi_tv(\n    length,\n    source,\n)\n</code></pre> <p>Relative strength index</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>rsi</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.sma_tv","title":"sma_tv","text":"<pre><code>sma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Simple Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>sma</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.squeeze_momentum_lazybear_tv","title":"squeeze_momentum_lazybear_tv","text":"<pre><code>squeeze_momentum_lazybear_tv(\n    candles,\n    length_bb,\n    length_kc,\n    multi_bb,\n    multi_kc,\n)\n</code></pre> <p>LazyBear Pinescript</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <code>length_bb</code> <code>int</code> <p>Number of bars of Bollinger Bands</p> required <code>length_kc</code> <code>int</code> <p>Number of bars of KC</p> required <code>multi_bb</code> <code>int</code> <p>The multiplier by which the Bollinger Bands will get multiplied</p> required <code>multi_kc</code> <code>int</code> <p>The multiplier by which the KC will get multiplied</p> required <p>Returns:</p> Type Description <code>tuple[array, array, array]</code> <p>squeeze historgram, squeeze on, no squeeze</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.stdev_tv","title":"stdev_tv","text":"<pre><code>stdev_tv(\n    source,\n    length,\n)\n</code></pre> <p>Standard deviation from tradingview</p> <p>Explainer Video</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>stdev</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.supertrend_tv","title":"supertrend_tv","text":"<pre><code>supertrend_tv(\n    candles,\n    atr_length,\n    factor,\n)\n</code></pre> <p>Super Trend</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <code>atr_length</code> <code>int</code> <p>Number of bars</p> required <code>factor</code> <code>int</code> <p>The multiplier by which the ATR will get multiplied</p> required <p>Returns:</p> Type Description <code>tuple[array, array]</code> <p>super_trend, direction</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.true_range_tv","title":"true_range_tv","text":"<pre><code>true_range_tv(\n    candles,\n)\n</code></pre> <p>True Range from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <p>Returns:</p> Type Description <code>array</code> <p>true_range</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.vwap_tv","title":"vwap_tv","text":"<pre><code>vwap_tv(\n    candles,\n)\n</code></pre> <p>Volume Weighted Average Price</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <p>Returns:</p> Type Description <code>array</code> <p>vwap</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.wma_tv","title":"wma_tv","text":"<pre><code>wma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Weighted Moving Average From Tradingview</p> <p>Explainer Video</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>wma</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/","title":"nb_indicators","text":""},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators-functions","title":"Functions","text":""},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_atr_tv","title":"nb_atr_tv","text":"<pre><code>nb_atr_tv(\n    candles,\n    length,\n    smoothing_type=nb_rma_tv,\n)\n</code></pre> <p>Average true range smoothing https://www.tradingview.com/pine-script-reference/v5/#fun_ta.atr</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_bb_tv","title":"nb_bb_tv","text":"<pre><code>nb_bb_tv(\n    source,\n    length,\n    multi,\n    basis_ma_type=nb_sma_tv,\n)\n</code></pre> <p>returns basis, upper, lower</p> <p>Bollinger bands https://www.tradingview.com/pine-script-reference/v5/#fun_ta.bb</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_ema_tv","title":"nb_ema_tv","text":"<pre><code>nb_ema_tv(\n    source,\n    length,\n)\n</code></pre> <p>Exponential Moving average https://www.tradingview.com/pine-script-reference/v5/#fun_ta.ema</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_macd_tv","title":"nb_macd_tv","text":"<pre><code>nb_macd_tv(\n    source,\n    fast_length,\n    slow_length,\n    signal_smoothing,\n    oscillator_type=nb_ema_tv,\n    signal_ma_type=nb_ema_tv,\n)\n</code></pre> <p>return order = histogram, macd, signal Moving average convergence divergence https://www.tradingview.com/pine-script-reference/v5/#fun_ta.macd</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_rma_tv","title":"nb_rma_tv","text":"<pre><code>nb_rma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Relative strength index Moving average https://www.tradingview.com/pine-script-reference/v5/#fun_ta.rma</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_rma_tv_2","title":"nb_rma_tv_2","text":"<pre><code>nb_rma_tv_2(\n    source_1,\n    source_2,\n    length,\n)\n</code></pre> <p>Relative strength index Moving average https://www.tradingview.com/pine-script-reference/v5/#fun_ta.rma</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_rsi_tv","title":"nb_rsi_tv","text":"<pre><code>nb_rsi_tv(\n    source,\n    length,\n)\n</code></pre> <p>Relative strength index https://www.tradingview.com/pine-script-reference/v5/#fun_ta.rsi</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_sma_tv","title":"nb_sma_tv","text":"<pre><code>nb_sma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Simple Moving average https://www.tradingview.com/pine-script-reference/v5/#fun_ta.sma</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_squeeze_momentum_lazybear_tv","title":"nb_squeeze_momentum_lazybear_tv","text":"<pre><code>nb_squeeze_momentum_lazybear_tv(\n    candles,\n    length_bb,\n    length_kc,\n    multi_bb,\n    multi_kc,\n)\n</code></pre> <p>Returns = sqz_hist, sqz_on, no_sqz</p> <p>https://www.tradingview.com/script/nqQ1DT5a-Squeeze-Momentum-Indicator-LazyBear/</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_stdev_tv","title":"nb_stdev_tv","text":"<pre><code>nb_stdev_tv(\n    source,\n    length,\n)\n</code></pre> <p>Standard deviation https://www.tradingview.com/pine-script-reference/v5/#fun_ta.stdev</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_supertrend_tv","title":"nb_supertrend_tv","text":"<pre><code>nb_supertrend_tv(\n    candles,\n    atr_length,\n    factor,\n)\n</code></pre> <p>return super trend, direction Super Trend https://www.tradingview.com/pine-script-reference/v5/#fun_ta.supertrend</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_true_range_tv","title":"nb_true_range_tv","text":"<pre><code>nb_true_range_tv(\n    candles,\n)\n</code></pre>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_vwap_tv","title":"nb_vwap_tv","text":"<pre><code>nb_vwap_tv(\n    candles,\n)\n</code></pre>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_wma_tv","title":"nb_wma_tv","text":"<pre><code>nb_wma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Weighted Moving average https://www.tradingview.com/pine-script-reference/v5/#fun_ta.wma</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/","title":"nb_increase_position","text":""},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position-functions","title":"Functions","text":""},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position.nb_c_pl_ra_ps","title":"nb_c_pl_ra_ps","text":"<pre><code>nb_c_pl_ra_ps(\n    equity,\n    logger,\n    max_equity_risk_pct,\n    possible_loss,\n    risk_account_pct_size,\n    total_trades,\n)\n</code></pre> <p>Possible loss risk account percent size</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position.nb_c_too_b_s","title":"nb_c_too_b_s","text":"<pre><code>nb_c_too_b_s(\n    entry_size_asset,\n    logger,\n    max_asset_size,\n    min_asset_size,\n    stringer,\n)\n</code></pre> <p>Check if the asset size is too big or too small</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position.nb_c_total_trades","title":"nb_c_total_trades","text":"<pre><code>nb_c_total_trades(\n    average_entry,\n    logger,\n    market_fee_pct,\n    max_trades,\n    position_size_asset,\n    possible_loss,\n    sl_price,\n    stringer,\n    total_trades,\n)\n</code></pre> <p>Checking the total trades</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position.nb_min_asset_amount","title":"nb_min_asset_amount","text":"<pre><code>nb_min_asset_amount(\n    acc_ex_other,\n    logger,\n    nb_entry_calc_np,\n    nb_entry_calc_p,\n    order_info,\n    stringer,\n)\n</code></pre> <p>Setting your position size to the min amount the exchange will allow</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position.nb_rpa_slbcb","title":"nb_rpa_slbcb","text":"<pre><code>nb_rpa_slbcb(\n    acc_ex_other,\n    logger,\n    nb_entry_calc_np,\n    nb_entry_calc_p,\n    order_info,\n    stringer,\n)\n</code></pre> <p>Risking percent of your account while also having your stop loss based open high low or close of a candle</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/","title":"nb_stop_loss","text":""},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/#quantfreedom.nb_funcs.nb_order_handler.nb_stop_loss-functions","title":"Functions","text":""},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/#quantfreedom.nb_funcs.nb_order_handler.nb_stop_loss.nb_check_move_sl_to_be","title":"nb_check_move_sl_to_be","text":"<pre><code>nb_check_move_sl_to_be(\n    average_entry,\n    can_move_sl_to_be,\n    current_candle,\n    logger,\n    market_fee_pct,\n    nb_move_sl_bool,\n    nb_zero_or_entry_calc,\n    price_tick_step,\n    sl_price,\n    sl_to_be_cb_type,\n    sl_to_be_when_pct,\n    stringer,\n)\n</code></pre> <p>Checking to see if we move the stop loss to break even</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/#quantfreedom.nb_funcs.nb_order_handler.nb_stop_loss.nb_check_move_tsl","title":"nb_check_move_tsl","text":"<pre><code>nb_check_move_tsl(\n    average_entry,\n    current_candle,\n    logger,\n    nb_move_sl_bool,\n    nb_sl_price_calc,\n    price_tick_step,\n    sl_price,\n    stringer,\n    trail_sl_bcb_type,\n    trail_sl_by_pct,\n    trail_sl_when_pct,\n)\n</code></pre> <p>Checking to see if we move the trailing stop loss</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/#quantfreedom.nb_funcs.nb_order_handler.nb_stop_loss.nb_cm_sl_to_be_pass","title":"nb_cm_sl_to_be_pass","text":"<pre><code>nb_cm_sl_to_be_pass(\n    average_entry,\n    can_move_sl_to_be,\n    current_candle,\n    logger,\n    market_fee_pct,\n    nb_move_sl_bool,\n    nb_zero_or_entry_calc,\n    price_tick_step,\n    sl_price,\n    sl_to_be_cb_type,\n    sl_to_be_when_pct,\n    stringer,\n)\n</code></pre> <p>Long stop loss to break even pass</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/#quantfreedom.nb_funcs.nb_order_handler.nb_stop_loss.nb_sl_based_on_candle_body","title":"nb_sl_based_on_candle_body","text":"<pre><code>nb_sl_based_on_candle_body(\n    bar_index,\n    candles,\n    logger,\n    nb_sl_bcb_price_getter,\n    nb_sl_price_calc,\n    price_tick_step,\n    sl_based_on_add_pct,\n    sl_based_on_lookback,\n    sl_bcb_type,\n    stringer,\n)\n</code></pre> <p>Long Stop Loss Based on Candle Body Calculator</p>"},{"location":"quantfreedom/nb_funcs/nb_simulate/nb_sim_base/","title":"nb_sim_base","text":""},{"location":"quantfreedom/nb_funcs/nb_simulate/nb_sim_base/#quantfreedom.nb_funcs.nb_simulate.nb_sim_base-classes","title":"Classes","text":""},{"location":"quantfreedom/nb_funcs/nb_simulate/nb_sim_base/#quantfreedom.nb_funcs.nb_simulate.nb_sim_base-functions","title":"Functions","text":""},{"location":"quantfreedom/nb_funcs/nb_simulate/nb_sim_df/","title":"nb_sim_df","text":""},{"location":"quantfreedom/nb_funcs/nb_simulate/nb_sim_df/#quantfreedom.nb_funcs.nb_simulate.nb_sim_df-classes","title":"Classes","text":""},{"location":"quantfreedom/nb_funcs/nb_strategies/nb_strategy/","title":"nb_strategy","text":""},{"location":"quantfreedom/nb_funcs/nb_strategies/nb_strategy/#quantfreedom.nb_funcs.nb_strategies.nb_strategy-functions","title":"Functions","text":""},{"location":"quantfreedom/order_handler/increase_position/","title":"increase_position","text":""},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position-classes","title":"Classes","text":""},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition","title":"IncreasePosition","text":""},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition-functions","title":"Functions","text":""},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.__init__","title":"__init__","text":"<pre><code>__init__(\n    asset_tick_step,\n    increase_position_type,\n    long_short,\n    market_fee_pct,\n    max_asset_size,\n    min_asset_size,\n    price_tick_step,\n    sl_strategy_type,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.__init__--summary","title":"Summary","text":"<p>Creates and sets the increase position class settings</p> <p>Parameters:</p> Name Type Description Default <code>asset_tick_step</code> <code>float</code> <p>asset_tick_step</p> required <code>increase_position_type</code> <code>IncreasePositionType</code> <p>How you want to process increasing your position</p> required <code>long_short</code> <code>str</code> <p>long or short</p> required <code>market_fee_pct</code> <code>float</code> <p>market_fee_pct</p> required <code>max_asset_size</code> <code>float</code> <p>max_asset_size</p> required <code>min_asset_size</code> <code>float</code> <p>min_asset_size</p> required <code>price_tick_step</code> <code>float</code> <p>price_tick_step</p> required <code>sl_strategy_type</code> <code>StopLossStrategyType</code> <p>how you want to process creating your stop loss</p> required"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_pl_ra_ps","title":"c_pl_ra_ps","text":"<pre><code>c_pl_ra_ps(\n    equity,\n    possible_loss,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_pl_ra_ps--summary","title":"Summary","text":"<p>Creates possible loss then checks if it is bigger than risk account percent size then returns the new possible loss and total trades</p> <p>Parameters:</p> Name Type Description Default <code>equity</code> <code>float</code> <p>equity</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>(int, int)</code> <p>possible_loss, total_trades</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_too_b_s","title":"c_too_b_s","text":"<pre><code>c_too_b_s(\n    entry_size_asset,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_too_b_s--summary","title":"Summary","text":"<p>Check if the asset size is too big or too small</p> <p>Parameters:</p> Name Type Description Default <code>entry_size_asset</code> <code>float</code> <p>entry size of the asset</p> required"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_total_trades","title":"c_total_trades","text":"<pre><code>c_total_trades(\n    average_entry,\n    possible_loss,\n    position_size_asset,\n    sl_price,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_total_trades--summary","title":"Summary","text":"<p>Creates possible loss then adds 1 to total trades then checks if total trades is bigger than max trades</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>position_size_asset</code> <code>float</code> <p>position_size_asset</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>tuple[int, int]</code> <p>possible_loss, total_trades</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.long_entry_size_np","title":"long_entry_size_np","text":"<pre><code>long_entry_size_np(\n    entry_price,\n    possible_loss,\n    sl_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.long_entry_size_np--summary","title":"Summary","text":"<p>Formula to calulcate the long entry size when we are not in a position and have our stop loss type set to stop loss based on candle body</p> <p>how to calculate pnl https://www.bybithelp.com/en-US/s/article/Profit-Loss-calculations-USDT-Contract</p> <p>math for the formula https://www.symbolab.com/solver/simplify-calculator/solve%20for%20u%2C%20%5Cleft(%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%5Cleft(x%20-%20e%5Cright)%5Cright)-%20%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%20e%5Ccdot%20m%5Cright)%20-%20%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%20x%5Ccdot%20m%5Cright)%20%5Cright)%3Dp?or=input</p> <p>Parameters:</p> Name Type Description Default <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>float</code> <p>entry_size_usd</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.long_entry_size_p","title":"long_entry_size_p","text":"<pre><code>long_entry_size_p(\n    average_entry,\n    entry_price,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.long_entry_size_p--summary","title":"Summary","text":"<p>Formula to calulcate the long entry size when we are in a position and have our stop loss type set to stop loss based on candle body</p> <p>how to calculate pnl https://www.bybithelp.com/en-US/s/article/Profit-Loss-calculations-USDT-Contract</p> <p>math for the formula https://www.symbolab.com/solver/simplify-calculator/solve%20for%20u%2C%20%5Cleft(%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%5Cleft(n%20-%20%5Cleft(%5Cfrac%7B%5Cleft(p%2Bu%5Cright)%7D%7B%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%7D%5Cright)%5Cright)%5Cright)-%20%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%5Cleft(%5Cfrac%7B%5Cleft(p%2Bu%5Cright)%7D%7B%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%7D%5Cright)%5Ccdot%20m%5Cright)%20-%20%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%20n%5Ccdot%20m%5Cright)%20%5Cright)%3D-f?or=input</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>float</code> <p>entry_size_usd</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_amount_np","title":"min_amount_np","text":"<pre><code>min_amount_np(\n    entry_price,\n    sl_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_amount_np--summary","title":"Summary","text":"<p>Setting the entry size to the minimum amount</p> <p>Parameters:</p> Name Type Description Default <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>tuple[float, float, float, float, float, float, int, int, float]</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_amount_p","title":"min_amount_p","text":"<pre><code>min_amount_p(\n    average_entry,\n    entry_price,\n    position_size_asset,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_amount_p--summary","title":"Summary","text":"<p>Setting the entry size to the minimum amount plus what ever position size we are already in</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>position_size_asset</code> <code>float</code> <p>position_size_asset</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>tuple[float, float, float, float, float, float, int, int, float]</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_asset_amount","title":"min_asset_amount","text":"<pre><code>min_asset_amount(\n    average_entry,\n    entry_price,\n    equity,\n    position_size_asset,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_asset_amount--summary","title":"Summary","text":"<p>Check if we are in a position or not and sending you to the correct function to handle that</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>equity</code> <code>float</code> <p>equity</p> required <code>position_size_asset</code> <code>float</code> <p>position_size_asset</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>(float, float, float, float, float, float, int, int, float)</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb","title":"rpa_slbcb","text":"<pre><code>rpa_slbcb(\n    equity,\n    average_entry,\n    entry_price,\n    position_size_asset,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb--summary","title":"Summary","text":"<p>Check if we are in a position or not and sending you to the correct function to handle that</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>equity</code> <code>float</code> <p>equity</p> required <code>position_size_asset</code> <code>float</code> <p>position_size_asset</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>(float, float, float, float, float, float, int, int, float)</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb_np","title":"rpa_slbcb_np","text":"<pre><code>rpa_slbcb_np(\n    equity,\n    entry_price,\n    sl_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb_np--summary","title":"Summary","text":"<p>Not in a position - Risking a percent of your account while also having your stop loss type set to stop loss based on candle body</p> <p>Parameters:</p> Name Type Description Default <code>equity</code> <code>float</code> <p>equity</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>tuple[float, float, float, float, float, float, int, int, float]</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb_p","title":"rpa_slbcb_p","text":"<pre><code>rpa_slbcb_p(\n    average_entry,\n    entry_price,\n    equity,\n    position_size_asset,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb_p--summary","title":"Summary","text":"<p>In a position - Risking a percent of your account while also having your stop loss type set to stop loss based on candle body</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>equity</code> <code>float</code> <p>equity</p> required <code>position_size_asset</code> <code>float</code> <p>position_size_asset</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>(float, float, float, float, float, float, int, int, float)</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.short_entry_size_np","title":"short_entry_size_np","text":"<pre><code>short_entry_size_np(\n    possible_loss,\n    sl_price,\n    entry_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.short_entry_size_np--summary","title":"Summary","text":"<p>Formula to calulcate the short entry size when we are not in a position and have our stop loss type set to stop loss based on candle body</p> <p>how to calculate pnl https://www.bybithelp.com/en-US/s/article/Profit-Loss-calculations-USDT-Contract</p> <p>math for the formula https://www.symbolab.com/solver/simplify-calculator/solve%20for%20u%2C%20%5Cleft(%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%5Cleft(e%20-%20x%5Cright)%5Cright)-%20%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%20e%5Ccdot%20m%5Cright)%20-%20%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%20x%5Ccdot%20m%5Cright)%20%5Cright)%3Dp?or=input</p> <p>Parameters:</p> Name Type Description Default <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>float</code> <p>entry_size_usd</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.short_entry_size_p","title":"short_entry_size_p","text":"<pre><code>short_entry_size_p(\n    average_entry,\n    entry_price,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.short_entry_size_p--summary","title":"Summary","text":"<p>Formula to calulcate the short entry size when we are in a position and have our stop loss type set to stop loss based on candle body</p> <p>how to calculate pnl https://www.bybithelp.com/en-US/s/article/Profit-Loss-calculations-USDT-Contract</p> <p>math for the formula https://www.symbolab.com/solver/simplify-calculator/solve%20for%20u%2C%20%5Cleft(%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%5Cleft(%5Cleft(%5Cfrac%7B%5Cleft(p%2Bu%5Cright)%7D%7B%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%7D%5Cright)-n%5Cright)%5Cright)-%20%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%5Cleft(%5Cfrac%7B%5Cleft(p%2Bu%5Cright)%7D%7B%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%7D%5Cright)%5Ccdot%20%20m%5Cright)%20-%20%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%20%20n%5Ccdot%20%20m%5Cright)%20%5Cright)%3D-f?or=input</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>float</code> <p>entry_size_usd</p>"},{"location":"quantfreedom/order_handler/order/","title":"order","text":""},{"location":"quantfreedom/order_handler/order/#quantfreedom.order_handler.order-classes","title":"Classes","text":""},{"location":"quantfreedom/order_handler/stop_loss/","title":"stop_loss","text":""},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss-classes","title":"Classes","text":""},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss.StopLoss","title":"StopLoss","text":""},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss.StopLoss-functions","title":"Functions","text":""},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss.StopLoss.check_move_sl_to_be","title":"check_move_sl_to_be","text":"<pre><code>check_move_sl_to_be(\n    average_entry,\n    can_move_sl_to_be,\n    current_candle,\n    sl_price,\n)\n</code></pre> <p>Checking to see if we move the stop loss to break even</p>"},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss.StopLoss.check_move_tsl","title":"check_move_tsl","text":"<pre><code>check_move_tsl(\n    average_entry,\n    current_candle,\n    sl_price,\n)\n</code></pre> <p>Checking to see if we move the trailing stop loss</p>"},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss.StopLoss.sl_based_on_candle_body","title":"sl_based_on_candle_body","text":"<pre><code>sl_based_on_candle_body(\n    bar_index,\n    candles,\n)\n</code></pre> <p>Long Stop Loss Based on Candle Body Calculator</p>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Installation","text":"<p>Make sure you read the entire bullet point before you start doing what the bullet point says.</p>"},{"location":"#step-1-creating-a-github-account","title":"Step 1: Creating a github account","text":"<p>Watch this video to get an idea of what you are about to do. But do not follow this is just for informations: https://www.youtube.com/watch?v=Gn3w1UvTx0A</p> <ul> <li>Make a github account and remember or copy what your username and email you used to sign up with is     https://github.com/</li> <li>Creating a repo: watch this video up until min 1:21 just for information do not follow it https://www.youtube.com/watch?v=f26KI43FK58</li> <li>click the plus icon like in the video and click new repository </li> <li>give your repo a name</li> <li>make sure it is public</li> <li>add a readme file</li> <li>add a python gitignore by click on the add gitignore dropdown and type python and select it</li> <li>click on the choose license and choose the Apache license 2.0</li> <li>click create repository </li> </ul>"},{"location":"#step-2-installing-python","title":"Step 2: Installing Python","text":"<ul> <li>Helper video: example video of someone installing python ... but do not follow along with what he is doing, just watch this to get an idea of what you will be doing https://www.youtube.com/watch?v=m9I-YpOjXVQ</li> <li>Download python 3.10.10 - If you already have another version of python installed that is fine because you can have multiple versions of python installed - https://www.python.org/downloads/release/python-31010/</li> <li>To download Scroll down to the bottom of the page or where it says files and click on either the mac version or windows version and install it </li> <li>when you start the install make sure you click add python.exe to path at the bottom of the installer window </li> <li>click on customize install</li> <li>click next</li> <li>check install python 3.10 for all users</li> <li>click on install</li> </ul>"},{"location":"#step-3-installing-git-bash","title":"Step 3: Installing Git Bash","text":"<p>Git Bash is how you allow your computer to talk to github.</p> <ul> <li>Please watch this helper video first before doing anything \u2026 but it important to note Helper video: https://www.youtube.com/watch?v=2j7fD92g-gE</li> <li>Download git and at the end of install make sure you check Launch git bash</li> <li>https://git-scm.com/downloads </li> <li>Copy paste the the following in the window and replace @@@@@@@@ with your github username and make sure it has quotes around your username. For me copying it from here and right clicking in the gitbash window is how i actually past it.</li> <li>git config --global user.name \"@@@@@@@@\"</li> <li>Now type the following and change the email to the email you used to sign up with github</li> <li>git config --global user.email johndoe@example.com</li> </ul>"},{"location":"#step-4-download-visual-studio-code","title":"Step 4: Download Visual Studio Code","text":"<p>This is the program I use to code</p> <ul> <li>Watch this helper video first so you have an idea of what you are about to do: https://www.youtube.com/watch?v=JPZsB_6yHVo</li> <li>Click this link and download for your operating system, then lanuch VSC https://code.visualstudio.com/download</li> <li>In the top left corner, in the menu bar click file, then make sure autosave is checked, if it isn't click it to set it</li> <li></li> </ul>"},{"location":"#installing-extensions","title":"Installing Extensions","text":"<ul> <li>Click the extensions tab which is the 5th icon from the top that looks like 3 squares with the upper right square coming off a little bit.</li> <li></li> <li>Install the following extensions Type in the following extensions one by in the search bar \u2026 if you already have it installed then move to the next on the list</li> <li></li> <li>Python - python</li> <li>Black formatter - this will allow you to format your code</li> <li>Gitlens - this is to help with github stuff</li> <li>jupyter - lets you run jupyter notebooks</li> <li>Magic python - helps with formatting</li> <li>Material icon theme - makes your icons nice</li> <li>Prettier - helps with formatting</li> <li>Pylance - python stuff</li> <li>Python indent - indents your python code properly</li> <li>Now that you are done bring up the vs code menu by pressing cntrl shift p and type in the words activate icons</li> <li>Now click on material icons: activate icons \u2026 this will make your file icons look a lot better</li> <li></li> </ul>"},{"location":"#creating-virtual-environment","title":"Creating virtual environment","text":"<p>Ctl shift p and type in default profile and then select terminal select default profile Click on cmd prompt In the menu bar click on terminal New terminal</p> <p>Create a folder called coding wherever you want on your computer Create a folder inside that folder called venvs - venv stands for virtual enviromnet Now you want to change your terminal directory to the coding folder Change to the correct drive by typing something like C: or E: or whatever your drive letter is Then copy the path to your coding folder something like this quantfreedom\\coding\\venvs And in the terminal paste cd  quantfreedom\\coding\\venvs\\</p> <p>Change directory to venvs Create venv python -m venv qfree qfree\\Scripts\\activate.bat - this will activate the virtual enviromnelt Now you will see we have free to the left of the thing</p> <p>Ctrlp shift p type in word interpreter Select python interpreter Then enter interpreter path Then find Then go to the coding folder then venvs then qfree then scripts then click on python.exe</p> <p>Github part Click on green code button and copy url to clipboard from https</p> <p>Then go to vscode and ctrl shift p then type in clone and click github clone and then paste the repo And if vs code asks you to log into github click yes</p> <p>Then when it asks you for a folder you open the coding folder you created and then click yes or ok</p> <p>Ctrl shift p and type interpreter  select python inter</p> <p>Then choose qfree</p> <p>Vscode file autosave Vscode search clone git repo then paste \u2026 select folder Now create new file called test.ipynb</p> <p>Select kernel python en</p> <p>Add this to settings.json \"editor.parameterHints.enabled\": false, \"python.terminal.activateEnvironment\": true,</p> <p>For me \u2026 show them how to print in a python file \u2026 and also show them how to do math in the python file</p> <p>python beginners playlist ... https://www.youtube.com/playlist?list=PL-osiE80TeTskrapNbzXhwoFUiLCjGgY7</p> <p>Create github Create repo Then download python Download vs code Then clone repo Then create venv Pip install quantfreedom Then select inpertere Then menu terminal new terminal</p>"},{"location":"beginners/","title":"Beginners Guide","text":"<p>BEGINNERS GUIDE</p> <p>these are just suggestion playlists ... if you don't like the videos please find your own playlists that you like</p> <p>study the basics of python https://www.youtube.com/playlist?list=PL-osiE80TeTskrapNbzXhwoFUiLCjGgY7</p> <p>working with classes  https://www.youtube.com/playlist?list=PL-osiE80TeTsqhIuOqKhwlXsIBIdSeYtc</p> <p>learn the basics of pandas https://www.youtube.com/playlist?list=PL-osiE80TeTsWmV9i9c58mdDCSskIFdDS</p> <p>study plotly https://www.youtube.com/playlist?list=PLBSCvBlTOLa8rf2kGkP_Bx5xXqT-er4Yq</p> <p>then study the basics of numpy https://www.youtube.com/playlist?list=PLZGM26Bt_cku3VRraPDwzzqrav0_u8pDC https://www.youtube.com/playlist?list=PLc_Ps3DdrcTuf3e-BBpDv8r9jbOB5Wdv- https://www.youtube.com/playlist?list=PLCC34OHNcOtpalASMlX2HHdsLNipyyhbK</p> <p>once you are done with this then follow my latest video going over a strategy</p> <p>then make your own signals from doing an ema cross over ... just make the proper signals and graph the signals</p> <p>once you make the signals then let me know in the general chat and send me a link to your github and i will check it out and then we can move on from there </p>"},{"location":"free_bot_finish/","title":"Free Bot Finish","text":"<p>Make sure you read the entire bullet point before you start doing what the bullet point says.</p>"},{"location":"free_bot_finish/#donnload-winscp","title":"Donnload WINSCP","text":"<ul> <li>Download winscp https://winscp.net/eng/downloads.php</li> <li>Scroll down and click the download winscp green button and it should auto download, then launch the install</li> <li>Click install for all users</li> <li>Click on accept</li> <li>Choose typical then next</li> <li>Then commander then next</li> <li>Then install</li> <li>Uncheck open get started page and uncheck launch then hit finish</li> </ul>"},{"location":"free_bot_finish/#github-token","title":"Github token","text":"<ul> <li>In the upper right corner of github click on your profile icon and go to settings at the bottom of the menu</li> <li>now go all the way down to the bottom and on the left side click dev settings</li> <li>then on the left side click personal access tokens then click on token classics</li> <li>now click on generate a new token on the upper right side next to revoke all and click on generate new token classic</li> <li>then select the main repo that will select all the options under repo </li> <li>then scroll to the bottom and choose create token</li> <li>make sure you copy and save this somewhere because you will need it to run the strategy</li> </ul>"},{"location":"free_bot_finish/#aws-launch-template","title":"AWS Launch Template","text":"<ul> <li>Log into AWS and go to the console home page and click on EC2</li> <li>On the left side click on security groups under network and security </li> <li>Click on the blue name under secuirty group id which should have the name default under secuirty group name </li> <li>Now we are going to edit the inbound rules in the inbound rules then click edit inbound rules </li> <li>Type will be ssh ... source will be ipv4 and then hit save rule </li> <li>Now click on the outbound tab click edit outbound rules</li> <li>change the type to all traffic and destination to anywhere ipv4 then save rules </li> <li>On the left side menu click on launch templates under instances and then click the orange create launch template in the upper right corner </li> <li>Give your template a name under launch template name </li> <li>In the next section choose ubuntu </li> <li>For instance type choose the t2 free tier option </li> <li>next in key pair login click on create new key pair </li> <li>Then name the key pair something and select ppk and then click create key pair </li> <li>Make sure you save the download somewhere other than your desktop because you will need to use it later on.</li> <li>In network settings choose the security group that we made earlier </li> </ul>"},{"location":"free_bot_finish/#adding-github-token","title":"Adding Github Token","text":"<ul> <li>Open this script</li> <li>On line 7 change where is says %%%%%%%GITHUB_TOKEN with yoru github token</li> <li>On line 13 replace %%%%%%%STRAT_FOLDER with the name of the folder of the strat you want to run ... Ex: 02_rsi_rising_falling ... you can get the name of the folder from the main repo https://github.com/QuantFreedom1022/live_bots</li> <li>On line 14 replace %%%%%%%RUN_FILE.py with the main.py in the folder of the strat you want to run ... Ex: rsi_main.py it will always be a file with main in the name of it</li> <li>Now replace the %%%%%%%API_KEY with your api key</li> <li>Replace the %%%%%%%SECRET_KEY with your secret key</li> <li>Now replace %%%%%%%USE_TEST_NET with a true if you want to use the testnet and a false if you want to use the main net ... all lower case</li> <li>Finally replace %%%%%%%%EXCHANGE_NAME with the name of the exchange you want to trade on ... Ex: mufex ... all lower case</li> <li></li> <li>Go back to the amazon template website</li> </ul>"},{"location":"free_bot_finish/#aes-advanced-details","title":"AES Advanced Details","text":"<ul> <li>Scroll down to the bottom and open advanced details </li> <li>Scroll down to the part that says Metadata version and make sure you have v2 only selected </li> <li>Then go down to the bottom and paste in the aws sript that you made</li> <li>Click on the create template create launch template</li> </ul>"},{"location":"free_bot_finish/#running-the-bot","title":"Running The Bot","text":"<ul> <li>now in the green section click on the link </li> <li>then click on actions on the right side and click launch instance from template </li> <li>then on the right side click on the orange button launch instance</li> <li>then in the green success box click the link</li> <li>then under instance id you click that blue link </li> <li>copy the ipv4 dns </li> </ul>"},{"location":"free_bot_finish/#winscp","title":"WINSCP","text":"<ul> <li>Open winscp</li> <li>in the login screen if you can't edit the host name click edit</li> <li>in the host name field past in the public ipv4 dns</li> <li>Paste it into the host name </li> <li>change the user name to ubuntu</li> <li>clcik on the button advanced and on the left side go to ssh authentication</li> <li>now find the private key file that you downloaded and hit ok </li> <li>now hit save and then hit login and hit yes</li> </ul>"},{"location":"free_bot_finish/#checking-the-logs","title":"Checking The Logs","text":"<ul> <li>You may have to wait 3 to 5 mins for the live bots folder to appear </li> <li>Once the folder shows up you can open the folder and then inside of that folder there should be a logs folder </li> <li>If you don't see a logs folder just wait another min or two and click the refresh button until you see the logs folder.</li> <li>Click on the log file to see what the bot is doing. open logs and you should see that the bot is running </li> </ul>"},{"location":"free_trading_bots%20copy/","title":"Free trading bots copy","text":""},{"location":"free_trading_bots%20copy/#table-of-contents","title":"Table of Contents","text":"<ul> <li>Prerequisites</li> <li>ByBit</li> <li>AWS Launch Template</li> <li>Connect to AWS Instance</li> <li>Github token</li> <li>Get Access To Strat</li> <li>Add Token To Script</li> </ul> <p>--====================================================</p>"},{"location":"free_trading_bots%20copy/#prerequisites","title":"Prerequisites","text":"<ul> <li>If you don't have one Create a github account</li> <li>You will need to sign up to the EC2 Free Tier</li> <li>Install Winscp</li> <li>download winscp https://winscp.net/eng/downloads.php then launch the install</li> <li>choose typical and then commander then install</li> <li>uncheck open get started page</li> <li>Install PuTTY</li> <li>Make sure you have a working credit card and finish the whole sign up process before you continue.</li> </ul> <p>(back to top)</p>"},{"location":"free_trading_bots%20copy/#bybit","title":"ByBit","text":"<p>(include in Bybit section - added from WINSCP) * for bybit you have to make sure you are in a uinfied account ... log into bybit and go to the trading pair btcusdt and on the right side below the open and short and above the contract details and price pool ... if you see the word upgrade make sure</p> <p></p> <p>(back to top )</p>"},{"location":"free_trading_bots%20copy/#aws-launch-template","title":"AWS Launch Template","text":"<ul> <li>Log into AWS and go to the console home page and click on EC2</li> <li>On the left side menu click on Security Groups under Network and Security.</li> <li>Crerate new security group (in my case: wizard 1), and make sure the Inbound and Outbound rules are setup correctly, and create new security group. </li> <li>Go back to EC2 main page, on the left side menu click on launch templates under instances and then click the orange create launch template</li> <li> <p>Name your template under launch template name   </p> </li> <li> <p>In the next section choose latest ubuntu version   </p> </li> <li> <p>For instance type choose the .micro Free tier eligible option   </p> </li> <li> <p>next in key pair login click on create new key pair   </p> </li> <li> <p>Then name the key pair something and select ppk and then click create key pair   </p> </li> <li> <p>Make sure you save the download somewhere other than your desktop because you will need to use it later on.</p> </li> <li>in network settings choose the security groups as (created begore) wizard 1   </li> </ul> <p>(Added from Adding Github Token) * create launch template * now in the green sction click on the link * then click on actions and launch instance from template * then in lower right corner click launch instance * thne in the green click the link to see the instance details</p> <p>(back to top )</p>"},{"location":"free_trading_bots%20copy/#connect-to-aws-instance","title":"Connect to AWS Instance","text":"<ul> <li>Go to EC2 main page</li> <li>then under instance id you click that link</li> <li>copy the ipv4 dns and paste it into the host name for the winscp, use SFTP file protocol port 22 and ubuntu as username</li> <li>clcik on the name advanced and on the left side go to SSH / Autnetication</li> <li>now find the private key file that you downloaded during creation of AWS template. </li> <li>then hit OK and login, (make sure the IP from Instance ID and security group inbound and outbound are corrct)</li> <li>click on the live bots folder and then open logs and you should see that the bot is running</li> </ul> <p>(back to top )</p>"},{"location":"free_trading_bots%20copy/#github-token","title":"Github token","text":"<ul> <li>In the upper right corner of github click on your profile icon and go to settings at the bottom of the menu</li> <li>now go all the way down to the bottom and on the left side click dev settings</li> <li>then on the left side click personal access tokens then click on token classics</li> <li>now click on generate a new token on the upper right side next to revoke all and click on generate new token classic</li> <li> <p>then select the main repo that will select all the options under repo alt text </p> </li> <li> <p>then scroll to the bottom and choose create token</p> </li> <li>make sure you copy and save this somewhere because you will need it to run the strategy</li> </ul> <p>(back to top )</p>"},{"location":"free_trading_bots%20copy/#get-access-to-strat","title":"Get Access To Strat","text":"<p>So at this point you should have everything done and you have the following</p> <ul> <li> You have at least 100 dollars in your crpyto exchange account</li> <li> You have a AWS account that is ready to be used</li> <li> You have a github account and token</li> <li> you have your api keys ready and for bybit users that you have verified your account is unified</li> <li> now you will go to the discord and let me know you signed up in the bot sign up channel</li> <li> You will send the following: A screen shot of you following me on all the social media accounts and a link to your github account.</li> <li> Once you have got confirmation from me that I added you to the repo go to this repo and approve being a collaborator. Bot Github Repo</li> </ul> <p>(back to top )</p>"},{"location":"free_trading_bots%20copy/#add-token-to-script","title":"Add Token To Script","text":"<p>no chane</p> <p>(back to top )</p>"},{"location":"free_trading_bots/","title":"Free Live Trading Bots","text":"<p>I am giving away bots that are ready to go live FOR FREE ... All you will have to do is provide your API keys in the code and hit run</p> <p>You don't need to have any skill with python but you do need to be able to follow directions to get them to work.</p>"},{"location":"free_trading_bots/#follow-my-social-media-pages","title":"Follow My Social Media Pages","text":"<ul> <li>If you don't have a twitter or IG just make a burner account (I will probably never use these platforms. I am only doing this so that if i ever need to DM a bigger influencer that they will see i have followers and respond)</li> <li>Click here to follow me on Twitter</li> <li>Click here to follow me on Instagram</li> <li>Click here to follow me on Youtube</li> <li>Star the github project </li> <li>Make sure you screen shot all of these so I know that you have actually followed me because you will need to put the screen shots in the discord.</li> </ul>"},{"location":"free_trading_bots/#crypto-exchange","title":"Crypto Exchange","text":"<ul> <li>First and formost you need to make sure you have at least 100 dollars of USDT ... if you don't have that then you can go to gemini or coinbase to buy some crypto like USDT or ETH or something and then switch it over to USDT on an exchange like phemex. If you really have no idea then contact me in discord and I can try to help you.</li> <li>you also need to do a quick trade on BTCUSDT just market in for the smallest amount possible and market out. The bot needs to see a recent pnl to work properly</li> <li>You need to have an account on one of the following exchanges because the bots only work on those exchanges for now. If you don't have one of these accounts then use the links below to sign up.<ul> <li>Mufex</li> <li>Bybit</li> </ul> </li> </ul>"},{"location":"free_trading_bots/#my-prefered-exchange-is-mufex","title":"My Prefered Exchange Is Mufex","text":"<ul> <li>Mufex is a DEX (Decentrilized Exchange) and requires no KYC and has no country restrictions</li> <li>If you already have a mufex account then send me your UID. If you don't have one keep reading</li> <li>In order to use this exchange you will need to sign up using your e-mail address so that way you can create your api key.</li> <li>After you have signed up you will need to connect your meta mask wallet</li> </ul>"},{"location":"free_trading_bots/#meta-mask","title":"Meta Mask","text":"<ul> <li>Meta Mask is an Etherum wallet where you can store all of your crypto yourself.</li> <li>Pleaes Follow this youtube video to setup your meta mask wallet. Click Here</li> <li>Once you have setup your wallet you will need to connect it to mufex. Just click on the wallet in the upper right and sign the connection in meta mask.</li> <li>Once it is connected you will need to do the following<ul> <li>Add BNB Chain and switch to BNB chain.</li> <li>Send yourself some USDT. * I highly highly highly suggest only sending 2 or 3 dollars the first time to make sure you actually did it right, then send yourself the rest.</li> <li>Import USDT as a coin</li> <li>Here is a video tutorial</li> </ul> </li> <li>Now that you have some USDT you need to get some BNB.</li> <li>I normally get BNB by sending myself 5 USDT to my phemex account and then spot buy some BNB then send the BNB from phemex to my metamask wallet via the bsc20 / BNB Chain.</li> <li>If you don't have access to a crypto account with BNB or any other account then sign up to phemex using this link because as of right now phemex has no country restrictions ... then do what i said in the previous point. If you already have some other account then get the bnb then send it to your meta mask wallet.</li> <li>Now that you have some USDT and some BNB you need to deposit to your mufex account.</li> </ul>"},{"location":"free_trading_bots/#deposit-to-mufex","title":"Deposit to Mufex","text":"<ul> <li>Hover your mouse over your mufex wallet in the upper right corenr and click on deposit. </li> <li>Now select USDT as your token then select bnb smart chain and then copy the address </li> <li>Go back to meta mask and make sure you are on the bnb chain and click send </li> <li>Then you put in the address you copied from mufex </li> <li>Select the asset as usdt, then choose your amount * I highly highly highly suggest choosing 3 dollars just to make sure it works. Then send the rest after you have confirmed it works. </li> <li>After you have picked the amount you want you click next and then confirm and the transfer will happen shortly</li> <li>To make sure it worked you hover over your wallet in the upper right corner and then click on assets and then you should see how much usdt you have </li> </ul>"},{"location":"free_trading_bots/#mufex-api","title":"Mufex API","text":"<ul> <li>Hover your mouse over your wallet and then click api managment and setup your 2 factor authentication </li> <li>Give your api a name and select reading and trading and you don't need to put anything in the ip address and click save</li> <li>Now send your code to your email and put in your 2FA</li> <li>Make sure you copy and paste your api keys somewhere because you can't see it again</li> </ul>"},{"location":"free_trading_bots/#bybit","title":"Bybit","text":"<ul> <li>Bybit is a CEX (Centrilized Exchange) and requires KYC (Know Your Customer) and has country restrictions</li> <li>You will need to make sure your bybit account is a unified account. You can follow this guide to upgrade</li> <li>Now that your account is unified you need to create your api key.</li> </ul>"},{"location":"free_trading_bots/#bybit-api","title":"Bybit API","text":"<ul> <li>Click on your account profile in the upper right and click on API </li> <li>Now click the orange button in the opper right corner that says create new key, then click on system generated api keys</li> <li>Give your thing a name</li> <li>Then make sure you have read write checked</li> <li>Make sure no ip restrictions is checked</li> <li>click the check box next to unified trading then click submit at the bottom </li> <li>after you have confirmed your 2FA then make sure you copy the api and secret key and keep it saved because you wont be able to see it again unless you make another api key</li> </ul> <p>once you have done all of this then put the following info in the bot sign up channel Click here</p>"},{"location":"free_trading_bots/#aws-and-github","title":"AWS and Github","text":"<ul> <li>If you don't have one Create a github account</li> <li>You will need to sign up to the EC2 Free Tier</li> <li>Make sure you have a working credit card and finish the whole sign up process before you continue.</li> </ul>"},{"location":"free_trading_bots/#get-access-to-strat","title":"Get Access To Strat","text":"<ul> <li>So at this point you should have everything done and you have the following</li> <li>You have at least 100 dollars in your crpyto exchange account</li> <li>You have a AWS account that is ready to be used</li> <li>You have a github account</li> <li>you have your api keys ready and for bybit users that you have verified your account is unified</li> <li>now you will go to the discord and let me know you got this far in the general chat. Just make sure you @ me</li> <li>Then i will give you access to the bot sign up channel</li> <li>In here you will post the following: A screen shot of you following me on all the social media accounts and a link to your github account.</li> <li>Once you have got confirmation from me I will add you to the free bot runner group and send you the link to the final parts of running the free bot.</li> </ul>"},{"location":"nav_file/","title":"Nav file","text":"<ul> <li>Installation</li> <li>Free Bot Sign Up</li> <li>Beginners Guide</li> <li>Functions<ul> <li>enums</li> <li>exchanges<ul> <li>apex_exchange<ul> <li>apex</li> </ul> </li> <li>binance_exchange<ul> <li>binance_us</li> <li>binance_usdm</li> </ul> </li> <li>bybit_exchange<ul> <li>bybit</li> </ul> </li> <li>mufex_exchange<ul> <li>mufex</li> </ul> </li> </ul> </li> <li>helper_funcs</li> <li>indicators<ul> <li>tv_indicators</li> </ul> </li> <li>nb_funcs<ul> <li>nb_indicators<ul> <li>nb_indicators</li> </ul> </li> <li>nb_order_handler<ul> <li>nb_increase_position</li> <li>nb_stop_loss</li> </ul> </li> <li>nb_simulate<ul> <li>nb_sim_base</li> <li>nb_sim_df</li> </ul> </li> <li>nb_strategies<ul> <li>nb_strategy</li> </ul> </li> </ul> </li> <li>order_handler<ul> <li>increase_position</li> <li>order</li> <li>stop_loss</li> </ul> </li> <li>simulate</li> <li>utils</li> </ul> </li> </ul>"},{"location":"quantfreedom/enums/","title":"enums","text":""},{"location":"quantfreedom/enums/#quantfreedom.enums-classes","title":"Classes","text":""},{"location":"quantfreedom/enums/#quantfreedom.enums.BacktestSettings","title":"BacktestSettings","text":"<p>             Bases: <code>NamedTuple</code></p> <p>Settings for filtering the results of your backtest. The main purpose of this is to save on memory and also there is sometimes no point in wanting to see strategies that are negative gains or below a specific qf score because they are useless.</p> <p>Parameters:</p> Name Type Description Default <code>gains_pct_filter</code> <code>float = -np.inf</code> <p>Will not record any strategies whos gains % result is below gains_pct_filter</p> required <code>qf_filter</code> <code>float = -np.inf</code> <p>Will not record any strategies whos qf score result is below the qf filter. qf_score is between -1 to 1,</p> required <code>total_trade_filter</code> <code>int = -1</code> <p>Will not record any strategies whos total trades result is below total trades filter.</p> required <code>record_size</code> <code>int = 10000</code> <p>The amount of records you want to to save. Keep this number as low as possible to save memory.</p> required"},{"location":"quantfreedom/enums/#quantfreedom.enums.IncreasePositionTypeT","title":"IncreasePositionTypeT","text":"<p>             Bases: <code>NamedTuple</code></p> <p>The different ways you can increase your position</p> <p>Parameters:</p> Name Type Description Default <code>AmountEntrySize</code> <code>int= 0</code> <p>How much you want your position size to be per trade in USDT</p> required <code>PctAccountEntrySize</code> <code>int = 1</code> <p>If you have an equity of 1000 and you want your pct account entry size to be 1% then that means each trade will be a position size of 10 usdt</p> required <code>RiskAmountEntrySize</code> <code>int = 2</code> <p>How much you will risk per trade. You must have a stop loss in order to use this mode.</p> required <code>RiskPctAccountEntrySize</code> <code>int = 3</code> <p>How much of your account you want to risk per trade. If you have an equtiy of 1000 and you want to risk 1% then each trade would be risking $10. You must have a stop loss in order to use this mode</p> required <code>SmalletEntrySizeAsset</code> <code>int = 4</code> <p>What ever the exchange smallest asset size is that is what your position size will be for each trade. Let's say the smallest is .001 for btcusdt, then each trade will be worth .001 btc</p> required"},{"location":"quantfreedom/enums/#quantfreedom.enums.LeverageStrategyTypeT","title":"LeverageStrategyTypeT","text":"<p>             Bases: <code>NamedTuple</code></p> <p>Choosing which leverage strategy you would like to use.</p> <p>Parameters:</p> Name Type Description Default <code>Dynamic</code> <code>int = 0</code> <p>This will automatically adjust your leverage to be .001 percent further than your stop loss. The reason behind this is to that it will keep your used cash amount down as much as possible so you can place more trades on the same or other assets.</p> required <code>Static</code> <code>int = 1</code> <p>Static leverage</p> required"},{"location":"quantfreedom/enums/#quantfreedom.enums.TakeProfitStrategyTypeT","title":"TakeProfitStrategyTypeT","text":"<p>             Bases: <code>NamedTuple</code></p> <p>How you want to process the take profit</p> <p>Parameters:</p> Name Type Description Default <code>RiskReward</code> <code>int = 0</code> <p>Risk to reward</p> required <code>Provided</code> <code>int = 1</code> <p>Your strategy will provide the exit prices</p> required <code>Nothing</code> <code>int = 2</code> <p>No take profits.</p> required"},{"location":"quantfreedom/helper_funcs/","title":"helper_funcs","text":""},{"location":"quantfreedom/helper_funcs/#quantfreedom.helper_funcs-classes","title":"Classes","text":""},{"location":"quantfreedom/helper_funcs/#quantfreedom.helper_funcs-functions","title":"Functions","text":""},{"location":"quantfreedom/helper_funcs/#quantfreedom.helper_funcs.candles_to_df","title":"candles_to_df","text":"<pre><code>candles_to_df(\n    candles,\n)\n</code></pre> <p>Converts your numpy array candles to a pandas dataframe</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p> required <p>Returns:</p> Type Description <code>DataFrame</code> <p>columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\" with an index of pandas datetimes</p>"},{"location":"quantfreedom/helper_funcs/#quantfreedom.helper_funcs.dl_ex_candles","title":"dl_ex_candles","text":"<pre><code>dl_ex_candles(\n    symbol,\n    exchange,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=None,\n)\n</code></pre> <p>Download candles from the exchange of your choice</p> <p>Parameters:</p> Name Type Description Default <code>exchange</code> <code>str</code> <p>binance us = 'binance_us' | default candles to dl is 1500</p> <p>binance futures = 'binance_usdm' | default candles to dl is 1500</p> <p>apex = 'apex' | default candles to dl is 200</p> <p>mufex = 'mufex' | default candles to dl is 1500</p> <p>bybit = 'bybit' | default candles to dl is 1000</p> required <code>symbol</code> <code>str</code> <p>Check the api of the exchange or get all the symbols of the exchange to see which ones you need to put here</p> required <code>timeframe</code> <code>str</code> <pre><code>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"\n</code></pre> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>None</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/simulate/","title":"simulate","text":""},{"location":"quantfreedom/simulate/#quantfreedom.simulate-classes","title":"Classes","text":""},{"location":"quantfreedom/simulate/#quantfreedom.simulate-functions","title":"Functions","text":""},{"location":"quantfreedom/utils/","title":"utils","text":""},{"location":"quantfreedom/utils/#quantfreedom.utils-functions","title":"Functions","text":""},{"location":"quantfreedom/utils/#quantfreedom.utils.clear_cache","title":"clear_cache","text":"<pre><code>clear_cache()\n</code></pre> <p>clears the python cache and numba cache</p>"},{"location":"quantfreedom/utils/#quantfreedom.utils.delete_dir","title":"delete_dir","text":"<pre><code>delete_dir(\n    p,\n)\n</code></pre> <p>Delete info in directory</p> <p>Parameters:</p> Name Type Description Default <code>p</code> <code>path</code> <p>path to directory</p> required"},{"location":"quantfreedom/utils/#quantfreedom.utils.generate_candles","title":"generate_candles","text":"<pre><code>generate_candles(\n    number_of_candles=100,\n    plot_candles=False,\n    seed=None,\n)\n</code></pre> <p>Generate a dataframe filled with random candles</p> <p>Parameters:</p> Name Type Description Default <code>number_of_candles</code> <code>(int, 100)</code> <p>number of candles you want to create</p> <code>100</code> <code>seed</code> <code>(int, None)</code> <p>random seed number</p> <code>None</code> <code>plot_candles</code> <code>(bool, False)</code> <p>If the candles should be graphed or not.</p> <code>False</code> <p>Returns:</p> Type Description <code>pdFrame</code> <p>Dataframe of open high low close</p>"},{"location":"quantfreedom/utils/#quantfreedom.utils.pretty_qf","title":"pretty_qf","text":"<pre><code>pretty_qf(\n    named_tuple,\n)\n</code></pre> <p>Prints named tuples in a pretty way</p> <p>Parameters:</p> Name Type Description Default <code>named_tuple</code> <code>namedtuple</code> <p>must only be a named tuple</p> required"},{"location":"quantfreedom/exchanges/apex_exchange/apex/","title":"apex","text":""},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex","title":"Apex","text":"<p>             Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.__init__","title":"__init__","text":"<pre><code>__init__(\n    use_test_net,\n    api_key=None,\n    secret_key=None,\n    passphrase=None,\n    stark_key_public=None,\n    stark_key_private=None,\n    stark_key_y=None,\n)\n</code></pre> <p>main docs page https://api-docs.pro.apex.exchange</p>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.create_order","title":"create_order","text":"<pre><code>create_order(\n    symbol,\n    buy_sell,\n    order_type,\n    asset_size,\n    limitFeeRate=None,\n    limitFee=None,\n    price=None,\n    accountId=None,\n    time_in_force=\"GOOD_TIL_CANCEL\",\n    reduceOnly=False,\n    triggerPrice=None,\n    triggerPriceType=None,\n    trailingPercent=None,\n    clientId=None,\n    expiration=None,\n    isPositionTpsl=False,\n    signature=None,\n    sourceFlag=None,\n)\n</code></pre> <p>Apex API for Creating Orders</p>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.get_candles","title":"get_candles","text":"<pre><code>get_candles(\n    symbol,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=200,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.get_candles--summary","title":"Summary","text":"<p>Apex candle docs</p>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.get_candles--explainer-video","title":"Explainer Video","text":"<p>Coming Soon but if you want/need it now please let me know in discord or telegram and i will make it for you</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Use APEX API for symbol list</p> required <code>timeframe</code> <code>str</code> <p>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"</p> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>200</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/exchanges/apex_exchange/apex/#quantfreedom.exchanges.apex_exchange.apex.Apex.set_leverage","title":"set_leverage","text":"<pre><code>set_leverage(\n    symbol,\n    leverage,\n)\n</code></pre> <p>Apex API for initial margin rate of a contract</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/","title":"binance_us","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us.BinanceUS","title":"BinanceUS","text":"<p>             Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us.BinanceUS-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us.BinanceUS.get_candles","title":"get_candles","text":"<pre><code>get_candles(\n    symbol,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=1500,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us.BinanceUS.get_candles--summary","title":"Summary","text":"<p>Biance US candle docs</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_us/#quantfreedom.exchanges.binance_exchange.binance_us.BinanceUS.get_candles--explainer-video","title":"Explainer Video","text":"<p>Coming Soon but if you want/need it now please let me know in discord or telegram and i will make it for you</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Use Binance US API for symbol list</p> required <code>timeframe</code> <code>str</code> <p>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"</p> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>1500</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/","title":"binance_usdm","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM","title":"BinanceUSDM","text":"<p>             Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.__init__","title":"__init__","text":"<pre><code>__init__(\n    use_test_net,\n    api_key=None,\n    secret_key=None,\n)\n</code></pre> <p>main docs page</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.create_order","title":"create_order","text":"<pre><code>create_order(\n    symbol,\n    side,\n    type,\n    quantity=None,\n    positionSide=None,\n    timeInForce=\"GTC\",\n    reduceOnly=None,\n    price=None,\n    newClientOrderId=None,\n    stopPrice=None,\n    closePosition=None,\n    activationPrice=None,\n    callbackRate=None,\n    workingType=None,\n    priceProtect=None,\n    newOrderRespType=None,\n    priceMatch=None,\n    selfTradePreventionMode=None,\n    goodTillDate=None,\n    recvWindow=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_all_symbols_info","title":"get_all_symbols_info","text":"<pre><code>get_all_symbols_info()\n</code></pre> <p>Binance Exchange Information</p> <p>Parameters:</p> Name Type Description Default <code>None</code> required <p>Returns:</p> Type Description <code>Dictionary</code> <p>dictionary of info about the symbols</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_candles","title":"get_candles","text":"<pre><code>get_candles(\n    symbol,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=1500,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_candles--summary","title":"Summary","text":"<p>Biance USDM candle docs</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_candles--explainer-video","title":"Explainer Video","text":"<p>Coming Soon but if you want/need it now please let me know in discord or telegram and i will make it for you</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Use Binance USDM API for symbol list</p> required <code>timeframe</code> <code>str</code> <p>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"</p> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>1500</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_exchange_info","title":"get_exchange_info","text":"<pre><code>get_exchange_info()\n</code></pre> <p>Binance Exchange Information</p> <p>Parameters:</p> Name Type Description Default <code>None</code> required <p>Returns:</p> Type Description <code>Dictionary</code> <p>dictionary of info about the exchange</p>"},{"location":"quantfreedom/exchanges/binance_exchange/binance_usdm/#quantfreedom.exchanges.binance_exchange.binance_usdm.BinanceUSDM.get_symbols_list","title":"get_symbols_list","text":"<pre><code>get_symbols_list()\n</code></pre> <p>Binance Exchange Information</p> <p>Parameters:</p> Name Type Description Default <code>None</code> required <p>Returns:</p> Type Description <code>List</code> <p>List of exchange symbols</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/","title":"bybit","text":""},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit","title":"Bybit","text":"<p>             Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.__init__","title":"__init__","text":"<pre><code>__init__(\n    use_test_net,\n    api_key=None,\n    secret_key=None,\n)\n</code></pre> <p>main docs page https://bybit-exchange.github.io/docs/v5/intro upgrade to unified account</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.adjust_order","title":"adjust_order","text":"<pre><code>adjust_order(\n    symbol,\n    asset_size=None,\n    category=\"linear\",\n    custom_order_id=None,\n    orderIv=None,\n    order_id=None,\n    price=None,\n    slLimitPrice=None,\n    slTriggerBy=None,\n    stopLoss=None,\n    takeProfit=None,\n    tpLimitPrice=None,\n    tpslMode=None,\n    tpTriggerBy=None,\n    triggerBy=None,\n    triggerPrice=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.cancel_all_open_orders","title":"cancel_all_open_orders","text":"<pre><code>cancel_all_open_orders(\n    symbol=None,\n    category=\"linear\",\n    baseCoin=None,\n    settleCoin=None,\n    orderFilter=None,\n    stopOrderType=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.create_order","title":"create_order","text":"<pre><code>create_order(\n    symbol,\n    buy_sell,\n    position_mode,\n    order_type,\n    asset_size,\n    category=\"linear\",\n    time_in_force=\"GTC\",\n    price=None,\n    triggerDirection=None,\n    triggerPrice=None,\n    triggerBy=None,\n    tpTriggerBy=None,\n    slTriggerBy=None,\n    custom_order_id=None,\n    takeProfit=None,\n    stopLoss=None,\n    reduce_only=None,\n    closeOnTrigger=None,\n    isLeverage=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_all_symbols_info","title":"get_all_symbols_info","text":"<pre><code>get_all_symbols_info(\n    category=\"linear\",\n    limit=500,\n    symbol=None,\n    status=None,\n    baseCoin=None,\n)\n</code></pre> <p>Bybit API link to Get Instrument Info</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_candles","title":"get_candles","text":"<pre><code>get_candles(\n    symbol,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=1000,\n    category=\"linear\",\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_candles--summary","title":"Summary","text":"<p>Bybit candle docs</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_candles--explainer-video","title":"Explainer Video","text":"<p>Coming Soon but if you want/need it now please let me know in discord or telegram and i will make it for you</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Use Bybit API for symbol list</p> required <code>timeframe</code> <code>str</code> <p>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"</p> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>1000</code> <code>category</code> <code>str</code> <p>Bybit categories link</p> <code>'linear'</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_closed_pnl","title":"get_closed_pnl","text":"<pre><code>get_closed_pnl(\n    symbol,\n    limit=50,\n    since_datetime=None,\n    until_datetime=None,\n    category=\"linear\",\n)\n</code></pre> <p>Bybit API link to Get Closed Profit and Loss</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_open_orders","title":"get_open_orders","text":"<pre><code>get_open_orders(\n    baseCoin=None,\n    category=\"linear\",\n    custom_order_id=None,\n    limit=50,\n    orderFilter=None,\n    orderStatus=None,\n    order_id=None,\n    settleCoin=None,\n    since_datetime=None,\n    symbol=None,\n    until_datetime=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_order_history","title":"get_order_history","text":"<pre><code>get_order_history(\n    baseCoin=None,\n    category=\"linear\",\n    custom_order_id=None,\n    limit=50,\n    orderFilter=None,\n    orderStatus=None,\n    order_id=None,\n    settleCoin=None,\n    since_datetime=None,\n    symbol=None,\n    until_datetime=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_position_info","title":"get_position_info","text":"<pre><code>get_position_info(\n    symbol,\n    baseCoin=None,\n    category=\"linear\",\n    limit=50,\n    settleCoin=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_risk_limit_info","title":"get_risk_limit_info","text":"<pre><code>get_risk_limit_info(\n    symbol,\n    category=\"linear\",\n)\n</code></pre> <p>Bybit API link to Get Risk Limit</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_symbols_list","title":"get_symbols_list","text":"<pre><code>get_symbols_list()\n</code></pre> <p>Returns a list of the symbols in alphabetical order</p> <p>Parameters:</p> Name Type Description Default <code>None</code> required <p>Returns:</p> Type Description <code>list</code> <p>symbols</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_trading_fee_rates","title":"get_trading_fee_rates","text":"<pre><code>get_trading_fee_rates(\n    symbol=None,\n    baseCoin=None,\n    category=\"linear\",\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.get_wallet_info","title":"get_wallet_info","text":"<pre><code>get_wallet_info(\n    accountType=\"UNIFIED\",\n    trading_with=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.set_leverage","title":"set_leverage","text":"<pre><code>set_leverage(\n    symbol,\n    leverage,\n    category=\"linear\",\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.set_leverage_mode","title":"set_leverage_mode","text":"<pre><code>set_leverage_mode(\n    setMarginMode=\"ISOLATED_MARGIN\",\n)\n</code></pre> <p>ISOLATED_MARGIN, REGULAR_MARGIN(i.e. Cross margin), PORTFOLIO_MARGIN</p>"},{"location":"quantfreedom/exchanges/bybit_exchange/bybit/#quantfreedom.exchanges.bybit_exchange.bybit.Bybit.set_position_mode","title":"set_position_mode","text":"<pre><code>set_position_mode(\n    position_mode,\n    symbol,\n    category=\"linear\",\n    trading_with=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/","title":"mufex","text":""},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex","title":"Mufex","text":"<p>             Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.__init__","title":"__init__","text":"<pre><code>__init__(\n    use_test_net,\n    api_key=None,\n    secret_key=None,\n)\n</code></pre> <p>main docs page https://www.mufex.finance/apidocs/derivatives/contract/index.html</p> <p>Make sure you have your position mode set to hedge or else a lot of functions will not work. https://www.mufex.finance/apidocs/derivatives/contract/index.html?console#t-dv_switchpositionmode</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.adjust_order","title":"adjust_order","text":"<pre><code>adjust_order(\n    params={},\n)\n</code></pre> <p>you basically have to use the same info that you would for create order https://www.mufex.finance/apidocs/derivatives/contract/index.html#t-dv_placeorder</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.cancel_all_open_orders_per_symbol","title":"cancel_all_open_orders_per_symbol","text":"<pre><code>cancel_all_open_orders_per_symbol(\n    symbol,\n)\n</code></pre> <p>no link yet</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.cancel_open_order","title":"cancel_open_order","text":"<pre><code>cancel_open_order(\n    symbol,\n    order_id=None,\n    custom_order_id=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.create_order","title":"create_order","text":"<pre><code>create_order(\n    symbol,\n    buy_sell,\n    position_mode,\n    order_type,\n    asset_size,\n    time_in_force=\"GoodTillCancel\",\n    price=None,\n    triggerDirection=None,\n    triggerPrice=None,\n    triggerBy=None,\n    tpTriggerBy=None,\n    slTriggerBy=None,\n    custom_order_id=None,\n    takeProfit=None,\n    stopLoss=None,\n    reduce_only=None,\n    closeOnTrigger=None,\n)\n</code></pre> <p>time_in_force:     GoodTillCancel     ImmediateOrCancel     FillOrKill     PostOnly</p> <p>position_mode: used to identify positions in different position modes. Required if you are under Hedge Mode:     0-One-Way Mode     1-Buy side of both side mode     2-Sell side of both side mode</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_all_symbols_info","title":"get_all_symbols_info","text":"<pre><code>get_all_symbols_info(\n    category=\"linear\",\n    limit=1000,\n    symbol=None,\n)\n</code></pre> <p>Mufex API link to Get Instrument Info</p> <p>Parameters:</p> Name Type Description Default <code>category</code> <code>str</code> <p>If category is not passed, then return \"\"For now, default:linear</p> <code>'linear'</code> <code>limit</code> <code>int</code> <p>Limit for data size per page, max size is 1000. Default as showing 500 pieces of data per page.It's not sorted by time</p> <code>1000</code> <code>symbol</code> <code>str</code> <p>Symbol</p> <code>None</code> <p>Returns:</p> Type Description <code>_type_</code> <p>description</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_candles","title":"get_candles","text":"<pre><code>get_candles(\n    symbol,\n    timeframe,\n    since_datetime=None,\n    until_datetime=None,\n    candles_to_dl=1500,\n    category=\"linear\",\n)\n</code></pre> <p>mufex candle docs</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Mufex Symbol List</p> required <code>timeframe</code> <code>str</code> <p>\"1m\", \"5m\", \"15m\", \"30m\", \"1h\", \"2h\", \"4h\", \"6h\", \"12h\", \"d\", \"w\"</p> required <code>since_datetime</code> <code>datetime</code> <p>The start date, in datetime format, of candles you want to download. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>until_datetime</code> <code>datetime</code> <p>The until date, in datetime format, of candles you want to download minus one candle so if you are on the 5 min if you say your until date is 1200 your last candle will be 1155. EX: datetime(year, month, day, hour, minute)</p> <code>None</code> <code>candles_to_dl</code> <code>int</code> <p>The amount of candles you want to download</p> <code>1500</code> <code>category</code> <code>str</code> <p>mufex categories link</p> <code>'linear'</code> <p>Returns:</p> Type Description <code>array</code> <p>a 2 dim array with the following columns \"timestamp\", \"open\", \"high\", \"low\", \"close\", \"volume\"</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_closed_pnl","title":"get_closed_pnl","text":"<pre><code>get_closed_pnl(\n    symbol,\n    limit=200,\n    since_datetime=None,\n    until_datetime=None,\n)\n</code></pre> <p>Mufex API link to Get Closed Profit and Loss</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_filled_orders","title":"get_filled_orders","text":"<pre><code>get_filled_orders(\n    symbol,\n    limit=200,\n    since_datetime=None,\n    until_datetime=None,\n    execType=None,\n    order_id=None,\n)\n</code></pre> <p>Get user's trading records. The results are ordered in descending order (the first item is the latest). Returns records up to 2 years old.</p> <p>use link to see all Request Parameters</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_open_orders","title":"get_open_orders","text":"<pre><code>get_open_orders(\n    symbol,\n    limit=50,\n    order_id=None,\n    custom_order_id=None,\n    orderFilter=None,\n)\n</code></pre> <p>Query real-time order information. If only orderId or orderLinkId are passed, a single order will be returned; otherwise, returns up to 500 unfilled orders</p> <p>orderId limit</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_order_history","title":"get_order_history","text":"<pre><code>get_order_history(\n    symbol,\n    limit=50,\n    order_id=None,\n    custom_order_id=None,\n    orderStatus=None,\n    orderFilter=None,\n)\n</code></pre> <p>use link to see all Request Parameters</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_position_info","title":"get_position_info","text":"<pre><code>get_position_info(\n    symbol=None,\n    settleCoin=None,\n    limit=50,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_risk_limit_info","title":"get_risk_limit_info","text":"<pre><code>get_risk_limit_info(\n    symbol,\n    category=\"linear\",\n)\n</code></pre> <p>Mufex API link to Get Risk Limit</p> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <p>Symbol</p> required <code>category</code> <code>str</code> <p>If category is not passed, then return \"\"For now, default:linear</p> <code>'linear'</code> <p>Returns:</p> Type Description <code>_type_</code> <p>description</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_symbol_trading_fee_rates","title":"get_symbol_trading_fee_rates","text":"<pre><code>get_symbol_trading_fee_rates(\n    symbol=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_symbols_list","title":"get_symbols_list","text":"<pre><code>get_symbols_list()\n</code></pre> <p>Returns a list of the symbols in alphabetical order</p> <p>Parameters:</p> Name Type Description Default <code>None</code> required <p>Returns:</p> Type Description <code>list</code> <p>symbols</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_trading_fee_rates","title":"get_trading_fee_rates","text":"<pre><code>get_trading_fee_rates(\n    symbol=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.get_wallet_info","title":"get_wallet_info","text":"<pre><code>get_wallet_info(\n    trading_with=None,\n)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.set_leverage","title":"set_leverage","text":"<pre><code>set_leverage(\n    symbol,\n    leverage,\n)\n</code></pre> <p>No link yet</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.set_leverage_mode","title":"set_leverage_mode","text":"<pre><code>set_leverage_mode(\n    symbol,\n    leverage_mode,\n    leverage=5,\n)\n</code></pre> <p>Cross/isolated mode. 0: cross margin mode; 1: isolated margin mode</p>"},{"location":"quantfreedom/exchanges/mufex_exchange/mufex/#quantfreedom.exchanges.mufex_exchange.mufex.Mufex.set_position_mode","title":"set_position_mode","text":"<pre><code>set_position_mode(\n    position_mode,\n    trading_with=None,\n    symbol=None,\n)\n</code></pre>"},{"location":"quantfreedom/indicators/tv_indicators/","title":"tv_indicators","text":""},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators-functions","title":"Functions","text":""},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.atr_tv","title":"atr_tv","text":"<pre><code>atr_tv(\n    candles,\n    length,\n    smoothing_type=rma_tv,\n)\n</code></pre> <p>Average true range smoothing from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <code>smoothing_type</code> <code>Callable</code> <p>function to process the smoothing of the atr</p> <code>rma_tv</code> <p>Returns:</p> Type Description <code>array</code> <p>atr</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.bb_tv","title":"bb_tv","text":"<pre><code>bb_tv(\n    length,\n    multi,\n    source,\n    basis_ma_type=sma_tv,\n)\n</code></pre> <p>Bollinger bands from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <code>multi</code> <code>float</code> <p>Standard deviation factor</p> required <code>basis_ma_type</code> <code>Callable</code> <p>Function to process basic ma</p> <code>sma_tv</code> <p>Returns:</p> Type Description <code>tuple[array, array, array]</code> <p>basis, upper, lower</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.donchain_channels_tv","title":"donchain_channels_tv","text":"<pre><code>donchain_channels_tv(\n    candles,\n    length,\n)\n</code></pre> <p>Donchain channels</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <code>length</code> <code>int</code> <p>Number of bars of donchain lookback</p> required <p>Returns:</p> Type Description <code>tuple[array, array, array]</code> <p>upper, basis, lower</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.ema_tv","title":"ema_tv","text":"<pre><code>ema_tv(\n    source,\n    length,\n)\n</code></pre> <p>Exponential Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>ema</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.linear_regression_candles_ugurvu_tv","title":"linear_regression_candles_ugurvu_tv","text":"<pre><code>linear_regression_candles_ugurvu_tv(\n    candles,\n    lin_reg_length,\n    smoothing_length,\n    smoothing_type=sma_tv,\n)\n</code></pre> <p>Linear regression indicator</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <code>lin_reg_length</code> <code>int</code> <p>Number of bars for lin reg</p> required <code>smoothing_length</code> <code>int</code> <p>Number of bars for singal line</p> required <code>smoothing_type</code> <code>Callable</code> <p>function to process the smoothing of the singal line</p> <code>sma_tv</code> <p>Returns:</p> Type Description <code>tuple[array, array]</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume], signal</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.macd_tv","title":"macd_tv","text":"<pre><code>macd_tv(\n    source,\n    fast_length,\n    slow_length,\n    signal_smoothing,\n    oscillator_type=ema_tv,\n    signal_ma_type=ema_tv,\n)\n</code></pre> <p>Moving average convergence divergence from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>fast_length</code> <code>int</code> <p>Number of bars</p> required <code>slow_length</code> <code>int</code> <p>Number of bars</p> required <code>signal_smoothing</code> <code>int</code> <p>Number of bars</p> required <code>oscillator_type</code> <code>Callable</code> <p>Function to process fast and slow ma</p> <code>ema_tv</code> <code>signal_ma_type</code> <code>Callable</code> <p>Function to process signal ma</p> <code>ema_tv</code> <p>Returns:</p> Type Description <code>(array, array, array)</code> <p>histogram, macd, signal</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.rma_tv","title":"rma_tv","text":"<pre><code>rma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Relative strength index Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>rma</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.rma_tv_2","title":"rma_tv_2","text":"<pre><code>rma_tv_2(\n    source_1,\n    source_2,\n    length,\n)\n</code></pre> <p>Relative strength index Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source_1</code> <code>array</code> <p>Values to process</p> required <code>source_2</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>rma_1, rma_2</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.rsi_tv","title":"rsi_tv","text":"<pre><code>rsi_tv(\n    length,\n    source,\n)\n</code></pre> <p>Relative strength index</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>rsi</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.sma_tv","title":"sma_tv","text":"<pre><code>sma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Simple Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>sma</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.squeeze_momentum_lazybear_tv","title":"squeeze_momentum_lazybear_tv","text":"<pre><code>squeeze_momentum_lazybear_tv(\n    candles,\n    length_bb,\n    length_kc,\n    multi_bb,\n    multi_kc,\n)\n</code></pre> <p>LazyBear Pinescript</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <code>length_bb</code> <code>int</code> <p>Number of bars of Bollinger Bands</p> required <code>length_kc</code> <code>int</code> <p>Number of bars of KC</p> required <code>multi_bb</code> <code>int</code> <p>The multiplier by which the Bollinger Bands will get multiplied</p> required <code>multi_kc</code> <code>int</code> <p>The multiplier by which the KC will get multiplied</p> required <p>Returns:</p> Type Description <code>tuple[array, array, array]</code> <p>squeeze historgram, squeeze on, no squeeze</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.stdev_tv","title":"stdev_tv","text":"<pre><code>stdev_tv(\n    source,\n    length,\n)\n</code></pre> <p>Standard deviation from tradingview</p> <p>Explainer Video</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>stdev</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.supertrend_tv","title":"supertrend_tv","text":"<pre><code>supertrend_tv(\n    candles,\n    atr_length,\n    factor,\n)\n</code></pre> <p>Super Trend</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <code>atr_length</code> <code>int</code> <p>Number of bars</p> required <code>factor</code> <code>int</code> <p>The multiplier by which the ATR will get multiplied</p> required <p>Returns:</p> Type Description <code>tuple[array, array]</code> <p>super_trend, direction</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.true_range_tv","title":"true_range_tv","text":"<pre><code>true_range_tv(\n    candles,\n)\n</code></pre> <p>True Range from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <p>Returns:</p> Type Description <code>array</code> <p>true_range</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.vwap_tv","title":"vwap_tv","text":"<pre><code>vwap_tv(\n    candles,\n)\n</code></pre> <p>Volume Weighted Average Price</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>array</code> <p>2-dim np.array with columns in the following order [timestamp, open, high, low, close, volume]</p> required <p>Returns:</p> Type Description <code>array</code> <p>vwap</p>"},{"location":"quantfreedom/indicators/tv_indicators/#quantfreedom.indicators.tv_indicators.wma_tv","title":"wma_tv","text":"<pre><code>wma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Weighted Moving Average From Tradingview</p> <p>Explainer Video</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>array</code> <p>Values to process</p> required <code>length</code> <code>int</code> <p>Number of bars</p> required <p>Returns:</p> Type Description <code>array</code> <p>wma</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/","title":"nb_indicators","text":""},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators-functions","title":"Functions","text":""},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_atr_tv","title":"nb_atr_tv","text":"<pre><code>nb_atr_tv(\n    candles,\n    length,\n    smoothing_type=nb_rma_tv,\n)\n</code></pre> <p>Average true range smoothing https://www.tradingview.com/pine-script-reference/v5/#fun_ta.atr</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_bb_tv","title":"nb_bb_tv","text":"<pre><code>nb_bb_tv(\n    source,\n    length,\n    multi,\n    basis_ma_type=nb_sma_tv,\n)\n</code></pre> <p>returns basis, upper, lower</p> <p>Bollinger bands https://www.tradingview.com/pine-script-reference/v5/#fun_ta.bb</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_ema_tv","title":"nb_ema_tv","text":"<pre><code>nb_ema_tv(\n    source,\n    length,\n)\n</code></pre> <p>Exponential Moving average https://www.tradingview.com/pine-script-reference/v5/#fun_ta.ema</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_macd_tv","title":"nb_macd_tv","text":"<pre><code>nb_macd_tv(\n    source,\n    fast_length,\n    slow_length,\n    signal_smoothing,\n    oscillator_type=nb_ema_tv,\n    signal_ma_type=nb_ema_tv,\n)\n</code></pre> <p>return order = histogram, macd, signal Moving average convergence divergence https://www.tradingview.com/pine-script-reference/v5/#fun_ta.macd</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_rma_tv","title":"nb_rma_tv","text":"<pre><code>nb_rma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Relative strength index Moving average https://www.tradingview.com/pine-script-reference/v5/#fun_ta.rma</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_rma_tv_2","title":"nb_rma_tv_2","text":"<pre><code>nb_rma_tv_2(\n    source_1,\n    source_2,\n    length,\n)\n</code></pre> <p>Relative strength index Moving average https://www.tradingview.com/pine-script-reference/v5/#fun_ta.rma</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_rsi_tv","title":"nb_rsi_tv","text":"<pre><code>nb_rsi_tv(\n    source,\n    length,\n)\n</code></pre> <p>Relative strength index https://www.tradingview.com/pine-script-reference/v5/#fun_ta.rsi</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_sma_tv","title":"nb_sma_tv","text":"<pre><code>nb_sma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Simple Moving average https://www.tradingview.com/pine-script-reference/v5/#fun_ta.sma</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_squeeze_momentum_lazybear_tv","title":"nb_squeeze_momentum_lazybear_tv","text":"<pre><code>nb_squeeze_momentum_lazybear_tv(\n    candles,\n    length_bb,\n    length_kc,\n    multi_bb,\n    multi_kc,\n)\n</code></pre> <p>Returns = sqz_hist, sqz_on, no_sqz</p> <p>https://www.tradingview.com/script/nqQ1DT5a-Squeeze-Momentum-Indicator-LazyBear/</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_stdev_tv","title":"nb_stdev_tv","text":"<pre><code>nb_stdev_tv(\n    source,\n    length,\n)\n</code></pre> <p>Standard deviation https://www.tradingview.com/pine-script-reference/v5/#fun_ta.stdev</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_supertrend_tv","title":"nb_supertrend_tv","text":"<pre><code>nb_supertrend_tv(\n    candles,\n    atr_length,\n    factor,\n)\n</code></pre> <p>return super trend, direction Super Trend https://www.tradingview.com/pine-script-reference/v5/#fun_ta.supertrend</p>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_true_range_tv","title":"nb_true_range_tv","text":"<pre><code>nb_true_range_tv(\n    candles,\n)\n</code></pre>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_vwap_tv","title":"nb_vwap_tv","text":"<pre><code>nb_vwap_tv(\n    candles,\n)\n</code></pre>"},{"location":"quantfreedom/nb_funcs/nb_indicators/nb_indicators/#quantfreedom.nb_funcs.nb_indicators.nb_indicators.nb_wma_tv","title":"nb_wma_tv","text":"<pre><code>nb_wma_tv(\n    source,\n    length,\n)\n</code></pre> <p>Weighted Moving average https://www.tradingview.com/pine-script-reference/v5/#fun_ta.wma</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/","title":"nb_increase_position","text":""},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position-functions","title":"Functions","text":""},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position.nb_c_pl_ra_ps","title":"nb_c_pl_ra_ps","text":"<pre><code>nb_c_pl_ra_ps(\n    equity,\n    logger,\n    max_equity_risk_pct,\n    possible_loss,\n    risk_account_pct_size,\n    total_trades,\n)\n</code></pre> <p>Possible loss risk account percent size</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position.nb_c_too_b_s","title":"nb_c_too_b_s","text":"<pre><code>nb_c_too_b_s(\n    entry_size_asset,\n    logger,\n    max_asset_size,\n    min_asset_size,\n    stringer,\n)\n</code></pre> <p>Check if the asset size is too big or too small</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position.nb_c_total_trades","title":"nb_c_total_trades","text":"<pre><code>nb_c_total_trades(\n    average_entry,\n    logger,\n    market_fee_pct,\n    max_trades,\n    position_size_asset,\n    possible_loss,\n    sl_price,\n    stringer,\n    total_trades,\n)\n</code></pre> <p>Checking the total trades</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position.nb_min_asset_amount","title":"nb_min_asset_amount","text":"<pre><code>nb_min_asset_amount(\n    acc_ex_other,\n    logger,\n    nb_entry_calc_np,\n    nb_entry_calc_p,\n    order_info,\n    stringer,\n)\n</code></pre> <p>Setting your position size to the min amount the exchange will allow</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_increase_position/#quantfreedom.nb_funcs.nb_order_handler.nb_increase_position.nb_rpa_slbcb","title":"nb_rpa_slbcb","text":"<pre><code>nb_rpa_slbcb(\n    acc_ex_other,\n    logger,\n    nb_entry_calc_np,\n    nb_entry_calc_p,\n    order_info,\n    stringer,\n)\n</code></pre> <p>Risking percent of your account while also having your stop loss based open high low or close of a candle</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/","title":"nb_stop_loss","text":""},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/#quantfreedom.nb_funcs.nb_order_handler.nb_stop_loss-functions","title":"Functions","text":""},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/#quantfreedom.nb_funcs.nb_order_handler.nb_stop_loss.nb_check_move_sl_to_be","title":"nb_check_move_sl_to_be","text":"<pre><code>nb_check_move_sl_to_be(\n    average_entry,\n    can_move_sl_to_be,\n    current_candle,\n    logger,\n    market_fee_pct,\n    nb_move_sl_bool,\n    nb_zero_or_entry_calc,\n    price_tick_step,\n    sl_price,\n    sl_to_be_cb_type,\n    sl_to_be_when_pct,\n    stringer,\n)\n</code></pre> <p>Checking to see if we move the stop loss to break even</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/#quantfreedom.nb_funcs.nb_order_handler.nb_stop_loss.nb_check_move_tsl","title":"nb_check_move_tsl","text":"<pre><code>nb_check_move_tsl(\n    average_entry,\n    current_candle,\n    logger,\n    nb_move_sl_bool,\n    nb_sl_price_calc,\n    price_tick_step,\n    sl_price,\n    stringer,\n    trail_sl_bcb_type,\n    trail_sl_by_pct,\n    trail_sl_when_pct,\n)\n</code></pre> <p>Checking to see if we move the trailing stop loss</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/#quantfreedom.nb_funcs.nb_order_handler.nb_stop_loss.nb_cm_sl_to_be_pass","title":"nb_cm_sl_to_be_pass","text":"<pre><code>nb_cm_sl_to_be_pass(\n    average_entry,\n    can_move_sl_to_be,\n    current_candle,\n    logger,\n    market_fee_pct,\n    nb_move_sl_bool,\n    nb_zero_or_entry_calc,\n    price_tick_step,\n    sl_price,\n    sl_to_be_cb_type,\n    sl_to_be_when_pct,\n    stringer,\n)\n</code></pre> <p>Long stop loss to break even pass</p>"},{"location":"quantfreedom/nb_funcs/nb_order_handler/nb_stop_loss/#quantfreedom.nb_funcs.nb_order_handler.nb_stop_loss.nb_sl_based_on_candle_body","title":"nb_sl_based_on_candle_body","text":"<pre><code>nb_sl_based_on_candle_body(\n    bar_index,\n    candles,\n    logger,\n    nb_sl_bcb_price_getter,\n    nb_sl_price_calc,\n    price_tick_step,\n    sl_based_on_add_pct,\n    sl_based_on_lookback,\n    sl_bcb_type,\n    stringer,\n)\n</code></pre> <p>Long Stop Loss Based on Candle Body Calculator</p>"},{"location":"quantfreedom/nb_funcs/nb_simulate/nb_sim_base/","title":"nb_sim_base","text":""},{"location":"quantfreedom/nb_funcs/nb_simulate/nb_sim_base/#quantfreedom.nb_funcs.nb_simulate.nb_sim_base-classes","title":"Classes","text":""},{"location":"quantfreedom/nb_funcs/nb_simulate/nb_sim_base/#quantfreedom.nb_funcs.nb_simulate.nb_sim_base-functions","title":"Functions","text":""},{"location":"quantfreedom/nb_funcs/nb_simulate/nb_sim_df/","title":"nb_sim_df","text":""},{"location":"quantfreedom/nb_funcs/nb_simulate/nb_sim_df/#quantfreedom.nb_funcs.nb_simulate.nb_sim_df-classes","title":"Classes","text":""},{"location":"quantfreedom/nb_funcs/nb_strategies/nb_strategy/","title":"nb_strategy","text":""},{"location":"quantfreedom/nb_funcs/nb_strategies/nb_strategy/#quantfreedom.nb_funcs.nb_strategies.nb_strategy-functions","title":"Functions","text":""},{"location":"quantfreedom/order_handler/increase_position/","title":"increase_position","text":""},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position-classes","title":"Classes","text":""},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition","title":"IncreasePosition","text":""},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition-functions","title":"Functions","text":""},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.__init__","title":"__init__","text":"<pre><code>__init__(\n    asset_tick_step,\n    increase_position_type,\n    long_short,\n    market_fee_pct,\n    max_asset_size,\n    min_asset_size,\n    price_tick_step,\n    sl_strategy_type,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.__init__--summary","title":"Summary","text":"<p>Creates and sets the increase position class settings</p> <p>Parameters:</p> Name Type Description Default <code>asset_tick_step</code> <code>float</code> <p>asset_tick_step</p> required <code>increase_position_type</code> <code>IncreasePositionType</code> <p>How you want to process increasing your position</p> required <code>long_short</code> <code>str</code> <p>long or short</p> required <code>market_fee_pct</code> <code>float</code> <p>market_fee_pct</p> required <code>max_asset_size</code> <code>float</code> <p>max_asset_size</p> required <code>min_asset_size</code> <code>float</code> <p>min_asset_size</p> required <code>price_tick_step</code> <code>float</code> <p>price_tick_step</p> required <code>sl_strategy_type</code> <code>StopLossStrategyType</code> <p>how you want to process creating your stop loss</p> required"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_pl_ra_ps","title":"c_pl_ra_ps","text":"<pre><code>c_pl_ra_ps(\n    equity,\n    possible_loss,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_pl_ra_ps--summary","title":"Summary","text":"<p>Creates possible loss then checks if it is bigger than risk account percent size then returns the new possible loss and total trades</p> <p>Parameters:</p> Name Type Description Default <code>equity</code> <code>float</code> <p>equity</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>(int, int)</code> <p>possible_loss, total_trades</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_too_b_s","title":"c_too_b_s","text":"<pre><code>c_too_b_s(\n    entry_size_asset,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_too_b_s--summary","title":"Summary","text":"<p>Check if the asset size is too big or too small</p> <p>Parameters:</p> Name Type Description Default <code>entry_size_asset</code> <code>float</code> <p>entry size of the asset</p> required"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_total_trades","title":"c_total_trades","text":"<pre><code>c_total_trades(\n    average_entry,\n    possible_loss,\n    position_size_asset,\n    sl_price,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.c_total_trades--summary","title":"Summary","text":"<p>Creates possible loss then adds 1 to total trades then checks if total trades is bigger than max trades</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>position_size_asset</code> <code>float</code> <p>position_size_asset</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>tuple[int, int]</code> <p>possible_loss, total_trades</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.long_entry_size_np","title":"long_entry_size_np","text":"<pre><code>long_entry_size_np(\n    entry_price,\n    possible_loss,\n    sl_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.long_entry_size_np--summary","title":"Summary","text":"<p>Formula to calulcate the long entry size when we are not in a position and have our stop loss type set to stop loss based on candle body</p> <p>how to calculate pnl https://www.bybithelp.com/en-US/s/article/Profit-Loss-calculations-USDT-Contract</p> <p>math for the formula https://www.symbolab.com/solver/simplify-calculator/solve%20for%20u%2C%20%5Cleft(%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%5Cleft(x%20-%20e%5Cright)%5Cright)-%20%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%20e%5Ccdot%20m%5Cright)%20-%20%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%20x%5Ccdot%20m%5Cright)%20%5Cright)%3Dp?or=input</p> <p>Parameters:</p> Name Type Description Default <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>float</code> <p>entry_size_usd</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.long_entry_size_p","title":"long_entry_size_p","text":"<pre><code>long_entry_size_p(\n    average_entry,\n    entry_price,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.long_entry_size_p--summary","title":"Summary","text":"<p>Formula to calulcate the long entry size when we are in a position and have our stop loss type set to stop loss based on candle body</p> <p>how to calculate pnl https://www.bybithelp.com/en-US/s/article/Profit-Loss-calculations-USDT-Contract</p> <p>math for the formula https://www.symbolab.com/solver/simplify-calculator/solve%20for%20u%2C%20%5Cleft(%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%5Cleft(n%20-%20%5Cleft(%5Cfrac%7B%5Cleft(p%2Bu%5Cright)%7D%7B%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%7D%5Cright)%5Cright)%5Cright)-%20%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%5Cleft(%5Cfrac%7B%5Cleft(p%2Bu%5Cright)%7D%7B%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%7D%5Cright)%5Ccdot%20m%5Cright)%20-%20%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%20n%5Ccdot%20m%5Cright)%20%5Cright)%3D-f?or=input</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>float</code> <p>entry_size_usd</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_amount_np","title":"min_amount_np","text":"<pre><code>min_amount_np(\n    entry_price,\n    sl_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_amount_np--summary","title":"Summary","text":"<p>Setting the entry size to the minimum amount</p> <p>Parameters:</p> Name Type Description Default <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>tuple[float, float, float, float, float, float, int, int, float]</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_amount_p","title":"min_amount_p","text":"<pre><code>min_amount_p(\n    average_entry,\n    entry_price,\n    position_size_asset,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_amount_p--summary","title":"Summary","text":"<p>Setting the entry size to the minimum amount plus what ever position size we are already in</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>position_size_asset</code> <code>float</code> <p>position_size_asset</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>tuple[float, float, float, float, float, float, int, int, float]</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_asset_amount","title":"min_asset_amount","text":"<pre><code>min_asset_amount(\n    average_entry,\n    entry_price,\n    equity,\n    position_size_asset,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.min_asset_amount--summary","title":"Summary","text":"<p>Check if we are in a position or not and sending you to the correct function to handle that</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>equity</code> <code>float</code> <p>equity</p> required <code>position_size_asset</code> <code>float</code> <p>position_size_asset</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>(float, float, float, float, float, float, int, int, float)</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb","title":"rpa_slbcb","text":"<pre><code>rpa_slbcb(\n    equity,\n    average_entry,\n    entry_price,\n    position_size_asset,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb--summary","title":"Summary","text":"<p>Check if we are in a position or not and sending you to the correct function to handle that</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>equity</code> <code>float</code> <p>equity</p> required <code>position_size_asset</code> <code>float</code> <p>position_size_asset</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>(float, float, float, float, float, float, int, int, float)</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb_np","title":"rpa_slbcb_np","text":"<pre><code>rpa_slbcb_np(\n    equity,\n    entry_price,\n    sl_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb_np--summary","title":"Summary","text":"<p>Not in a position - Risking a percent of your account while also having your stop loss type set to stop loss based on candle body</p> <p>Parameters:</p> Name Type Description Default <code>equity</code> <code>float</code> <p>equity</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>tuple[float, float, float, float, float, float, int, int, float]</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb_p","title":"rpa_slbcb_p","text":"<pre><code>rpa_slbcb_p(\n    average_entry,\n    entry_price,\n    equity,\n    position_size_asset,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n    total_trades,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.rpa_slbcb_p--summary","title":"Summary","text":"<p>In a position - Risking a percent of your account while also having your stop loss type set to stop loss based on candle body</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>equity</code> <code>float</code> <p>equity</p> required <code>position_size_asset</code> <code>float</code> <p>position_size_asset</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <code>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>(float, float, float, float, float, float, int, int, float)</code> <p>average_entry, entry_price, entry_size_asset, entry_size_usd, position_size_asset, position_size_usd, possible_loss, total_trades, sl_pct</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.short_entry_size_np","title":"short_entry_size_np","text":"<pre><code>short_entry_size_np(\n    possible_loss,\n    sl_price,\n    entry_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.short_entry_size_np--summary","title":"Summary","text":"<p>Formula to calulcate the short entry size when we are not in a position and have our stop loss type set to stop loss based on candle body</p> <p>how to calculate pnl https://www.bybithelp.com/en-US/s/article/Profit-Loss-calculations-USDT-Contract</p> <p>math for the formula https://www.symbolab.com/solver/simplify-calculator/solve%20for%20u%2C%20%5Cleft(%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%5Cleft(e%20-%20x%5Cright)%5Cright)-%20%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%20e%5Ccdot%20m%5Cright)%20-%20%5Cleft(%5Cfrac%7Bu%7D%7Be%7D%5Ccdot%20x%5Ccdot%20m%5Cright)%20%5Cright)%3Dp?or=input</p> <p>Parameters:</p> Name Type Description Default <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>float</code> <p>entry_size_usd</p>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.short_entry_size_p","title":"short_entry_size_p","text":"<pre><code>short_entry_size_p(\n    average_entry,\n    entry_price,\n    position_size_usd,\n    possible_loss,\n    sl_price,\n)\n</code></pre>"},{"location":"quantfreedom/order_handler/increase_position/#quantfreedom.order_handler.increase_position.IncreasePosition.short_entry_size_p--summary","title":"Summary","text":"<p>Formula to calulcate the short entry size when we are in a position and have our stop loss type set to stop loss based on candle body</p> <p>how to calculate pnl https://www.bybithelp.com/en-US/s/article/Profit-Loss-calculations-USDT-Contract</p> <p>math for the formula https://www.symbolab.com/solver/simplify-calculator/solve%20for%20u%2C%20%5Cleft(%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%5Cleft(%5Cleft(%5Cfrac%7B%5Cleft(p%2Bu%5Cright)%7D%7B%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%7D%5Cright)-n%5Cright)%5Cright)-%20%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%5Cleft(%5Cfrac%7B%5Cleft(p%2Bu%5Cright)%7D%7B%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%7D%5Cright)%5Ccdot%20%20m%5Cright)%20-%20%5Cleft(%5Cleft(%5Cfrac%7Bp%7D%7Ba%7D%2B%5Cfrac%7Bu%7D%7Be%7D%5Cright)%5Ccdot%20%20n%5Ccdot%20%20m%5Cright)%20%5Cright)%3D-f?or=input</p> <p>Parameters:</p> Name Type Description Default <code>average_entry</code> <code>float</code> <p>average_entry</p> required <code>entry_price</code> <code>float</code> <p>entry_price</p> required <code>position_size_usd</code> <code>float</code> <p>position_size_usd</p> required <code>possible_loss</code> <code>float</code> <p>possible_loss</p> required <code>sl_price</code> <code>float</code> <p>sl_price</p> required <p>Returns:</p> Type Description <code>float</code> <p>entry_size_usd</p>"},{"location":"quantfreedom/order_handler/order/","title":"order","text":""},{"location":"quantfreedom/order_handler/order/#quantfreedom.order_handler.order-classes","title":"Classes","text":""},{"location":"quantfreedom/order_handler/stop_loss/","title":"stop_loss","text":""},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss-classes","title":"Classes","text":""},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss.StopLoss","title":"StopLoss","text":""},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss.StopLoss-functions","title":"Functions","text":""},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss.StopLoss.check_move_sl_to_be","title":"check_move_sl_to_be","text":"<pre><code>check_move_sl_to_be(\n    average_entry,\n    can_move_sl_to_be,\n    current_candle,\n    sl_price,\n)\n</code></pre> <p>Checking to see if we move the stop loss to break even</p>"},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss.StopLoss.check_move_tsl","title":"check_move_tsl","text":"<pre><code>check_move_tsl(\n    average_entry,\n    current_candle,\n    sl_price,\n)\n</code></pre> <p>Checking to see if we move the trailing stop loss</p>"},{"location":"quantfreedom/order_handler/stop_loss/#quantfreedom.order_handler.stop_loss.StopLoss.sl_based_on_candle_body","title":"sl_based_on_candle_body","text":"<pre><code>sl_based_on_candle_body(\n    bar_index,\n    candles,\n)\n</code></pre> <p>Long Stop Loss Based on Candle Body Calculator</p>"}]}
\ No newline at end of file
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index 08826a33ca0ab5cf125a413b7f7cece505bf3526..768d82ac512cda3979e5cc30477f6ffede0fca99 100755
GIT binary patch
delta 12
Tcmb=gXOr*d;1HQTk*yK{7LWse

delta 12
Tcmb=gXOr*d;MhHDB3mT@8P5bH