From 53dde2862242ca5f7101b93f11524b5a3023cf54 Mon Sep 17 00:00:00 2001
From: quantfreedom <quantfreedom1022@gmail.com>
Date: Wed, 10 Jul 2024 12:00:42 -0700
Subject: [PATCH] Deployed 11bdbcc with MkDocs version: 1.6.0

---
 {discord => link_instructions}/index.html |   16 +-
 search/search_index.json                  |    2 +-
 sitemap.xml.gz                            |  Bin 127 -> 127 bytes
 summary/index.html                        | 1305 ---------------------
 4 files changed, 9 insertions(+), 1314 deletions(-)
 rename {discord => link_instructions}/index.html (98%)
 delete mode 100755 summary/index.html

diff --git a/discord/index.html b/link_instructions/index.html
similarity index 98%
rename from discord/index.html
rename to link_instructions/index.html
index 6c34cfb..c757d74 100755
--- a/discord/index.html
+++ b/link_instructions/index.html
@@ -16,7 +16,7 @@
     
     
       
-        <title>Discord - QuantFreedom Docs</title>
+        <title>Link instructions - QuantFreedom Docs</title>
       
     
     
@@ -98,7 +98,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
             
-              Discord
+              Link instructions
             
           </span>
         </div>
@@ -1255,7 +1255,7 @@
   
 
 
-  <h1>Discord</h1>
+  <h1>Link instructions</h1>
 
 <div class="admonition warning">
 <p class="admonition-title">Warning</p>
@@ -1267,13 +1267,13 @@ <h2 id="step-1-follow-me-on-kick">Step 1: Follow me on kick<a class="headerlink"
 <h2 id="step-2-type-in-chat">Step 2: Type in chat<a class="headerlink" href="#step-2-type-in-chat" title="Permanent link">&para;</a></h2>
 <p>If i am not live you will have to click the chat menu to open up the chat</p>
 <p><img alt="alt text" src="../images/image-53.png" /></p>
-<p>For Discord:</p>
 <ul>
-<li>The chat is in follower only mode so you will have to be following in order to type !discord into the chat to get the discord link.</li>
+<li>The chat is in follower only mode so you will have to be following in order to get the link you want. Type any of the following commands to get the link you want<ul>
+<li>!discord</li>
+<li>!github</li>
+<li>!telegram</li>
 </ul>
-<p>For Github:</p>
-<ul>
-<li>The chat is in follower only mode so you will have to be following in order to type !github into the chat to get the github link.</li>
+</li>
 </ul>
 <h2 id="step3-thats-it">Step3: That's it<a class="headerlink" href="#step3-thats-it" title="Permanent link">&para;</a></h2>
 <p>That should be it. If it doesn't work then just type the problem you are having in the kick chat and i will check it out.</p>
diff --git a/search/search_index.json b/search/search_index.json
index 93b1584..8485533 100755
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"discord/","title":"Discord","text":"<p>Warning</p> <p>Read all the steps before you start actually doing them.</p>"},{"location":"discord/#step-1-follow-me-on-kick","title":"Step 1: Follow me on kick","text":"<p>First follow me on my kick, my live streaming platform, and turn notifications on. The reason is because the goal is to build a community where people can come and ask any questions and get live answers, share the knowledge that they have learned, because what is the point of a community if no one shares what they know and also meet other like minded people who are willing to help each other. Also the reason i stream here instead of twitch or youtube is because every time you play music that has copyrights to it then twitch and youtube start crying about it.</p> <p>https://kick.com/quantfreedom</p>"},{"location":"discord/#step-2-type-in-chat","title":"Step 2: Type in chat","text":"<p>If i am not live you will have to click the chat menu to open up the chat</p> <p></p> <p>For Discord:</p> <ul> <li>The chat is in follower only mode so you will have to be following in order to type !discord into the chat to get the discord link.</li> </ul> <p>For Github:</p> <ul> <li>The chat is in follower only mode so you will have to be following in order to type !github into the chat to get the github link.</li> </ul>"},{"location":"discord/#step3-thats-it","title":"Step3: That's it","text":"<p>That should be it. If it doesn't work then just type the problem you are having in the kick chat and i will check it out.</p>"},{"location":"nav_file/","title":"Nav file","text":"<ul> <li>Home<ul> <li>Installation</li> </ul> </li> <li>Services<ul> <li>Copy Trading Bot<ul> <li>Active Bots<ul> <li>RSI Rising Long 5m</li> </ul> </li> <li>Sign Up</li> </ul> </li> </ul> </li> <li>Beginners<ul> <li>Guide</li> </ul> </li> <li>Functions<ul> <li>core<ul> <li>enums</li> </ul> </li> <li>exchanges<ul> <li>binance_usdm</li> <li>bybit</li> <li>mufex</li> </ul> </li> <li>helpers<ul> <li>bsc_scan</li> <li>helper_funcs</li> <li>utils</li> </ul> </li> <li>indicators<ul> <li>tv_indicators</li> </ul> </li> <li>order_handler<ul> <li>increase_position</li> <li>stop_loss</li> </ul> </li> </ul> </li> </ul>"},{"location":"summary/","title":"Summary","text":"<ul> <li>quantfreedom<ul> <li>core<ul> <li>enums</li> </ul> </li> <li>exchanges<ul> <li>binance_usdm</li> <li>bybit</li> <li>mufex</li> </ul> </li> <li>helpers<ul> <li>bsc_scan</li> <li>helper_funcs</li> <li>utils</li> </ul> </li> <li>indicators<ul> <li>tv_indicators</li> </ul> </li> <li>order_handler<ul> <li>increase_position</li> <li>stop_loss</li> </ul> </li> </ul> </li> </ul>"},{"location":"beginners/guide/","title":"Beginners Guide","text":"<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</p> <ul> <li>https://www.youtube.com/playlist?list=PL-osiE80TeTskrapNbzXhwoFUiLCjGgY7</li> </ul> <p>working with classes</p> <ul> <li>https://www.youtube.com/playlist?list=PL-osiE80TeTsqhIuOqKhwlXsIBIdSeYtc</li> </ul> <p>then study the basics of numpy ... pick one of the playlists not all of them</p> <ul> <li>https://www.youtube.com/playlist?list=PLZGM26Bt_cku3VRraPDwzzqrav0_u8pDC</li> <li>https://www.youtube.com/playlist?list=PLc_Ps3DdrcTuf3e-BBpDv8r9jbOB5Wdv-</li> <li>https://www.youtube.com/playlist?list=PLCC34OHNcOtpalASMlX2HHdsLNipyyhbK</li> </ul> <p>study plotly</p> <ul> <li>https://www.youtube.com/playlist?list=PLBSCvBlTOLa8rf2kGkP_Bx5xXqT-er4Yq</li> </ul>"},{"location":"home/installation/","title":"Installation","text":"<p>Make sure you read the entire bullet point before you start doing what the bullet point says.</p>"},{"location":"home/installation/#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     <p></p></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     <p></p></li> </ul>"},{"location":"home/installation/#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. Ignore the 3.7.2 this is just an image to show you where to check add to path.     </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":"home/installation/#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 <p></p></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> <li>git config --global init.defaultBranch main</li> </ul>"},{"location":"home/installation/#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  <p></p> </li> </ul>"},{"location":"home/installation/#installing-extensions","title":"Installing Extensions","text":"<ul> <li> <p>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.  <p></p></p> </li> <li> <p>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  <p></p></p> </li> <li> <p>Python - python</p> </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  <p></p> </li> </ul>"},{"location":"home/installation/#creating-virtual-environment","title":"Creating virtual environment","text":"<p>This part isn't done yet but you will need to make your default profile the cmd or zrh ... then create a virtual env ... then select that env as your default interpreter</p> <ul> <li>Ctl shift p and type in default profile and then select \"Terminal: Select default profile\" </li> <li>Click on cmd prompt for windows and zsh for mac </li> <li>In the menu bar click on terminal then click new terminal </li> <li>Create a folder called coding wherever you want on your computer. I suggest anywhere that isn't your desktop. The best would be another hard drive that isn't your main hard drive</li> </ul>"},{"location":"home/installation/#not-finished-yet","title":"Not finished yet","text":""},{"location":"home/installation/#create-venv","title":"create venv","text":"<ul> <li>create a folder somehwere on your computer</li> <li>create a file inside that folder called my_keys.py</li> <li>Create venv</li> <li>python -m venv qfree</li> <li>now cd into qfree</li> <li>in the command line type echo (this should be the path to your folder) &gt; my_keys.pth</li> <li>example</li> <li>echo E:\\Coding\\my_keys &gt; my_keys.pth</li> <li>Scripts\\activate - this will activate the virtual enviromnelt</li> <li>Now you will see we have free to the left of the thing</li> <li></li> <li>Ctrlp shift p type in word interpreter</li> <li>Select python interpreter</li> <li>Then enter interpreter path</li> <li>Then find</li> <li>Then go to the coding folder then venvs then qfree then scripts then click on python.exe</li> <li>for mac you have to get the folder path to the python file and copy paste the whole path into the find section</li> <li></li> <li>Vscode file autosave</li> <li>Vscode search clone git repo then paste \u2026 select folder</li> <li>Now create new file called test.ipynb</li> <li></li> <li>Select kernel python en</li> <li></li> <li>Add this to settings.json</li> <li>\"editor.parameterHints.enabled\": false,</li> <li>\"python.terminal.activateEnvironment\": true,</li> <li>\"jupyter.debugJustMyCode\": false,</li> <li>\"debug.allowBreakpointsEverywhere\": true,</li> <li>\"debugpy.debugJustMyCode\": false</li> <li></li> <li>Create github</li> <li>Create repo</li> <li>Then download python</li> <li>Download vs code</li> <li>Then clone repo</li> <li>Then create venv</li> <li>Pip install quantfreedom</li> <li>Then select inpertere</li> <li>Then menu terminal new terminal</li> </ul>"},{"location":"quantfreedom/backtesters/bt_multi_bt/","title":"Bt multi bt","text":""},{"location":"quantfreedom/backtesters/bt_multi_bt/#quantfreedom.backtesters.bt_multi_bt-functions","title":"Functions","text":""},{"location":"quantfreedom/backtesters/bt_or_bt/","title":"Bt or bt","text":""},{"location":"quantfreedom/backtesters/bt_or_bt/#quantfreedom.backtesters.bt_or_bt-functions","title":"Functions","text":""},{"location":"quantfreedom/core/enums/","title":"enums","text":""},{"location":"quantfreedom/core/enums/#quantfreedom.core.enums-classes","title":"Classes","text":""},{"location":"quantfreedom/core/enums/#quantfreedom.core.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"},{"location":"quantfreedom/core/enums/#quantfreedom.core.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/core/enums/#quantfreedom.core.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/core/enums/#quantfreedom.core.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/core/strategy/","title":"Strategy","text":""},{"location":"quantfreedom/core/strategy/#quantfreedom.core.strategy-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/binance_usdm/","title":"binance_usdm","text":""},{"location":"quantfreedom/exchanges/binance_usdm/#quantfreedom.exchanges.binance_usdm-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/binance_usdm/#quantfreedom.exchanges.binance_usdm.BinanceUSDM","title":"BinanceUSDM","text":"<p>               Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/binance_usdm/#quantfreedom.exchanges.binance_usdm.BinanceUSDM-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/binance_usdm/#quantfreedom.exchanges.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_usdm/#quantfreedom.exchanges.binance_usdm.BinanceUSDM.get_candles","title":"get_candles","text":"<pre><code>get_candles(symbol, timeframe, since_datetime=None, until_datetime=None, candles_to_dl=1500)\n</code></pre> Summary <p>Biance USDM candle docs</p> Explainer Video <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 get_symbols_list if you need to know the symbols</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_usdm/#quantfreedom.exchanges.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_usdm/#quantfreedom.exchanges.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/","title":"bybit","text":""},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit","title":"Bybit","text":"<p>               Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.__init__","title":"__init__","text":"<pre><code>__init__(use_testnet, api_key=None, secret_key=None)\n</code></pre> <p>main docs page https://bybit-exchange.github.io/docs/v5/intro upgrade to unified account</p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.adjust_order","title":"adjust_order","text":"<pre><code>adjust_order(symbol, asset_size=None, category='linear', custom_order_id=None, orderIv=None, order_id=None, price=None, slLimitPrice=None, slTriggerBy=None, stopLoss=None, takeProfit=None, tpLimitPrice=None, tpslMode=None, tpTriggerBy=None, triggerBy=None, triggerPrice=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.cancel_all_open_orders","title":"cancel_all_open_orders","text":"<pre><code>cancel_all_open_orders(symbol=None, category='linear', baseCoin=None, settleCoin=None, orderFilter=None, stopOrderType=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.close_hedge_positions_and_orders","title":"close_hedge_positions_and_orders","text":"<pre><code>close_hedge_positions_and_orders(symbol=None, settleCoin=None)\n</code></pre> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <code>None</code>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.create_order","title":"create_order","text":"<pre><code>create_order(symbol, buy_sell, position_mode, order_type, asset_size, category='linear', time_in_force='GTC', price=None, triggerDirection=None, triggerPrice=None, triggerBy=None, tpTriggerBy=None, slTriggerBy=None, custom_order_id=None, takeProfit=None, stopLoss=None, reduce_only=None, closeOnTrigger=None, isLeverage=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_all_symbols_info","title":"get_all_symbols_info","text":"<pre><code>get_all_symbols_info(category='linear', limit=500, symbol=None, status=None, baseCoin=None)\n</code></pre> <p>Bybit API link to Get Instrument Info</p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_candles","title":"get_candles","text":"<pre><code>get_candles(symbol, timeframe, since_datetime=None, until_datetime=None, candles_to_dl=1000, category='linear')\n</code></pre> Summary <p>Bybit candle docs</p> Explainer Video <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/#quantfreedom.exchanges.bybit.Bybit.get_closed_pnl","title":"get_closed_pnl","text":"<pre><code>get_closed_pnl(symbol, limit=50, since_datetime=None, until_datetime=None, category='linear')\n</code></pre> <p>Bybit API link to Get Closed Profit and Loss</p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_open_orders","title":"get_open_orders","text":"<pre><code>get_open_orders(symbol, baseCoin=None, category='linear', custom_order_id=None, limit=50, orderFilter=None, orderStatus=None, order_id=None, settleCoin=None, since_datetime=None, until_datetime=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_order_history","title":"get_order_history","text":"<pre><code>get_order_history(baseCoin=None, category='linear', custom_order_id=None, limit=50, orderFilter=None, orderStatus=None, order_id=None, settleCoin=None, since_datetime=None, symbol=None, until_datetime=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_position_info","title":"get_position_info","text":"<pre><code>get_position_info(symbol=None, baseCoin=None, category='linear', limit=50, settleCoin=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_risk_limit_info","title":"get_risk_limit_info","text":"<pre><code>get_risk_limit_info(symbol, category='linear')\n</code></pre> <p>Bybit API link to Get Risk Limit</p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.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/#quantfreedom.exchanges.bybit.Bybit.get_trading_fee_rates","title":"get_trading_fee_rates","text":"<pre><code>get_trading_fee_rates(symbol=None, baseCoin=None, category='linear')\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_wallet_info","title":"get_wallet_info","text":"<pre><code>get_wallet_info(accountType='UNIFIED', trading_with=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.set_leverage","title":"set_leverage","text":"<pre><code>set_leverage(symbol, leverage, category='linear')\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.set_leverage_mode","title":"set_leverage_mode","text":"<pre><code>set_leverage_mode(setMarginMode='ISOLATED_MARGIN')\n</code></pre> <p>ISOLATED_MARGIN, REGULAR_MARGIN(i.e. Cross margin), PORTFOLIO_MARGIN</p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.set_position_mode","title":"set_position_mode","text":"<pre><code>set_position_mode(position_mode, symbol, category='linear', trading_with=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/","title":"mufex","text":""},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex","title":"Mufex","text":"<p>               Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.__init__","title":"__init__","text":"<pre><code>__init__(use_testnet, api_key=None, secret_key=None)\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/#quantfreedom.exchanges.mufex.Mufex.adjust_order","title":"adjust_order","text":"<pre><code>adjust_order(params={})\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/#quantfreedom.exchanges.mufex.Mufex.cancel_all_open_orders_per_symbol","title":"cancel_all_open_orders_per_symbol","text":"<pre><code>cancel_all_open_orders_per_symbol(symbol)\n</code></pre> <p>no link yet</p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.cancel_open_order","title":"cancel_open_order","text":"<pre><code>cancel_open_order(symbol, order_id=None, custom_order_id=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.close_hedge_positions_and_orders","title":"close_hedge_positions_and_orders","text":"<pre><code>close_hedge_positions_and_orders(symbol=None, settleCoin=None)\n</code></pre> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <code>None</code>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.create_order","title":"create_order","text":"<pre><code>create_order(symbol, buy_sell, position_mode, order_type, asset_size, time_in_force='GoodTillCancel', price=None, triggerDirection=None, triggerPrice=None, triggerBy=None, tpTriggerBy=None, slTriggerBy=None, custom_order_id=None, takeProfit=None, stopLoss=None, reduce_only=None, closeOnTrigger=None)\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/#quantfreedom.exchanges.mufex.Mufex.get_all_symbols_info","title":"get_all_symbols_info","text":"<pre><code>get_all_symbols_info(category='linear', limit=1000, symbol=None)\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/#quantfreedom.exchanges.mufex.Mufex.get_candles","title":"get_candles","text":"<pre><code>get_candles(symbol, timeframe, since_datetime=None, until_datetime=None, candles_to_dl=1500, category='linear')\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/#quantfreedom.exchanges.mufex.Mufex.get_closed_pnl","title":"get_closed_pnl","text":"<pre><code>get_closed_pnl(symbol, limit=200, since_datetime=None, until_datetime=None)\n</code></pre> <p>Mufex API link to Get Closed Profit and Loss</p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.get_filled_orders","title":"get_filled_orders","text":"<pre><code>get_filled_orders(symbol, limit=200, since_datetime=None, until_datetime=None, execType=None, order_id=None)\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/#quantfreedom.exchanges.mufex.Mufex.get_open_orders","title":"get_open_orders","text":"<pre><code>get_open_orders(symbol, limit=50, order_id=None, custom_order_id=None, orderFilter=None)\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/#quantfreedom.exchanges.mufex.Mufex.get_order_history","title":"get_order_history","text":"<pre><code>get_order_history(symbol, limit=50, order_id=None, custom_order_id=None, orderStatus=None, orderFilter=None)\n</code></pre> <p>use link to see all Request Parameters</p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.get_position_info","title":"get_position_info","text":"<pre><code>get_position_info(symbol=None, settleCoin=None, limit=50)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.get_risk_limit_info","title":"get_risk_limit_info","text":"<pre><code>get_risk_limit_info(symbol, category='linear')\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/#quantfreedom.exchanges.mufex.Mufex.get_symbol_trading_fee_rates","title":"get_symbol_trading_fee_rates","text":"<pre><code>get_symbol_trading_fee_rates(symbol=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.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/#quantfreedom.exchanges.mufex.Mufex.get_trading_fee_rates","title":"get_trading_fee_rates","text":"<pre><code>get_trading_fee_rates(symbol=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.get_wallet_info","title":"get_wallet_info","text":"<pre><code>get_wallet_info(trading_with=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.set_leverage","title":"set_leverage","text":"<pre><code>set_leverage(symbol, leverage)\n</code></pre> <p>No link yet</p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.set_leverage_mode","title":"set_leverage_mode","text":"<pre><code>set_leverage_mode(symbol, leverage_mode, leverage=5)\n</code></pre> <p>Cross/isolated mode. 0: cross margin mode; 1: isolated margin mode</p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.set_position_mode","title":"set_position_mode","text":"<pre><code>set_position_mode(position_mode, trading_with=None, symbol=None)\n</code></pre>"},{"location":"quantfreedom/helpers/bsc_scan/","title":"bsc_scan","text":""},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan-classes","title":"Classes","text":""},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan","title":"BSC_Scan","text":""},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan-functions","title":"Functions","text":""},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.check_contract_execution_status","title":"check_contract_execution_status","text":"<pre><code>check_contract_execution_status(tx_hash)\n</code></pre> <p>Check Contract Execution Status</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.check_transaction_receipt_status","title":"check_transaction_receipt_status","text":"<pre><code>check_transaction_receipt_status(tx_hash)\n</code></pre> <p>Check Transaction Receipt Status</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_bnb_balance_for_address","title":"get_bnb_balance_for_address","text":"<pre><code>get_bnb_balance_for_address(address)\n</code></pre> <p>Get BNB Balance for Address</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_transaction_by_hash","title":"get_transaction_by_hash","text":"<pre><code>get_transaction_by_hash(tx_hash, address, contractaddress='0x55d398326f99059fF775485246999027B3197955', startblock=0, endblock=99999999, page=1, offset=1000, sort='desc')\n</code></pre> <p>Default contract address is USDT</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_transaction_value_by_hash","title":"get_transaction_value_by_hash","text":"<pre><code>get_transaction_value_by_hash(tx_hash, address, contractaddress='0x55d398326f99059fF775485246999027B3197955', startblock=0, endblock=99999999, page=1, offset=1000, sort='desc')\n</code></pre> <p>Default contract address is USDT</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_transactions","title":"get_transactions","text":"<pre><code>get_transactions(address, contractaddress='0x55d398326f99059fF775485246999027B3197955', startblock=0, endblock=99999999, page=1, offset=1000, sort='desc')\n</code></pre> <p>Get a list of 'Normal' Transactions By Address</p> <p>Default contract address is USDT</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_transactions_by_from_address","title":"get_transactions_by_from_address","text":"<pre><code>get_transactions_by_from_address(from_address, address, contractaddress='0x55d398326f99059fF775485246999027B3197955', startblock=0, endblock=99999999, page=1, offset=1000, sort='desc')\n</code></pre> <p>Default contract address is USDT</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_user_payment_amount","title":"get_user_payment_amount","text":"<pre><code>get_user_payment_amount(tx_hash, from_address, address, contractaddress='0x55d398326f99059fF775485246999027B3197955', startblock=0, endblock=99999999, page=1, offset=1000, sort='desc')\n</code></pre> <p>Default contract address is USDT</p>"},{"location":"quantfreedom/helpers/helper_funcs/","title":"helper_funcs","text":""},{"location":"quantfreedom/helpers/helper_funcs/#quantfreedom.helpers.helper_funcs-classes","title":"Classes","text":""},{"location":"quantfreedom/helpers/helper_funcs/#quantfreedom.helpers.helper_funcs-functions","title":"Functions","text":""},{"location":"quantfreedom/helpers/helper_funcs/#quantfreedom.helpers.helper_funcs.candles_to_df","title":"candles_to_df","text":"<pre><code>candles_to_df(candles)\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>ndarray</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/helpers/helper_funcs/#quantfreedom.helpers.helper_funcs.dl_ex_candles","title":"dl_ex_candles","text":"<pre><code>dl_ex_candles(exchange, symbol, timeframe, candles_to_dl=None, since_datetime=None, until_datetime=None)\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 futures = 'binance_usdm' | default candles to dl is 1500</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/helpers/utils/","title":"utils","text":""},{"location":"quantfreedom/helpers/utils/#quantfreedom.helpers.utils-functions","title":"Functions","text":""},{"location":"quantfreedom/helpers/utils/#quantfreedom.helpers.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/helpers/utils/#quantfreedom.helpers.utils.delete_dir","title":"delete_dir","text":"<pre><code>delete_dir(p)\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/helpers/utils/#quantfreedom.helpers.utils.generate_candles","title":"generate_candles","text":"<pre><code>generate_candles(number_of_candles=100, plot_candles=False, seed=None)\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/helpers/utils/#quantfreedom.helpers.utils.pretty_qf","title":"pretty_qf","text":"<pre><code>pretty_qf(named_tuple)\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/helpers/utils/#quantfreedom.helpers.utils.pretty_qf_string","title":"pretty_qf_string","text":"<pre><code>pretty_qf_string(named_tuple)\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/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(candles, length, smoothing_type=rma_tv)\n</code></pre> <p>Average true range smoothing from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(length, multi, source, basis_ma_type=sma_tv)\n</code></pre> <p>Bollinger bands from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(candles, length)\n</code></pre> <p>Donchain channels</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(source, length)\n</code></pre> <p>Exponential Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(candles, lin_reg_length, smoothing_length, smoothing_type=sma_tv)\n</code></pre> <p>Linear regression indicator</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(source, fast_length, slow_length, signal_smoothing, oscillator_type=ema_tv, signal_ma_type=ema_tv)\n</code></pre> <p>Moving average convergence divergence from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(source, length)\n</code></pre> <p>Relative strength index Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(source_1, source_2, length)\n</code></pre> <p>Relative strength index Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source_1</code> <code>ndarray</code> <p>Values to process</p> required <code>source_2</code> <code>ndarray</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(length, source)\n</code></pre> <p>Relative strength index</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(source, length)\n</code></pre> <p>Simple Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(candles, length_bb, length_kc, multi_bb, multi_kc)\n</code></pre> <p>LazyBear Pinescript</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(source, length)\n</code></pre> <p>Standard deviation from tradingview</p> <p>Explainer Video</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(candles, atr_length, factor)\n</code></pre> <p>Super Trend</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(candles)\n</code></pre> <p>True Range from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(candles)\n</code></pre> <p>Volume Weighted Average Price</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(source, length)\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>ndarray</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/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__(asset_tick_step, increase_position_type, long_short, market_fee_pct, max_asset_size, min_asset_size, price_tick_step, sl_strategy_type)\n</code></pre> Summary <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(equity, total_trades)\n</code></pre> Summary <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>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>(int, int)</code> <p>total_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(entry_size_asset)\n</code></pre> Summary <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(average_entry, position_size_asset, sl_price, total_trades)\n</code></pre> Summary <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>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>total_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(entry_price, sl_price, total_possible_loss)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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(average_entry, entry_price, position_size_usd, sl_price, total_possible_loss)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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(entry_price, sl_price)\n</code></pre> Summary <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, total_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(average_entry, entry_price, position_size_asset, position_size_usd, sl_price, total_trades)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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, total_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(average_entry, entry_price, equity, position_size_asset, position_size_usd, sl_price, total_trades)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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, total_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(equity, average_entry, entry_price, position_size_asset, position_size_usd, sl_price, total_trades)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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, total_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(equity, entry_price, sl_price)\n</code></pre> Summary <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, total_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(average_entry, entry_price, equity, position_size_asset, position_size_usd, sl_price, total_trades)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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, total_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(sl_price, entry_price, total_possible_loss)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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(average_entry, entry_price, position_size_usd, sl_price, total_possible_loss)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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(average_entry, can_move_sl_to_be, current_candle, sl_price)\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_close","title":"check_move_tsl_close","text":"<pre><code>check_move_tsl_close(average_entry, current_candle, sl_price)\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.check_move_tsl_pct","title":"check_move_tsl_pct","text":"<pre><code>check_move_tsl_pct(average_entry, current_candle, sl_price)\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(bar_index, candles)\n</code></pre> <p>Long Stop Loss Based on Candle Body Calculator</p>"},{"location":"services/copy_trading/","title":"Copy Trading Bot","text":"<p>If you want one month completely for free then make sure you read the following instructions ... All you will have to do is provide your API keys and its go time!</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> <p>You will need to manage the bot by turning it off or on based on if you think it would be a good time to run the bot.</p> <p>To get the Free month you need to do the following</p>"},{"location":"services/copy_trading/#free-month-part-1-follow-me","title":"Free Month Part 1: Follow Me","text":"<ul> <li>If you don't have an account for the following social medias then just make one.</li> <li>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>Make sure you screen shot all of these so I know that you have actually followed and post them in the follow screenshots channel.</li> <li>Follow me on Twitter</li> <li>Follow me on Instagram</li> <li>Follow me on Youtube</li> <li>Star the github project <p> <li>This most important one is to follow me on kick, because i will be live streaming there and doing react content.</li> <li>Follow me on Kick and turn on notifications</li>"},{"location":"services/copy_trading/#free-month-part-2-reach-out","title":"Free Month Part 2: Reach Out","text":"<p>You will need to reach out to this person and tell them to do a collaboration with me. You have three options to do this</p> <ul> <li>Quote tweet me and tell the person why you think they should do a collab with me. Say something real, not something stupid like \"just doing this so i can get 50% off\". I don't want to give you an example of what to say because then everyone will say the same thing and the person will think its a bot. The Tweet</li> <li>Tweet to the person yourself and tell them to collab with me Their Twitter</li> <li>Email the person and tell them to collab with me. Their Email</li> <li>For the tweet or email make sure you include a link to my youtube.</li> </ul>"},{"location":"services/copy_trading/#free-month-part-3-finished","title":"Free Month Part 3: Finished","text":"<p>Once you have done those two things then follow the rest of the directions and when you sign up you will get the Free Month automatically applied.</p>"},{"location":"services/copy_trading/#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, coinbase or any exchange to buy some crypto like USDT, ETH, BTC or something and then switch it over to USDT on an exchange like phemex. If you really have no idea then please watch some youtube videos on how to do it.</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.</li> <li>Mufex</li> <li>Bybit</li> </ul>"},{"location":"services/copy_trading/#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> </ul>"},{"location":"services/copy_trading/#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.     <p><p></p> <li>Now select USDT as your token then select bnb smart chain and then copy the address     <p></p></li> <li>Go to your wallet that has the 100 or more USDT and transfer the USDT to your deposit address and make sure you are using the bnb smart chain.</li> <ul> <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     <p></p></li> </ul>"},{"location":"services/copy_trading/#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":"services/copy_trading/#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 deposit and create your api key.</li> </ul>"},{"location":"services/copy_trading/#bybit-deposit","title":"Bybit Deposit","text":"<ul> <li>Depositing should be pretty straight forward. You click on your assets then click deposit and then select the coin which should be USDT and the network should be bnb chain.</li> <li>Then go to your other wallet where your USDT is and send the money from your usdt wallet to your bybit.</li> <li>If you still don't know how to do this try to watch either of these videos but make sure your network chain is the same from your other wallet to your bybit wallet.</li> <li>Video 1 Video 2</li> <li>Watch either video all the way through and then take action. Don't watch a little because you might miss something.</li> </ul>"},{"location":"services/copy_trading/#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>"},{"location":"services/copy_trading/#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>In here you will post the following: A screen shot of you following me on all the social media accounts.</li> <li>You have at least 100 dollars in your crpyto exchange account</li> <li>you have your api keys ready and for bybit users that you have verified your account is unified</li> <li>You will now go to the Quant freedom portal and register an account.     </li> <li>Once you have registered an account you will need to add your exchange by clicking on the exchange menu link.</li> <li>Once you have made your exchange you will need to add the wallet that you will be making the payment from. Your withdrawl address because the website will verify your payment through your wallet address.</li> <li>Then you will go to the payments tab and select copy trading and then follow the directions.</li> <li>once your payment is verified then you will go to the strategies menu and select the strategy you want to follow</li> </ul>"},{"location":"services/copy_trading/#faq","title":"FAQ","text":"<ul> <li>why are you doing this?<ul> <li>I am doing this because a lot of people just want to follow a strategy so why not let them.</li> </ul> </li> <li>How much does it cost?<ul> <li>It is originally 20 dollars a month but if you follow the 50% off you will get it for 10 dollars a month</li> </ul> </li> <li>Are there any refuneds?<ul> <li>No there are no refunds.</li> </ul> </li> <li>Why does this cost money?<ul> <li>You are only helping pay for the fee of what i have to pay for the AWS cloud.</li> </ul> </li> <li>Which exchanges does this work on?<ul> <li>right now only mufex and bybit.</li> </ul> </li> </ul>"},{"location":"services/active_strategies/rsi_rising_long_5m/","title":"RSI Rising Long 5m","text":""},{"location":"services/active_strategies/rsi_rising_long_5m/#info-about-the-strat","title":"Info about the strat","text":"<ul> <li>Name: RSI Rising Falling</li> <li>Long trades only</li> <li>5 min time frame</li> <li>BTC/USDT</li> <li>Mufex and bybit exchanges</li> <li>It was able to make 375x profit. From 1k starting to 375K ending during an uptrend backtest</li> <li>It takes trades when the rsi drops then comes back up like a V shape.</li> </ul>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"link_instructions/","title":"Link instructions","text":"<p>Warning</p> <p>Read all the steps before you start actually doing them.</p>"},{"location":"link_instructions/#step-1-follow-me-on-kick","title":"Step 1: Follow me on kick","text":"<p>First follow me on my kick, my live streaming platform, and turn notifications on. The reason is because the goal is to build a community where people can come and ask any questions and get live answers, share the knowledge that they have learned, because what is the point of a community if no one shares what they know and also meet other like minded people who are willing to help each other. Also the reason i stream here instead of twitch or youtube is because every time you play music that has copyrights to it then twitch and youtube start crying about it.</p> <p>https://kick.com/quantfreedom</p>"},{"location":"link_instructions/#step-2-type-in-chat","title":"Step 2: Type in chat","text":"<p>If i am not live you will have to click the chat menu to open up the chat</p> <p></p> <ul> <li>The chat is in follower only mode so you will have to be following in order to get the link you want. Type any of the following commands to get the link you want<ul> <li>!discord</li> <li>!github</li> <li>!telegram</li> </ul> </li> </ul>"},{"location":"link_instructions/#step3-thats-it","title":"Step3: That's it","text":"<p>That should be it. If it doesn't work then just type the problem you are having in the kick chat and i will check it out.</p>"},{"location":"nav_file/","title":"Nav file","text":"<ul> <li>Home<ul> <li>Installation</li> </ul> </li> <li>Services<ul> <li>Copy Trading Bot<ul> <li>Active Bots<ul> <li>RSI Rising Long 5m</li> </ul> </li> <li>Sign Up</li> </ul> </li> </ul> </li> <li>Beginners<ul> <li>Guide</li> </ul> </li> <li>Functions<ul> <li>core<ul> <li>enums</li> </ul> </li> <li>exchanges<ul> <li>binance_usdm</li> <li>bybit</li> <li>mufex</li> </ul> </li> <li>helpers<ul> <li>bsc_scan</li> <li>helper_funcs</li> <li>utils</li> </ul> </li> <li>indicators<ul> <li>tv_indicators</li> </ul> </li> <li>order_handler<ul> <li>increase_position</li> <li>stop_loss</li> </ul> </li> </ul> </li> </ul>"},{"location":"beginners/guide/","title":"Beginners Guide","text":"<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</p> <ul> <li>https://www.youtube.com/playlist?list=PL-osiE80TeTskrapNbzXhwoFUiLCjGgY7</li> </ul> <p>working with classes</p> <ul> <li>https://www.youtube.com/playlist?list=PL-osiE80TeTsqhIuOqKhwlXsIBIdSeYtc</li> </ul> <p>then study the basics of numpy ... pick one of the playlists not all of them</p> <ul> <li>https://www.youtube.com/playlist?list=PLZGM26Bt_cku3VRraPDwzzqrav0_u8pDC</li> <li>https://www.youtube.com/playlist?list=PLc_Ps3DdrcTuf3e-BBpDv8r9jbOB5Wdv-</li> <li>https://www.youtube.com/playlist?list=PLCC34OHNcOtpalASMlX2HHdsLNipyyhbK</li> </ul> <p>study plotly</p> <ul> <li>https://www.youtube.com/playlist?list=PLBSCvBlTOLa8rf2kGkP_Bx5xXqT-er4Yq</li> </ul>"},{"location":"home/installation/","title":"Installation","text":"<p>Make sure you read the entire bullet point before you start doing what the bullet point says.</p>"},{"location":"home/installation/#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     <p></p></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     <p></p></li> </ul>"},{"location":"home/installation/#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. Ignore the 3.7.2 this is just an image to show you where to check add to path.     </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":"home/installation/#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 <p></p></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> <li>git config --global init.defaultBranch main</li> </ul>"},{"location":"home/installation/#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  <p></p> </li> </ul>"},{"location":"home/installation/#installing-extensions","title":"Installing Extensions","text":"<ul> <li> <p>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.  <p></p></p> </li> <li> <p>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  <p></p></p> </li> <li> <p>Python - python</p> </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  <p></p> </li> </ul>"},{"location":"home/installation/#creating-virtual-environment","title":"Creating virtual environment","text":"<p>This part isn't done yet but you will need to make your default profile the cmd or zrh ... then create a virtual env ... then select that env as your default interpreter</p> <ul> <li>Ctl shift p and type in default profile and then select \"Terminal: Select default profile\" </li> <li>Click on cmd prompt for windows and zsh for mac </li> <li>In the menu bar click on terminal then click new terminal </li> <li>Create a folder called coding wherever you want on your computer. I suggest anywhere that isn't your desktop. The best would be another hard drive that isn't your main hard drive</li> </ul>"},{"location":"home/installation/#not-finished-yet","title":"Not finished yet","text":""},{"location":"home/installation/#create-venv","title":"create venv","text":"<ul> <li>create a folder somehwere on your computer</li> <li>create a file inside that folder called my_keys.py</li> <li>Create venv</li> <li>python -m venv qfree</li> <li>now cd into qfree</li> <li>in the command line type echo (this should be the path to your folder) &gt; my_keys.pth</li> <li>example</li> <li>echo E:\\Coding\\my_keys &gt; my_keys.pth</li> <li>Scripts\\activate - this will activate the virtual enviromnelt</li> <li>Now you will see we have free to the left of the thing</li> <li></li> <li>Ctrlp shift p type in word interpreter</li> <li>Select python interpreter</li> <li>Then enter interpreter path</li> <li>Then find</li> <li>Then go to the coding folder then venvs then qfree then scripts then click on python.exe</li> <li>for mac you have to get the folder path to the python file and copy paste the whole path into the find section</li> <li></li> <li>Vscode file autosave</li> <li>Vscode search clone git repo then paste \u2026 select folder</li> <li>Now create new file called test.ipynb</li> <li></li> <li>Select kernel python en</li> <li></li> <li>Add this to settings.json</li> <li>\"editor.parameterHints.enabled\": false,</li> <li>\"python.terminal.activateEnvironment\": true,</li> <li>\"jupyter.debugJustMyCode\": false,</li> <li>\"debug.allowBreakpointsEverywhere\": true,</li> <li>\"debugpy.debugJustMyCode\": false</li> <li></li> <li>Create github</li> <li>Create repo</li> <li>Then download python</li> <li>Download vs code</li> <li>Then clone repo</li> <li>Then create venv</li> <li>Pip install quantfreedom</li> <li>Then select inpertere</li> <li>Then menu terminal new terminal</li> </ul>"},{"location":"quantfreedom/backtesters/bt_multi_bt/","title":"Bt multi bt","text":""},{"location":"quantfreedom/backtesters/bt_multi_bt/#quantfreedom.backtesters.bt_multi_bt-functions","title":"Functions","text":""},{"location":"quantfreedom/backtesters/bt_or_bt/","title":"Bt or bt","text":""},{"location":"quantfreedom/backtesters/bt_or_bt/#quantfreedom.backtesters.bt_or_bt-functions","title":"Functions","text":""},{"location":"quantfreedom/core/enums/","title":"enums","text":""},{"location":"quantfreedom/core/enums/#quantfreedom.core.enums-classes","title":"Classes","text":""},{"location":"quantfreedom/core/enums/#quantfreedom.core.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"},{"location":"quantfreedom/core/enums/#quantfreedom.core.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/core/enums/#quantfreedom.core.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/core/enums/#quantfreedom.core.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/core/strategy/","title":"Strategy","text":""},{"location":"quantfreedom/core/strategy/#quantfreedom.core.strategy-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/binance_usdm/","title":"binance_usdm","text":""},{"location":"quantfreedom/exchanges/binance_usdm/#quantfreedom.exchanges.binance_usdm-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/binance_usdm/#quantfreedom.exchanges.binance_usdm.BinanceUSDM","title":"BinanceUSDM","text":"<p>               Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/binance_usdm/#quantfreedom.exchanges.binance_usdm.BinanceUSDM-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/binance_usdm/#quantfreedom.exchanges.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_usdm/#quantfreedom.exchanges.binance_usdm.BinanceUSDM.get_candles","title":"get_candles","text":"<pre><code>get_candles(symbol, timeframe, since_datetime=None, until_datetime=None, candles_to_dl=1500)\n</code></pre> Summary <p>Biance USDM candle docs</p> Explainer Video <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 get_symbols_list if you need to know the symbols</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_usdm/#quantfreedom.exchanges.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_usdm/#quantfreedom.exchanges.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/","title":"bybit","text":""},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit","title":"Bybit","text":"<p>               Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.__init__","title":"__init__","text":"<pre><code>__init__(use_testnet, api_key=None, secret_key=None)\n</code></pre> <p>main docs page https://bybit-exchange.github.io/docs/v5/intro upgrade to unified account</p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.adjust_order","title":"adjust_order","text":"<pre><code>adjust_order(symbol, asset_size=None, category='linear', custom_order_id=None, orderIv=None, order_id=None, price=None, slLimitPrice=None, slTriggerBy=None, stopLoss=None, takeProfit=None, tpLimitPrice=None, tpslMode=None, tpTriggerBy=None, triggerBy=None, triggerPrice=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.cancel_all_open_orders","title":"cancel_all_open_orders","text":"<pre><code>cancel_all_open_orders(symbol=None, category='linear', baseCoin=None, settleCoin=None, orderFilter=None, stopOrderType=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.close_hedge_positions_and_orders","title":"close_hedge_positions_and_orders","text":"<pre><code>close_hedge_positions_and_orders(symbol=None, settleCoin=None)\n</code></pre> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <code>None</code>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.create_order","title":"create_order","text":"<pre><code>create_order(symbol, buy_sell, position_mode, order_type, asset_size, category='linear', time_in_force='GTC', price=None, triggerDirection=None, triggerPrice=None, triggerBy=None, tpTriggerBy=None, slTriggerBy=None, custom_order_id=None, takeProfit=None, stopLoss=None, reduce_only=None, closeOnTrigger=None, isLeverage=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_all_symbols_info","title":"get_all_symbols_info","text":"<pre><code>get_all_symbols_info(category='linear', limit=500, symbol=None, status=None, baseCoin=None)\n</code></pre> <p>Bybit API link to Get Instrument Info</p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_candles","title":"get_candles","text":"<pre><code>get_candles(symbol, timeframe, since_datetime=None, until_datetime=None, candles_to_dl=1000, category='linear')\n</code></pre> Summary <p>Bybit candle docs</p> Explainer Video <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/#quantfreedom.exchanges.bybit.Bybit.get_closed_pnl","title":"get_closed_pnl","text":"<pre><code>get_closed_pnl(symbol, limit=50, since_datetime=None, until_datetime=None, category='linear')\n</code></pre> <p>Bybit API link to Get Closed Profit and Loss</p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_open_orders","title":"get_open_orders","text":"<pre><code>get_open_orders(symbol, baseCoin=None, category='linear', custom_order_id=None, limit=50, orderFilter=None, orderStatus=None, order_id=None, settleCoin=None, since_datetime=None, until_datetime=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_order_history","title":"get_order_history","text":"<pre><code>get_order_history(baseCoin=None, category='linear', custom_order_id=None, limit=50, orderFilter=None, orderStatus=None, order_id=None, settleCoin=None, since_datetime=None, symbol=None, until_datetime=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_position_info","title":"get_position_info","text":"<pre><code>get_position_info(symbol=None, baseCoin=None, category='linear', limit=50, settleCoin=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_risk_limit_info","title":"get_risk_limit_info","text":"<pre><code>get_risk_limit_info(symbol, category='linear')\n</code></pre> <p>Bybit API link to Get Risk Limit</p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.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/#quantfreedom.exchanges.bybit.Bybit.get_trading_fee_rates","title":"get_trading_fee_rates","text":"<pre><code>get_trading_fee_rates(symbol=None, baseCoin=None, category='linear')\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.get_wallet_info","title":"get_wallet_info","text":"<pre><code>get_wallet_info(accountType='UNIFIED', trading_with=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.set_leverage","title":"set_leverage","text":"<pre><code>set_leverage(symbol, leverage, category='linear')\n</code></pre>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.set_leverage_mode","title":"set_leverage_mode","text":"<pre><code>set_leverage_mode(setMarginMode='ISOLATED_MARGIN')\n</code></pre> <p>ISOLATED_MARGIN, REGULAR_MARGIN(i.e. Cross margin), PORTFOLIO_MARGIN</p>"},{"location":"quantfreedom/exchanges/bybit/#quantfreedom.exchanges.bybit.Bybit.set_position_mode","title":"set_position_mode","text":"<pre><code>set_position_mode(position_mode, symbol, category='linear', trading_with=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/","title":"mufex","text":""},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex-classes","title":"Classes","text":""},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex","title":"Mufex","text":"<p>               Bases: <code>Exchange</code></p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex-functions","title":"Functions","text":""},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.__init__","title":"__init__","text":"<pre><code>__init__(use_testnet, api_key=None, secret_key=None)\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/#quantfreedom.exchanges.mufex.Mufex.adjust_order","title":"adjust_order","text":"<pre><code>adjust_order(params={})\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/#quantfreedom.exchanges.mufex.Mufex.cancel_all_open_orders_per_symbol","title":"cancel_all_open_orders_per_symbol","text":"<pre><code>cancel_all_open_orders_per_symbol(symbol)\n</code></pre> <p>no link yet</p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.cancel_open_order","title":"cancel_open_order","text":"<pre><code>cancel_open_order(symbol, order_id=None, custom_order_id=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.close_hedge_positions_and_orders","title":"close_hedge_positions_and_orders","text":"<pre><code>close_hedge_positions_and_orders(symbol=None, settleCoin=None)\n</code></pre> <p>Parameters:</p> Name Type Description Default <code>symbol</code> <code>str</code> <code>None</code>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.create_order","title":"create_order","text":"<pre><code>create_order(symbol, buy_sell, position_mode, order_type, asset_size, time_in_force='GoodTillCancel', price=None, triggerDirection=None, triggerPrice=None, triggerBy=None, tpTriggerBy=None, slTriggerBy=None, custom_order_id=None, takeProfit=None, stopLoss=None, reduce_only=None, closeOnTrigger=None)\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/#quantfreedom.exchanges.mufex.Mufex.get_all_symbols_info","title":"get_all_symbols_info","text":"<pre><code>get_all_symbols_info(category='linear', limit=1000, symbol=None)\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/#quantfreedom.exchanges.mufex.Mufex.get_candles","title":"get_candles","text":"<pre><code>get_candles(symbol, timeframe, since_datetime=None, until_datetime=None, candles_to_dl=1500, category='linear')\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/#quantfreedom.exchanges.mufex.Mufex.get_closed_pnl","title":"get_closed_pnl","text":"<pre><code>get_closed_pnl(symbol, limit=200, since_datetime=None, until_datetime=None)\n</code></pre> <p>Mufex API link to Get Closed Profit and Loss</p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.get_filled_orders","title":"get_filled_orders","text":"<pre><code>get_filled_orders(symbol, limit=200, since_datetime=None, until_datetime=None, execType=None, order_id=None)\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/#quantfreedom.exchanges.mufex.Mufex.get_open_orders","title":"get_open_orders","text":"<pre><code>get_open_orders(symbol, limit=50, order_id=None, custom_order_id=None, orderFilter=None)\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/#quantfreedom.exchanges.mufex.Mufex.get_order_history","title":"get_order_history","text":"<pre><code>get_order_history(symbol, limit=50, order_id=None, custom_order_id=None, orderStatus=None, orderFilter=None)\n</code></pre> <p>use link to see all Request Parameters</p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.get_position_info","title":"get_position_info","text":"<pre><code>get_position_info(symbol=None, settleCoin=None, limit=50)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.get_risk_limit_info","title":"get_risk_limit_info","text":"<pre><code>get_risk_limit_info(symbol, category='linear')\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/#quantfreedom.exchanges.mufex.Mufex.get_symbol_trading_fee_rates","title":"get_symbol_trading_fee_rates","text":"<pre><code>get_symbol_trading_fee_rates(symbol=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.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/#quantfreedom.exchanges.mufex.Mufex.get_trading_fee_rates","title":"get_trading_fee_rates","text":"<pre><code>get_trading_fee_rates(symbol=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.get_wallet_info","title":"get_wallet_info","text":"<pre><code>get_wallet_info(trading_with=None)\n</code></pre>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.set_leverage","title":"set_leverage","text":"<pre><code>set_leverage(symbol, leverage)\n</code></pre> <p>No link yet</p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.set_leverage_mode","title":"set_leverage_mode","text":"<pre><code>set_leverage_mode(symbol, leverage_mode, leverage=5)\n</code></pre> <p>Cross/isolated mode. 0: cross margin mode; 1: isolated margin mode</p>"},{"location":"quantfreedom/exchanges/mufex/#quantfreedom.exchanges.mufex.Mufex.set_position_mode","title":"set_position_mode","text":"<pre><code>set_position_mode(position_mode, trading_with=None, symbol=None)\n</code></pre>"},{"location":"quantfreedom/helpers/bsc_scan/","title":"bsc_scan","text":""},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan-classes","title":"Classes","text":""},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan","title":"BSC_Scan","text":""},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan-functions","title":"Functions","text":""},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.check_contract_execution_status","title":"check_contract_execution_status","text":"<pre><code>check_contract_execution_status(tx_hash)\n</code></pre> <p>Check Contract Execution Status</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.check_transaction_receipt_status","title":"check_transaction_receipt_status","text":"<pre><code>check_transaction_receipt_status(tx_hash)\n</code></pre> <p>Check Transaction Receipt Status</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_bnb_balance_for_address","title":"get_bnb_balance_for_address","text":"<pre><code>get_bnb_balance_for_address(address)\n</code></pre> <p>Get BNB Balance for Address</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_transaction_by_hash","title":"get_transaction_by_hash","text":"<pre><code>get_transaction_by_hash(tx_hash, address, contractaddress='0x55d398326f99059fF775485246999027B3197955', startblock=0, endblock=99999999, page=1, offset=1000, sort='desc')\n</code></pre> <p>Default contract address is USDT</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_transaction_value_by_hash","title":"get_transaction_value_by_hash","text":"<pre><code>get_transaction_value_by_hash(tx_hash, address, contractaddress='0x55d398326f99059fF775485246999027B3197955', startblock=0, endblock=99999999, page=1, offset=1000, sort='desc')\n</code></pre> <p>Default contract address is USDT</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_transactions","title":"get_transactions","text":"<pre><code>get_transactions(address, contractaddress='0x55d398326f99059fF775485246999027B3197955', startblock=0, endblock=99999999, page=1, offset=1000, sort='desc')\n</code></pre> <p>Get a list of 'Normal' Transactions By Address</p> <p>Default contract address is USDT</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_transactions_by_from_address","title":"get_transactions_by_from_address","text":"<pre><code>get_transactions_by_from_address(from_address, address, contractaddress='0x55d398326f99059fF775485246999027B3197955', startblock=0, endblock=99999999, page=1, offset=1000, sort='desc')\n</code></pre> <p>Default contract address is USDT</p>"},{"location":"quantfreedom/helpers/bsc_scan/#quantfreedom.helpers.bsc_scan.BSC_Scan.get_user_payment_amount","title":"get_user_payment_amount","text":"<pre><code>get_user_payment_amount(tx_hash, from_address, address, contractaddress='0x55d398326f99059fF775485246999027B3197955', startblock=0, endblock=99999999, page=1, offset=1000, sort='desc')\n</code></pre> <p>Default contract address is USDT</p>"},{"location":"quantfreedom/helpers/helper_funcs/","title":"helper_funcs","text":""},{"location":"quantfreedom/helpers/helper_funcs/#quantfreedom.helpers.helper_funcs-classes","title":"Classes","text":""},{"location":"quantfreedom/helpers/helper_funcs/#quantfreedom.helpers.helper_funcs-functions","title":"Functions","text":""},{"location":"quantfreedom/helpers/helper_funcs/#quantfreedom.helpers.helper_funcs.candles_to_df","title":"candles_to_df","text":"<pre><code>candles_to_df(candles)\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>ndarray</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/helpers/helper_funcs/#quantfreedom.helpers.helper_funcs.dl_ex_candles","title":"dl_ex_candles","text":"<pre><code>dl_ex_candles(exchange, symbol, timeframe, candles_to_dl=None, since_datetime=None, until_datetime=None)\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 futures = 'binance_usdm' | default candles to dl is 1500</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/helpers/utils/","title":"utils","text":""},{"location":"quantfreedom/helpers/utils/#quantfreedom.helpers.utils-functions","title":"Functions","text":""},{"location":"quantfreedom/helpers/utils/#quantfreedom.helpers.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/helpers/utils/#quantfreedom.helpers.utils.delete_dir","title":"delete_dir","text":"<pre><code>delete_dir(p)\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/helpers/utils/#quantfreedom.helpers.utils.generate_candles","title":"generate_candles","text":"<pre><code>generate_candles(number_of_candles=100, plot_candles=False, seed=None)\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/helpers/utils/#quantfreedom.helpers.utils.pretty_qf","title":"pretty_qf","text":"<pre><code>pretty_qf(named_tuple)\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/helpers/utils/#quantfreedom.helpers.utils.pretty_qf_string","title":"pretty_qf_string","text":"<pre><code>pretty_qf_string(named_tuple)\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/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(candles, length, smoothing_type=rma_tv)\n</code></pre> <p>Average true range smoothing from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(length, multi, source, basis_ma_type=sma_tv)\n</code></pre> <p>Bollinger bands from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(candles, length)\n</code></pre> <p>Donchain channels</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(source, length)\n</code></pre> <p>Exponential Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(candles, lin_reg_length, smoothing_length, smoothing_type=sma_tv)\n</code></pre> <p>Linear regression indicator</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(source, fast_length, slow_length, signal_smoothing, oscillator_type=ema_tv, signal_ma_type=ema_tv)\n</code></pre> <p>Moving average convergence divergence from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(source, length)\n</code></pre> <p>Relative strength index Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(source_1, source_2, length)\n</code></pre> <p>Relative strength index Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source_1</code> <code>ndarray</code> <p>Values to process</p> required <code>source_2</code> <code>ndarray</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(length, source)\n</code></pre> <p>Relative strength index</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(source, length)\n</code></pre> <p>Simple Moving average from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(candles, length_bb, length_kc, multi_bb, multi_kc)\n</code></pre> <p>LazyBear Pinescript</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(source, length)\n</code></pre> <p>Standard deviation from tradingview</p> <p>Explainer Video</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>ndarray</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(candles, atr_length, factor)\n</code></pre> <p>Super Trend</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(candles)\n</code></pre> <p>True Range from tradingview</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(candles)\n</code></pre> <p>Volume Weighted Average Price</p> <p>Parameters:</p> Name Type Description Default <code>candles</code> <code>ndarray</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(source, length)\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>ndarray</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/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__(asset_tick_step, increase_position_type, long_short, market_fee_pct, max_asset_size, min_asset_size, price_tick_step, sl_strategy_type)\n</code></pre> Summary <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(equity, total_trades)\n</code></pre> Summary <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>total_trades</code> <code>int</code> <p>total_trades</p> required <p>Returns:</p> Type Description <code>(int, int)</code> <p>total_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(entry_size_asset)\n</code></pre> Summary <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(average_entry, position_size_asset, sl_price, total_trades)\n</code></pre> Summary <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>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>total_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(entry_price, sl_price, total_possible_loss)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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(average_entry, entry_price, position_size_usd, sl_price, total_possible_loss)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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(entry_price, sl_price)\n</code></pre> Summary <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, total_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(average_entry, entry_price, position_size_asset, position_size_usd, sl_price, total_trades)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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, total_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(average_entry, entry_price, equity, position_size_asset, position_size_usd, sl_price, total_trades)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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, total_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(equity, average_entry, entry_price, position_size_asset, position_size_usd, sl_price, total_trades)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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, total_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(equity, entry_price, sl_price)\n</code></pre> Summary <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, total_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(average_entry, entry_price, equity, position_size_asset, position_size_usd, sl_price, total_trades)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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, total_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(sl_price, entry_price, total_possible_loss)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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(average_entry, entry_price, position_size_usd, sl_price, total_possible_loss)\n</code></pre> Summary <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>total_possible_loss</code> <code>float</code> <p>total_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(average_entry, can_move_sl_to_be, current_candle, sl_price)\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_close","title":"check_move_tsl_close","text":"<pre><code>check_move_tsl_close(average_entry, current_candle, sl_price)\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.check_move_tsl_pct","title":"check_move_tsl_pct","text":"<pre><code>check_move_tsl_pct(average_entry, current_candle, sl_price)\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(bar_index, candles)\n</code></pre> <p>Long Stop Loss Based on Candle Body Calculator</p>"},{"location":"services/copy_trading/","title":"Copy Trading Bot","text":"<p>If you want one month completely for free then make sure you read the following instructions ... All you will have to do is provide your API keys and its go time!</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> <p>You will need to manage the bot by turning it off or on based on if you think it would be a good time to run the bot.</p> <p>To get the Free month you need to do the following</p>"},{"location":"services/copy_trading/#free-month-part-1-follow-me","title":"Free Month Part 1: Follow Me","text":"<ul> <li>If you don't have an account for the following social medias then just make one.</li> <li>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>Make sure you screen shot all of these so I know that you have actually followed and post them in the follow screenshots channel.</li> <li>Follow me on Twitter</li> <li>Follow me on Instagram</li> <li>Follow me on Youtube</li> <li>Star the github project <p> <li>This most important one is to follow me on kick, because i will be live streaming there and doing react content.</li> <li>Follow me on Kick and turn on notifications</li>"},{"location":"services/copy_trading/#free-month-part-2-reach-out","title":"Free Month Part 2: Reach Out","text":"<p>You will need to reach out to this person and tell them to do a collaboration with me. You have three options to do this</p> <ul> <li>Quote tweet me and tell the person why you think they should do a collab with me. Say something real, not something stupid like \"just doing this so i can get 50% off\". I don't want to give you an example of what to say because then everyone will say the same thing and the person will think its a bot. The Tweet</li> <li>Tweet to the person yourself and tell them to collab with me Their Twitter</li> <li>Email the person and tell them to collab with me. Their Email</li> <li>For the tweet or email make sure you include a link to my youtube.</li> </ul>"},{"location":"services/copy_trading/#free-month-part-3-finished","title":"Free Month Part 3: Finished","text":"<p>Once you have done those two things then follow the rest of the directions and when you sign up you will get the Free Month automatically applied.</p>"},{"location":"services/copy_trading/#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, coinbase or any exchange to buy some crypto like USDT, ETH, BTC or something and then switch it over to USDT on an exchange like phemex. If you really have no idea then please watch some youtube videos on how to do it.</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.</li> <li>Mufex</li> <li>Bybit</li> </ul>"},{"location":"services/copy_trading/#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> </ul>"},{"location":"services/copy_trading/#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.     <p><p></p> <li>Now select USDT as your token then select bnb smart chain and then copy the address     <p></p></li> <li>Go to your wallet that has the 100 or more USDT and transfer the USDT to your deposit address and make sure you are using the bnb smart chain.</li> <ul> <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     <p></p></li> </ul>"},{"location":"services/copy_trading/#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":"services/copy_trading/#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 deposit and create your api key.</li> </ul>"},{"location":"services/copy_trading/#bybit-deposit","title":"Bybit Deposit","text":"<ul> <li>Depositing should be pretty straight forward. You click on your assets then click deposit and then select the coin which should be USDT and the network should be bnb chain.</li> <li>Then go to your other wallet where your USDT is and send the money from your usdt wallet to your bybit.</li> <li>If you still don't know how to do this try to watch either of these videos but make sure your network chain is the same from your other wallet to your bybit wallet.</li> <li>Video 1 Video 2</li> <li>Watch either video all the way through and then take action. Don't watch a little because you might miss something.</li> </ul>"},{"location":"services/copy_trading/#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>"},{"location":"services/copy_trading/#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>In here you will post the following: A screen shot of you following me on all the social media accounts.</li> <li>You have at least 100 dollars in your crpyto exchange account</li> <li>you have your api keys ready and for bybit users that you have verified your account is unified</li> <li>You will now go to the Quant freedom portal and register an account.     </li> <li>Once you have registered an account you will need to add your exchange by clicking on the exchange menu link.</li> <li>Once you have made your exchange you will need to add the wallet that you will be making the payment from. Your withdrawl address because the website will verify your payment through your wallet address.</li> <li>Then you will go to the payments tab and select copy trading and then follow the directions.</li> <li>once your payment is verified then you will go to the strategies menu and select the strategy you want to follow</li> </ul>"},{"location":"services/copy_trading/#faq","title":"FAQ","text":"<ul> <li>why are you doing this?<ul> <li>I am doing this because a lot of people just want to follow a strategy so why not let them.</li> </ul> </li> <li>How much does it cost?<ul> <li>It is originally 20 dollars a month but if you follow the 50% off you will get it for 10 dollars a month</li> </ul> </li> <li>Are there any refuneds?<ul> <li>No there are no refunds.</li> </ul> </li> <li>Why does this cost money?<ul> <li>You are only helping pay for the fee of what i have to pay for the AWS cloud.</li> </ul> </li> <li>Which exchanges does this work on?<ul> <li>right now only mufex and bybit.</li> </ul> </li> </ul>"},{"location":"services/active_strategies/rsi_rising_long_5m/","title":"RSI Rising Long 5m","text":""},{"location":"services/active_strategies/rsi_rising_long_5m/#info-about-the-strat","title":"Info about the strat","text":"<ul> <li>Name: RSI Rising Falling</li> <li>Long trades only</li> <li>5 min time frame</li> <li>BTC/USDT</li> <li>Mufex and bybit exchanges</li> <li>It was able to make 375x profit. From 1k starting to 375K ending during an uptrend backtest</li> <li>It takes trades when the rsi drops then comes back up like a V shape.</li> </ul>"}]}
\ No newline at end of file
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index ebc3b72449df744bbfb787d53a3fce734205de6b..7608f96730540f69c016ec39aafeec10914a9da9 100755
GIT binary patch
delta 13
Ucmb=gXP58h;3zQco5)@P02^2X{{R30

delta 13
Ucmb=gXP58h;3#<AF_FCj03PB5vj6}9

diff --git a/summary/index.html b/summary/index.html
deleted file mode 100755
index d4933e7..0000000
--- a/summary/index.html
+++ /dev/null
@@ -1,1305 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
-    
-    
-      
-        <title>Summary - QuantFreedom Docs</title>
-      
-    
-    
-      <link rel="stylesheet" href="../assets/stylesheets/main.6543a935.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
-    
-      <link rel="stylesheet" href="../stylesheets/extra.css">
-    
-    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    <body dir="ltr">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-  
-
-<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href=".." title="QuantFreedom Docs" class="md-header__button md-logo" aria-label="QuantFreedom Docs" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            QuantFreedom Docs
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Summary
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-    
-      <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      <label class="md-header__button md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
-      </label>
-      <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-    
-    
-      <div class="md-header__source">
-        <a href="https://github.com/QuantFreedom/QuantFreedom" title="Go to repository" class="md-source" data-md-component="source">
-  <div class="md-source__icon md-icon">
-    
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
-  </div>
-  <div class="md-source__repository">
-    GitHub
-  </div>
-</a>
-      </div>
-    
-  </nav>
-  
-    
-      
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../home/installation/" class="md-tabs__link">
-          
-  
-    
-  
-  Home
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-    
-    
-      
-  
-  
-  
-    
-    
-      
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../services/active_strategies/rsi_rising_long_5m/" class="md-tabs__link">
-          
-  
-    
-  
-  Services
-
-        </a>
-      </li>
-    
-  
-
-    
-  
-
-    
-  
-
-      
-        
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../beginners/guide/" class="md-tabs__link">
-          
-  
-    
-  
-  Beginners
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-    
-    
-      
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../quantfreedom/core/enums/" class="md-tabs__link">
-          
-  
-    
-  
-  Functions
-
-        </a>
-      </li>
-    
-  
-
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-    
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href=".." title="QuantFreedom Docs" class="md-nav__button md-logo" aria-label="QuantFreedom Docs" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
-
-    </a>
-    QuantFreedom Docs
-  </label>
-  
-    <div class="md-nav__source">
-      <a href="https://github.com/QuantFreedom/QuantFreedom" title="Go to repository" class="md-source" data-md-component="source">
-  <div class="md-source__icon md-icon">
-    
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
-  </div>
-  <div class="md-source__repository">
-    GitHub
-  </div>
-</a>
-    </div>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    
-    
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
-        
-          
-          <label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    Home
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_1">
-            <span class="md-nav__icon md-icon"></span>
-            Home
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../home/installation/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Installation
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    Services
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Services
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    
-    
-      
-        
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1" >
-        
-          
-          <label class="md-nav__link" for="__nav_2_1" id="__nav_2_1_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    Copy Trading Bot
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_1_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1">
-            <span class="md-nav__icon md-icon"></span>
-            Copy Trading Bot
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    
-    
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_1" >
-        
-          
-          <label class="md-nav__link" for="__nav_2_1_1" id="__nav_2_1_1_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    Active Bots
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_1_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_1">
-            <span class="md-nav__icon md-icon"></span>
-            Active Bots
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../services/active_strategies/rsi_rising_long_5m/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    RSI Rising Long 5m
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../services/copy_trading/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Sign Up
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    Beginners
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Beginners
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../beginners/guide/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Guide
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    Functions
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Functions
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    
-    
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_1" >
-        
-          
-          <label class="md-nav__link" for="__nav_4_1" id="__nav_4_1_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    core
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_1_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4_1">
-            <span class="md-nav__icon md-icon"></span>
-            core
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../quantfreedom/core/enums/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    enums
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    
-    
-      
-        
-      
-        
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    exchanges
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4_2">
-            <span class="md-nav__icon md-icon"></span>
-            exchanges
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../quantfreedom/exchanges/binance_usdm/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    binance_usdm
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../quantfreedom/exchanges/bybit/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    bybit
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../quantfreedom/exchanges/mufex/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    mufex
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    
-    
-      
-        
-      
-        
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    helpers
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4_3">
-            <span class="md-nav__icon md-icon"></span>
-            helpers
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../quantfreedom/helpers/bsc_scan/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    bsc_scan
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../quantfreedom/helpers/helper_funcs/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    helper_funcs
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../quantfreedom/helpers/utils/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    utils
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    
-    
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    indicators
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4_4">
-            <span class="md-nav__icon md-icon"></span>
-            indicators
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../quantfreedom/indicators/tv_indicators/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    tv_indicators
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    
-    
-      
-        
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_5" >
-        
-          
-          <label class="md-nav__link" for="__nav_4_5" id="__nav_4_5_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    order_handler
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4_5">
-            <span class="md-nav__icon md-icon"></span>
-            order_handler
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../quantfreedom/order_handler/increase_position/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    increase_position
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../quantfreedom/order_handler/stop_loss/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    stop_loss
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-  
-  
-
-
-  <h1>Summary</h1>
-
-<ul>
-<li>quantfreedom<ul>
-<li>core<ul>
-<li><a href="../quantfreedom/core/enums/">enums</a></li>
-</ul>
-</li>
-<li>exchanges<ul>
-<li><a href="../quantfreedom/exchanges/binance_usdm/">binance_usdm</a></li>
-<li><a href="../quantfreedom/exchanges/bybit/">bybit</a></li>
-<li><a href="../quantfreedom/exchanges/mufex/">mufex</a></li>
-</ul>
-</li>
-<li>helpers<ul>
-<li><a href="../quantfreedom/helpers/bsc_scan/">bsc_scan</a></li>
-<li><a href="../quantfreedom/helpers/helper_funcs/">helper_funcs</a></li>
-<li><a href="../quantfreedom/helpers/utils/">utils</a></li>
-</ul>
-</li>
-<li>indicators<ul>
-<li><a href="../quantfreedom/indicators/tv_indicators/">tv_indicators</a></li>
-</ul>
-</li>
-<li>order_handler<ul>
-<li><a href="../quantfreedom/order_handler/increase_position/">increase_position</a></li>
-<li><a href="../quantfreedom/order_handler/stop_loss/">stop_loss</a></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.path", "navigation.indexes"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
-    
-    
-      <script src="../assets/javascripts/bundle.081f42fc.min.js"></script>
-      
-        <script src="../js/open_in_new_tab.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file