docs
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>UnicornFy — unicorn-fy 0.14.2 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=92fd9be5" />
<link rel="stylesheet" type="text/css" href="_static/pydoctheme.css?v=fdf8e9ae" />
<script src="_static/documentation_options.js?v=6efca38a"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="unicorn_fy" href="modules.html" />
<link rel="prev" title="Welcome to UnicornFy’s documentation!" href="index.html" /><link rel="shortcut icon" type="image/png" href="_static/lucit.png" />
<script async defer src="https://buttons.github.io/buttons.js"></script>
<script
src='//eu.fw-cdn.com/10659511/361973.js'
chat='true'>
</script>
<script type="text/javascript" src="_static/copybutton.js"></script>
<script type="text/javascript" src="_static/menu.js"></script>
</head>
<body>
<div class="mobile-nav">
<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
<label for="menuToggler" class="toggler__label">
<span></span>
</label>
<nav class="nav-content" role="navigation">
<form role="search" class="search" action="search.html" method="get">
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
<path fill-rule="nonzero"
d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
</svg>
<input type="text" name="q" aria-label="Quick search"/>
<input type="submit" value="Go"/>
</form>
</nav>
<div class="menu-wrapper">
<nav class="menu" role="navigation" aria-label="main navigation">
<p class="logo">
<div style="text-align: center;">
<a href="https://www.lucit.tech"><img src="https://www.lucit.tech/files/images/logos/LUCIT-LOGO.png"></a><br>
<a href="https://shop.lucit.services/software/unicorn-binance-suite" style="font-size: 0.85em;font-weight: 900">Get a UNICORN Binance Suite License!</a><br>
<br>
<a href="https://github.com/LUCIT-Systems-and-Development" target="_blank" style="text-decoration:none;"><img src="_static/icons8-github-20.png"></a>
<a href="https://fb.me/lucit.systems.and.development" target="_blank" style="text-decoration:none;"><img src="_static/icons8-facebook-20.png"></a>
<a href="https://twitter.com/LUCIT_SysDev" target="_blank" style="text-decoration:none;"><img src="_static/icons8-twitter-20.png"></a>
<a href="https://www.linkedin.com/company/lucit-systems-and-development" target="_blank" style="text-decoration:none;"><img src="_static/icons8-linkedin-20.png"></a>
<a href="https://www.xing.com/pages/lucit-systems-and-development" target="_blank" style="text-decoration:none;"><img src="_static/icons8-xing-20.png"></a>
<a href="https://medium.lucit.tech" target="_blank" style="text-decoration:none;"><img src="_static/icons8-medium-monogram-20.png"></a>
<a href="https://www.youtube.com/channel/UCp57u8vaPqEWQTlfpYn-KnQ" target="_blank" style="text-decoration:none;"><img src="_static/icons8-youtube-20.png"></a>
</div>
</p>
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">UnicornFy</a><ul>
<li><a class="reference internal" href="#get-the-right-logger">Get the right logger:</a></li>
<li><a class="reference internal" href="#supported-exchanges">Supported Exchanges</a><ul>
<li><a class="reference internal" href="#websockets">Websockets</a></li>
<li><a class="reference internal" href="#rest">REST</a></li>
</ul>
</li>
<li><a class="reference internal" href="#installation-and-upgrade">Installation and Upgrade</a><ul>
<li><a class="reference internal" href="#packages-are-created-automatically-with-github-actions">Packages are created automatically with GitHub Actions</a></li>
<li><a class="reference internal" href="#a-cython-binary-pypy-or-source-code-based-cpython-wheel-of-the-latest-version-with-pip-from-pypi">A Cython binary, PyPy or source code based CPython wheel of the latest version with <code class="docutils literal notranslate"><span class="pre">pip</span></code> from PyPI</a><ul>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#update">Update</a></li>
</ul>
</li>
<li><a class="reference internal" href="#a-conda-package-of-the-latest-version-with-conda-from-anaconda">A Conda Package of the latest version with <code class="docutils literal notranslate"><span class="pre">conda</span></code> from Anaconda</a><ul>
<li><a class="reference internal" href="#id1">Installation</a></li>
<li><a class="reference internal" href="#id2">Update</a></li>
</ul>
</li>
<li><a class="reference internal" href="#from-source-of-the-latest-release-with-pip-from-github">From source of the latest release with PIP from Github</a><ul>
<li><a class="reference internal" href="#linux-macos">Linux, macOS, …</a></li>
<li><a class="reference internal" href="#windows">Windows</a></li>
</ul>
</li>
<li><a class="reference internal" href="#from-the-latest-source-dev-stage-with-pip-from-github">From the latest source (dev-stage) with PIP from GitHub</a></li>
<li><a class="reference internal" href="#conda-environment-virtualenv-or-plain-python">Conda environment, Virtualenv or plain Python</a></li>
</ul>
</li>
<li><a class="reference internal" href="#change-log">Change Log</a></li>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#project-homepage">Project Homepage</a></li>
<li><a class="reference internal" href="#wiki">Wiki</a></li>
<li><a class="reference internal" href="#social">Social</a></li>
<li><a class="reference internal" href="#receive-notifications">Receive Notifications</a></li>
<li><a class="reference internal" href="#how-to-report-bugs-or-suggest-improvements">How to report Bugs or suggest Improvements?</a></li>
<li><a class="reference internal" href="#contributing">Contributing</a><ul>
<li><a class="reference internal" href="#contributors">Contributors</a></li>
</ul>
</li>
<li><a class="reference internal" href="#disclaimer">Disclaimer</a><ul>
<li><a class="reference internal" href="#if-you-intend-to-use-real-money-use-it-at-your-own-risk">If you intend to use real money, use it at your own risk!</a></li>
</ul>
</li>
<li><a class="reference internal" href="#commercial-support">Commercial Support</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to UnicornFy’s documentation!</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="modules.html"
title="next chapter">unicorn_fy</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/readme.md.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: block" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<div role="note" aria-label="source code">
<h3>GitHub</h3>
<ul class="this-page-menu">
<li><a href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy">Show Source</a></li>
<li>
<a class="github-button" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy"
data-icon="octicon-star" data-show-count="true"
aria-label="Star LUCIT-Systems-and-Development/unicorn-fy on GitHub">Star</a>
<br />
<a class="github-button" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/subscription"
data-icon="octicon-eye" data-show-count="true"
aria-label="Watch LUCIT-Systems-and-Development/unicorn-fy on GitHub">Watch</a>
<br />
<a class="github-button" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/fork"
data-icon="octicon-repo-forked" data-show-count="true"
aria-label="Fork LUCIT-Systems-and-Development/unicorn-fy on GitHub">Fork</a>
<br />
<a class="github-button" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/issues"
data-icon="octicon-issue-opened"
data-show-count="true" aria-label="Issue LUCIT-Systems-and-Development/unicorn-fy on GitHub">Issue</a>
</li>
</ul>
</div>
</nav>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="modules.html" title="unicorn_fy"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to UnicornFy’s documentation!"
accesskey="P">previous</a> |</li>
<li><img src="_static/lucit.png" alt="LUCIT Logo"
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://docs.lucit.tech">Docs Index</a> | </li>
<li><a href="https://www.lucit.tech/unicorn-fy.html">unicorn-fy</a> »</li>
<a href="index.html">Docs</a> »
<li class="nav-item nav-item-this"><a href="">UnicornFy</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="search.html" method="get">
<input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
|
</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<p><a class="reference external" href="https://shop.lucit.services"><img alt="Get a UNICORN Binance Suite License" src="https://raw.githubusercontent.com/LUCIT-Systems-and-Development/unicorn-binance-suite/master/images/logo/LUCIT-UBS-License-Offer.png" /></a></p>
<p><a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/releases"><img alt="GitHub Release" src="https://img.shields.io/github/release/LUCIT-Systems-and-Development/unicorn-fy.svg?label=github" /></a>
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/releases"><img alt="GitHub Downloads" src="https://img.shields.io/github/downloads/LUCIT-Systems-and-Development/unicorn-fy/total?color=blue" /></a>
<img alt="Anaconda Release" src="https://img.shields.io/conda/v/lucit/unicorn-fy?color=blue" />
<img alt="Anaconda Downloads" src="https://img.shields.io/conda/dn/lucit/unicorn-fy?color=blue" />
<a class="reference external" href="https://pypi.org/project/unicorn-fy/"><img alt="PyPi Release" src="https://img.shields.io/pypi/v/unicorn-fy?color=blue" /></a>
<a class="reference external" href="https://pepy.tech/project/unicorn-fy"><img alt="PyPi Downloads" src="https://pepy.tech/badge/unicorn-fy" /></a>
<a class="reference external" href="https://unicorn-fy.docs.lucit.tech/license.html"><img alt="License" src="https://img.shields.io/github/license/LUCIT-Systems-and-Development/unicorn-fy.svg?color=blue" /></a>
<a class="reference external" href="https://www.python.org/downloads/"><img alt="Supported Python Version" src="https://img.shields.io/pypi/pyversions/unicorn_fy.svg" /></a>
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/issues"><img alt="PyPI - Status" src="https://img.shields.io/pypi/status/unicorn_fy.svg" /></a>
<a class="reference external" href="https://codecov.io/gh/LUCIT-Systems-and-Development/unicorn-fy"><img alt="codecov" src="https://codecov.io/gh/LUCIT-Systems-and-Development/unicorn-fy/branch/master/graph/badge.svg?token=5I03AZ3F5S" /></a>
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/codeql-analysis.yml"><img alt="CodeQL" src="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/codeql-analysis.yml/badge.svg" /></a>
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/unit-tests.yml"><img alt="Unit Tests" src="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/unit-tests.yml/badge.svg" /></a>
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/build_wheels.yml"><img alt="Build and Publish GH+PyPi" src="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/build_wheels.yml/badge.svg" /></a>
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/build_conda.yml"><img alt="Build and Publish Anaconda" src="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/build_conda.yml/badge.svg" /></a>
<a class="reference external" href="https://unicorn-fy.docs.lucit.tech/"><img alt="Read the Docs" src="https://img.shields.io/badge/read-%20docs-yellow" /></a>
<a class="reference external" href="https://medium.lucit.tech"><img alt="Read How To`s" src="https://img.shields.io/badge/read-%20howto-yellow" /></a>
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy"><img alt="Github" src="https://img.shields.io/badge/source-github-cbc2c8" /></a>
<a class="reference external" href="https://t.me/unicorndevs"><img alt="Telegram" src="https://img.shields.io/badge/community-telegram-41ab8c" /></a>
<a class="reference external" href="https://gitter.im/unicorn-binance-suite/unicorn-fy?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img alt="Gitter" src="https://img.shields.io/badge/community-gitter-41ab8c" /></a>
<a class="reference external" href="https://www.lucit.tech/get-support.html"><img alt="Get Free Professional Support" src="https://img.shields.io/badge/chat-lucit%20support-004166" /></a></p>
<p><a class="reference external" href="https://www.lucit.tech/unicorn-fy.html"><img alt="LUCIT-UNICORNFY-Banner" src="https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-fy/master/images/logo/LUCIT-UNICORNFY-Banner-Readme.png" /></a></p>
<section id="unicornfy">
<h1>UnicornFy<a class="headerlink" href="#unicornfy" title="Link to this heading">¶</a></h1>
<p><a class="reference internal" href="#supported-exchanges">Supported Exchanges</a> | <a class="reference internal" href="#installation-and-upgrade">Installation</a> | <a class="reference internal" href="#change-log">Change Log</a> | <a class="reference internal" href="#documentation">Documentation</a> |
<a class="reference internal" href="#examples">Examples</a> | <a class="reference internal" href="#wiki">Wiki</a> | <a class="reference internal" href="#social">Social</a> | <a class="reference internal" href="#receive-notifications">Notifications</a> | <a class="reference internal" href="#how-to-report-bugs-or-suggest-improvements">Bugs</a>
| <a class="reference internal" href="#contributing">Contributing</a> | <a class="reference internal" href="#disclaimer">Disclaimer</a> | <a class="reference internal" href="#commercial-support">Commercial Support</a></p>
<p>A Python SDK by <a class="reference external" href="https://www.lucit.tech">LUCIT</a> to convert received raw data from crypto exchange API endpoints
into well-formed python dictionaries.</p>
<p>Part of <a class="reference external" href="https://www.lucit.tech/unicorn-binance-suite.html">‘UNICORN Binance Suite’</a>.</p>
<p><a class="reference external" href="https://www.lucit.tech/get-support.html">Get help</a> with the integration of the <code class="docutils literal notranslate"><span class="pre">UNICORN</span> <span class="pre">Binance</span> <span class="pre">Suite</span></code> modules!</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">unicorn_fy</span>
<span class="n">received_stream_data_json</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"stream"</span><span class="p">:</span> <span class="s2">"btcusdt@trade"</span><span class="p">,</span>
<span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"e"</span><span class="p">:</span> <span class="s2">"trade"</span><span class="p">,</span>
<span class="s2">"E"</span><span class="p">:</span> <span class="mi">1556876873656</span><span class="p">,</span>
<span class="s2">"s"</span><span class="p">:</span> <span class="s2">"BTCUSDT"</span><span class="p">,</span>
<span class="s2">"t"</span><span class="p">:</span> <span class="mi">117727701</span><span class="p">,</span>
<span class="s2">"p"</span><span class="p">:</span> <span class="s2">"5786.76000000"</span><span class="p">,</span>
<span class="s2">"q"</span><span class="p">:</span> <span class="s2">"0.03200500"</span><span class="p">,</span>
<span class="s2">"b"</span><span class="p">:</span> <span class="mi">341831847</span><span class="p">,</span>
<span class="s2">"a"</span><span class="p">:</span> <span class="mi">341831876</span><span class="p">,</span>
<span class="s2">"T"</span><span class="p">:</span> <span class="mi">1556876873648</span><span class="p">,</span>
<span class="s2">"m"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="s2">"M"</span><span class="p">:</span> <span class="kc">True</span><span class="p">}}</span>
<span class="n">ufy</span> <span class="o">=</span> <span class="n">unicorn_fy</span><span class="o">.</span><span class="n">UnicornFy</span><span class="p">()</span>
<span class="n">unicorn_fied_stream_data</span> <span class="o">=</span> <span class="n">ufy</span><span class="o">.</span><span class="n">binance_com_websocket</span><span class="p">(</span><span class="n">received_stream_data_json</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">unicorn_fied_stream_data</span><span class="p">)</span>
</pre></div>
</div>
<p>Output:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'stream_type'</span><span class="p">:</span> <span class="s1">'btcusdt@trade'</span><span class="p">,</span> <span class="s1">'event_type'</span><span class="p">:</span> <span class="s1">'trade'</span><span class="p">,</span> <span class="s1">'event_time'</span><span class="p">:</span> <span class="mi">1556876873656</span><span class="p">,</span> <span class="s1">'symbol'</span><span class="p">:</span> <span class="s1">'BTCUSDT'</span><span class="p">,</span>
<span class="s1">'trade_id'</span><span class="p">:</span> <span class="mi">117727701</span><span class="p">,</span> <span class="s1">'price'</span><span class="p">:</span> <span class="s1">'5786.76000000'</span><span class="p">,</span> <span class="s1">'quantity'</span><span class="p">:</span> <span class="s1">'0.03200500'</span><span class="p">,</span> <span class="s1">'buyer_order_id'</span><span class="p">:</span> <span class="mi">341831847</span><span class="p">,</span>
<span class="s1">'seller_order_id'</span><span class="p">:</span> <span class="mi">341831876</span><span class="p">,</span> <span class="s1">'trade_time'</span><span class="p">:</span> <span class="mi">1556876873648</span><span class="p">,</span> <span class="s1">'is_market_maker'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">'ignore'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="s1">'unicorn_fied'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'binance'</span><span class="p">,</span> <span class="s1">'0.14.2'</span><span class="p">]}</span>
</pre></div>
</div>
<p>This lib is integrated into
<a class="reference external" href="https://www.lucit.tech/unicorn-binance-websocket-api.html">UNICORN Binance WebSocket API</a>
and can be activated by setting parameter
<a class="reference external" href="https://lucit-systems-and-development.github.io/unicorn-binance-websocket-api/unicorn_binance_websocket_api.html?highlight=output_default#module-unicorn_binance_websocket_api.manager"><code class="docutils literal notranslate"><span class="pre">output_default</span></code> of <code class="docutils literal notranslate"><span class="pre">BinanceWebSocketApiManager()</span></code> to <code class="docutils literal notranslate"><span class="pre">UnicornFy</span></code></a>
or for specific streams with the parameter
<a class="reference external" href="https://lucit-systems-and-development.github.io/unicorn-binance-websocket-api/unicorn_binance_websocket_api.html?highlight=output#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.create_stream"><code class="docutils literal notranslate"><span class="pre">output</span></code> of <code class="docutils literal notranslate"><span class="pre">create_stream()</span></code> to <code class="docutils literal notranslate"><span class="pre">UnicornFy</span></code></a>.</p>
<section id="get-the-right-logger">
<h2>Get the right <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/examples/_archive/example_logging.py">logger</a>:<a class="headerlink" href="#get-the-right-logger" title="Link to this heading">¶</a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">"unicorn_fy"</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="supported-exchanges">
<h2>Supported Exchanges<a class="headerlink" href="#supported-exchanges" title="Link to this heading">¶</a></h2>
<section id="websockets">
<h3>Websockets<a class="headerlink" href="#websockets" title="Link to this heading">¶</a></h3>
<table border="1" class="docutils">
<thead>
<tr>
<th>Exchange</th>
<th>Docs</th>
<th>Status</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="https://www.binance.com">Binance</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_websocket"><code>binance_com_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://testnet.binance.vision/">Binance Testnet</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_websocket"><code>binance_com_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.binance.com">Binance Margin</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_margin_websocket"><code>binance_com_margin_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://testnet.binance.vision/">Binance Margin Testnet</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_margin_websocket"><code>binance_com_margin_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.binance.com">Binance Isolated Margin</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_isolated_margin_websocket"><code>binance_com_isolated_margin_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://testnet.binance.vision/">Binance Isolated Margin Testnet</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_isolated_margin_websocket"><code>binance_com_isolated_margin_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.binance.com">Binance Futures</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_futures_websocket"><code>binance_com_futures_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://testnet.binancefuture.com">Binance Futures Testnet</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_coin_futures_websocket"><code>binance_com_futures_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.binance.com">Binance Coin Futures</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_coin_futures_websocket"><code>binance_com_coin_futures_websocket(stream_data_json)</code></a></td>
<td>NEEDS_YOUR_HELP</td>
</tr>
<tr>
<td><a href="https://testnet.binancefuture.com">Binance Coin Futures Testnet</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_futures_websocket"><code>binance_com_coin_futures_websocket(stream_data_json)</code></a></td>
<td>NEEDS_YOUR_HELP</td>
</tr>
<tr>
<td><a href="https://www.binance.us">Binance US</a> (<a href="https://github.com/binance-us/binance-official-api-docs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_us_websocket"><code>binance_us_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.trbinance.com">Binance TR</a> (<a href="https://www.trbinance.com/apidocs">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.trbinance_com_websocket"><code>trbinance_com_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.binance.org">Binance DEX</a> (<a href="https://docs.binance.org/">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_org_websocket"><code>binance_org_websocket(stream_data_json)</code></a></td>
<td>NEEDS_YOUR_HELP</td>
</tr>
<tr>
<td><a href="https://testnet.binance.org">Binance DEX Testnet</a> (<a href="https://docs.binance.org/">API</a>)</td>
<td><a href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_org_websocket"><code>binance_org_websocket(stream_data_json)</code></a></td>
<td>NEEDS_YOUR_HELP</td>
</tr>
</tbody>
</table>
</section>
<section id="rest">
<h3>REST<a class="headerlink" href="#rest" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>none</p></li>
</ul>
<p>If you like the project, please
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/stargazers"><img alt="star" src="https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-fy/master/images/misc/star.png" /></a> it on
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy">GitHub</a>!</p>
</section>
</section>
<section id="installation-and-upgrade">
<h2>Installation and Upgrade<a class="headerlink" href="#installation-and-upgrade" title="Link to this heading">¶</a></h2>
<p>The module requires Python 3.7.0 or above.</p>
<p>For Anaconda we offer packages only from Python version 3.8 and higher.</p>
<p>For the PyPy interpreter we offer packages only from Python version 3.9 and higher.</p>
<p>The current dependencies are listed
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/requirements.txt">here</a>.</p>
<p>If you run into errors during the installation take a look <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki/Installation">here</a>.</p>
<section id="packages-are-created-automatically-with-github-actions">
<h3>Packages are created automatically with GitHub Actions<a class="headerlink" href="#packages-are-created-automatically-with-github-actions" title="Link to this heading">¶</a></h3>
<p>When a new release is to be created, we start two GitHubActions:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/build_conda.yml">Build and Publish Anaconda</a></p></li>
<li><p><a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/build_wheels.yml">Build and Publish GH+PyPi</a></p></li>
</ul>
<p>Both start virtual Windows/Linux/Mac servers provided by GitHub in the cloud with preconfigured environments and
create the respective compilations and stub files, pack them into wheels and conda packages and then publish them on
GitHub, PYPI and Anaconda. This is a transparent method that makes it possible to trace the source code behind a
compilation.</p>
</section>
<section id="a-cython-binary-pypy-or-source-code-based-cpython-wheel-of-the-latest-version-with-pip-from-pypi">
<h3>A Cython binary, PyPy or source code based CPython wheel of the latest version with <code class="docutils literal notranslate"><span class="pre">pip</span></code> from <a class="reference external" href="https://pypi.org/project/unicorn-binance-rest-api/">PyPI</a><a class="headerlink" href="#a-cython-binary-pypy-or-source-code-based-cpython-wheel-of-the-latest-version-with-pip-from-pypi" title="Link to this heading">¶</a></h3>
<p>Our <a class="reference external" href="https://cython.org/">Cython</a> and <a class="reference external" href="https://www.pypy.org/">PyPy</a> Wheels are available on <a class="reference external" href="https://pypi.org/">PyPI</a>,
these wheels offer significant advantages for Python developers:</p>
<ul class="simple">
<li><p><em><strong>Performance Boost with Cython Wheels:</strong></em> Cython is a programming language that supplements Python with static
typing and C-level performance. By compiling Python code into C, Cython Wheels can significantly enhance the
execution speed of Python code, especially in computationally intensive tasks. This means faster runtimes and more
efficient processing for users of our package.</p></li>
<li><p><em><strong>PyPy Wheels for Enhanced Efficiency:</strong></em> PyPy is an alternative Python interpreter known for its speed and
efficiency. It uses Just-In-Time (JIT) compilation, which can dramatically improve the performance of Python code.
Our PyPy Wheels are tailored for compatibility with PyPy, allowing users to leverage this speed advantage seamlessly.</p></li>
</ul>
<p>Both Cython and PyPy Wheels on PyPI make the installation process simpler and more straightforward. They ensure that
you get the optimized version of our package with minimal setup, allowing you to focus on development rather than
configuration.</p>
<p>On Raspberry Pi and other architectures for which there are no pre-compiled versions, the package can still be
installed with PIP. PIP then compiles the package locally on the target system during installation. Please be patient,
this may take some time!</p>
<section id="installation">
<h4>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">unicorn-fy</span></code></p>
</section>
<section id="update">
<h4>Update<a class="headerlink" href="#update" title="Link to this heading">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">unicorn-fy</span> <span class="pre">--upgrade</span></code></p>
</section>
</section>
<section id="a-conda-package-of-the-latest-version-with-conda-from-anaconda">
<h3>A Conda Package of the latest version with <code class="docutils literal notranslate"><span class="pre">conda</span></code> from <a class="reference external" href="https://anaconda.org/lucit">Anaconda</a><a class="headerlink" href="#a-conda-package-of-the-latest-version-with-conda-from-anaconda" title="Link to this heading">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">unicorn-fy</span></code> package is also available as a Cython version for the <code class="docutils literal notranslate"><span class="pre">linux-64</span></code>, <code class="docutils literal notranslate"><span class="pre">osx-64</span></code>
and <code class="docutils literal notranslate"><span class="pre">win-64</span></code> architectures with <a class="reference external" href="https://docs.conda.io/en/latest/">Conda</a> through the
<a class="reference external" href="https://anaconda.org/lucit"><code class="docutils literal notranslate"><span class="pre">lucit</span></code> channel</a>.</p>
<p>For optimal compatibility and performance, it is recommended to source the necessary dependencies from the
<a class="reference external" href="https://anaconda.org/conda-forge"><code class="docutils literal notranslate"><span class="pre">conda-forge</span></code> channel</a>.</p>
<section id="id1">
<h4>Installation<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">config</span> <span class="o">--</span><span class="n">add</span> <span class="n">channels</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span>
<span class="n">conda</span> <span class="n">config</span> <span class="o">--</span><span class="n">add</span> <span class="n">channels</span> <span class="n">lucit</span>
<span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">lucit</span> <span class="n">unicorn</span><span class="o">-</span><span class="n">fy</span>
</pre></div>
</div>
</section>
<section id="id2">
<h4>Update<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">update</span> <span class="pre">-c</span> <span class="pre">lucit</span> <span class="pre">unicorn-fy</span></code></p>
</section>
</section>
<section id="from-source-of-the-latest-release-with-pip-from-github">
<h3>From source of the latest release with PIP from <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy">Github</a><a class="headerlink" href="#from-source-of-the-latest-release-with-pip-from-github" title="Link to this heading">¶</a></h3>
<section id="linux-macos">
<h4>Linux, macOS, …<a class="headerlink" href="#linux-macos" title="Link to this heading">¶</a></h4>
<p>Run in bash:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">https://github.com/LUCIT-Systems-and-Development/unicorn-fy/archive/$(curl</span> <span class="pre">-s</span> <span class="pre">https://api.github.com/repos/lucit-systems-and-development/unicorn-fy/releases/latest</span> <span class="pre">|</span> <span class="pre">grep</span> <span class="pre">-oP</span> <span class="pre">'"tag_name":</span> <span class="pre">"\K(.*)(?=")').tar.gz</span> <span class="pre">--upgrade</span></code></p>
</section>
<section id="windows">
<h4>Windows<a class="headerlink" href="#windows" title="Link to this heading">¶</a></h4>
<p>Use the below command with the version (such as 0.14.2) you determined <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/releases/latest">here</a>:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">https://github.com/LUCIT-Systems-and-Development/unicorn-fy/archive/0.14.2.tar.gz</span> <span class="pre">--upgrade</span></code></p>
</section>
</section>
<section id="from-the-latest-source-dev-stage-with-pip-from-github">
<h3>From the latest source (dev-stage) with PIP from <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy">GitHub</a><a class="headerlink" href="#from-the-latest-source-dev-stage-with-pip-from-github" title="Link to this heading">¶</a></h3>
<p>This is not a release version and can not be considered to be stable!</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">https://github.com/LUCIT-Systems-and-Development/unicorn-fy/tarball/master</span> <span class="pre">--upgrade</span></code></p>
</section>
<section id="conda-environment-virtualenv-or-plain-python">
<h3><a class="reference external" href="https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html">Conda environment</a>, <a class="reference external" href="https://virtualenv.pypa.io/en/latest/">Virtualenv</a> or plain <a class="reference external" href="https://www.python.org">Python</a><a class="headerlink" href="#conda-environment-virtualenv-or-plain-python" title="Link to this heading">¶</a></h3>
<p>Download the <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/releases/latest">latest release</a>
or the <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/archive/master.zip">current master branch</a>
and use:</p>
<ul class="simple">
<li><p>./environment.yml</p></li>
<li><p>./meta.yaml</p></li>
<li><p>./pyproject.toml</p></li>
<li><p>./requirements.txt</p></li>
<li><p>./setup.py</p></li>
</ul>
</section>
</section>
<section id="change-log">
<h2>Change Log<a class="headerlink" href="#change-log" title="Link to this heading">¶</a></h2>
<p><a class="reference external" href="https://unicorn-fy.docs.lucit.tech/changelog.html">https://unicorn-fy.docs.lucit.tech/changelog.html</a></p>
</section>
<section id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://unicorn-fy.docs.lucit.tech/">General</a></p></li>
<li><p><a class="reference external" href="https://unicorn-fy.docs.lucit.tech/modules.html">Modules</a></p></li>
</ul>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/tree/master/examples/">Look here!</a></p></li>
</ul>
</section>
<section id="project-homepage">
<h2>Project Homepage<a class="headerlink" href="#project-homepage" title="Link to this heading">¶</a></h2>
<p><a class="reference external" href="https://www.lucit.tech/unicorn-fy.html">https://www.lucit.tech/unicorn-fy.html</a></p>
</section>
<section id="wiki">
<h2>Wiki<a class="headerlink" href="#wiki" title="Link to this heading">¶</a></h2>
<p><a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/wiki">https://github.com/LUCIT-Systems-and-Development/unicorn-fy/wiki</a></p>
</section>
<section id="social">
<h2>Social<a class="headerlink" href="#social" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/discussions">Discussions</a></p></li>
<li><p><a class="reference external" href="https://t.me/unicorndevs">https://t.me/unicorndevs</a></p></li>
<li><p><a class="reference external" href="https://dev.binance.vision">https://dev.binance.vision</a></p></li>
<li><p><a class="reference external" href="https://community.binance.org">https://community.binance.org</a></p></li>
</ul>
</section>
<section id="receive-notifications">
<h2>Receive Notifications<a class="headerlink" href="#receive-notifications" title="Link to this heading">¶</a></h2>
<p>To receive notifications on available updates you can
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/watchers"><img alt="watch" src="https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-fy/master/images/misc/watch.png" /></a>
the repository on <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy">GitHub</a>, write your
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/examples/_archive/example_version_of_this_package.py">own script</a>
with using
<a class="reference external" href="https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=is_update#unicorn_fy.unicorn_fy.UnicornFy.is_update_availabe"><code class="docutils literal notranslate"><span class="pre">is_update_available()</span></code></a>
or you use the
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/UNICORN-Monitoring-API-Service">monitoring API service</a>.</p>
<p>Follow us on <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development">GitHub</a>, <a class="reference external" href="https://medium.lucit.tech/">Medium</a>,
<a class="reference external" href="https://www.youtube.com/@LUCIT_Systems_and_Development">YouTube</a>,
<a class="reference external" href="https://www.linkedin.com/company/lucit-systems-and-development">LinkedIn</a>,
<a class="reference external" href="https://twitter.com/LUCIT_SysDev">X</a> or <a class="reference external" href="https://www.facebook.com/lucit.systems.and.development">Facebook</a>!</p>
</section>
<section id="how-to-report-bugs-or-suggest-improvements">
<h2>How to report Bugs or suggest Improvements?<a class="headerlink" href="#how-to-report-bugs-or-suggest-improvements" title="Link to this heading">¶</a></h2>
<p><a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement">List of planned features</a> -
click <img alt="thumbs-up" src="https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-fy/master/images/misc/thumbup.png" /> if you need one of them or suggest a new feature!</p>
<p>Before you report a bug, <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy#installation-and-upgrade">try the latest release</a>.
If the issue still exists, provide the error trace, OS and python version and explain how to reproduce the error.
A demo script is appreciated.</p>
<p>If you dont find an issue related to your topic, please open a new issue:
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/issues">https://github.com/LUCIT-Systems-and-Development/unicorn-fy/issues</a></p>
<p><a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/security/policy">Report a security bug!</a></p>
</section>
<section id="contributing">
<h2>Contributing<a class="headerlink" href="#contributing" title="Link to this heading">¶</a></h2>
<p><a class="reference external" href="https://www.lucit.tech/unicorn-fy.html">UnicornFy</a> is an open
source project which welcomes contributions which can be anything from simple documentation fixes and reporting dead links to new features. To
contribute follow
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/CONTRIBUTING.md">this guide</a>.</p>
<section id="contributors">
<h3>Contributors<a class="headerlink" href="#contributors" title="Link to this heading">¶</a></h3>
<p><a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/graphs/contributors"><img alt="Contributors" src="https://contributors-img.web.app/image?repo=lucit-systems-and-development/unicorn-fy" /></a></p>
<p>We <img alt="love" src="https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-fy/master/images/misc/heart.png" /> open source!</p>
</section>
</section>
<section id="disclaimer">
<h2>Disclaimer<a class="headerlink" href="#disclaimer" title="Link to this heading">¶</a></h2>
<p>This project is for informational purposes only. You should not construe this information or any other material as
legal, tax, investment, financial or other advice. Nothing contained herein constitutes a solicitation, recommendation,
endorsement or offer by us or any third party provider to buy or sell any securities or other financial instruments in
this or any other jurisdiction in which such solicitation or offer would be unlawful under the securities laws of such
jurisdiction.</p>
<section id="if-you-intend-to-use-real-money-use-it-at-your-own-risk">
<h3>If you intend to use real money, use it at your own risk!<a class="headerlink" href="#if-you-intend-to-use-real-money-use-it-at-your-own-risk" title="Link to this heading">¶</a></h3>
<p>Under no circumstances will we be responsible or liable for any claims, damages, losses, expenses, costs or liabilities
of any kind, including but not limited to direct or indirect damages for loss of profits.</p>
</section>
</section>
<section id="commercial-support">
<h2>Commercial Support<a class="headerlink" href="#commercial-support" title="Link to this heading">¶</a></h2>
<p><a class="reference external" href="https://www.lucit.tech/get-support.html"><img alt="Get professional and fast support" src="https://raw.githubusercontent.com/LUCIT-Systems-and-Development/unicorn-binance-suite/master/images/support/LUCIT-get-professional-and-fast-support.png" /></a></p>
<p><em><strong>Do you need a developer, operator or consultant?</strong></em> <a class="reference external" href="https://www.lucit.tech/contact.html">Contact us</a> for a non-binding initial consultation!</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<div style="text-align: center;">
<a href="https://www.lucit.tech"><img src="https://www.lucit.tech/files/images/logos/LUCIT-LOGO.png"></a><br>
<a href="https://shop.lucit.services/software/unicorn-binance-suite" style="font-size: 0.85em;font-weight: 900">Get a UNICORN Binance Suite License!</a><br>
<br>
<a href="https://github.com/LUCIT-Systems-and-Development" target="_blank" style="text-decoration:none;"><img src="_static/icons8-github-20.png"></a>
<a href="https://fb.me/lucit.systems.and.development" target="_blank" style="text-decoration:none;"><img src="_static/icons8-facebook-20.png"></a>
<a href="https://twitter.com/LUCIT_SysDev" target="_blank" style="text-decoration:none;"><img src="_static/icons8-twitter-20.png"></a>
<a href="https://www.linkedin.com/company/lucit-systems-and-development" target="_blank" style="text-decoration:none;"><img src="_static/icons8-linkedin-20.png"></a>
<a href="https://www.xing.com/pages/lucit-systems-and-development" target="_blank" style="text-decoration:none;"><img src="_static/icons8-xing-20.png"></a>
<a href="https://medium.lucit.tech" target="_blank" style="text-decoration:none;"><img src="_static/icons8-medium-monogram-20.png"></a>
<a href="https://www.youtube.com/channel/UCp57u8vaPqEWQTlfpYn-KnQ" target="_blank" style="text-decoration:none;"><img src="_static/icons8-youtube-20.png"></a>
</div>
</p>
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">UnicornFy</a><ul>
<li><a class="reference internal" href="#get-the-right-logger">Get the right logger:</a></li>
<li><a class="reference internal" href="#supported-exchanges">Supported Exchanges</a><ul>
<li><a class="reference internal" href="#websockets">Websockets</a></li>
<li><a class="reference internal" href="#rest">REST</a></li>
</ul>
</li>
<li><a class="reference internal" href="#installation-and-upgrade">Installation and Upgrade</a><ul>
<li><a class="reference internal" href="#packages-are-created-automatically-with-github-actions">Packages are created automatically with GitHub Actions</a></li>
<li><a class="reference internal" href="#a-cython-binary-pypy-or-source-code-based-cpython-wheel-of-the-latest-version-with-pip-from-pypi">A Cython binary, PyPy or source code based CPython wheel of the latest version with <code class="docutils literal notranslate"><span class="pre">pip</span></code> from PyPI</a><ul>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#update">Update</a></li>
</ul>
</li>
<li><a class="reference internal" href="#a-conda-package-of-the-latest-version-with-conda-from-anaconda">A Conda Package of the latest version with <code class="docutils literal notranslate"><span class="pre">conda</span></code> from Anaconda</a><ul>
<li><a class="reference internal" href="#id1">Installation</a></li>
<li><a class="reference internal" href="#id2">Update</a></li>
</ul>
</li>
<li><a class="reference internal" href="#from-source-of-the-latest-release-with-pip-from-github">From source of the latest release with PIP from Github</a><ul>
<li><a class="reference internal" href="#linux-macos">Linux, macOS, …</a></li>
<li><a class="reference internal" href="#windows">Windows</a></li>
</ul>
</li>
<li><a class="reference internal" href="#from-the-latest-source-dev-stage-with-pip-from-github">From the latest source (dev-stage) with PIP from GitHub</a></li>
<li><a class="reference internal" href="#conda-environment-virtualenv-or-plain-python">Conda environment, Virtualenv or plain Python</a></li>
</ul>
</li>
<li><a class="reference internal" href="#change-log">Change Log</a></li>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#project-homepage">Project Homepage</a></li>
<li><a class="reference internal" href="#wiki">Wiki</a></li>
<li><a class="reference internal" href="#social">Social</a></li>
<li><a class="reference internal" href="#receive-notifications">Receive Notifications</a></li>
<li><a class="reference internal" href="#how-to-report-bugs-or-suggest-improvements">How to report Bugs or suggest Improvements?</a></li>
<li><a class="reference internal" href="#contributing">Contributing</a><ul>
<li><a class="reference internal" href="#contributors">Contributors</a></li>
</ul>
</li>
<li><a class="reference internal" href="#disclaimer">Disclaimer</a><ul>
<li><a class="reference internal" href="#if-you-intend-to-use-real-money-use-it-at-your-own-risk">If you intend to use real money, use it at your own risk!</a></li>
</ul>
</li>
<li><a class="reference internal" href="#commercial-support">Commercial Support</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to UnicornFy’s documentation!</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="modules.html"
title="next chapter">unicorn_fy</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/readme.md.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: block" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<div role="note" aria-label="source code">
<h3>GitHub</h3>
<ul class="this-page-menu">
<li><a href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy">Show Source</a></li>
<li>
<a class="github-button" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy"
data-icon="octicon-star" data-show-count="true"
aria-label="Star LUCIT-Systems-and-Development/unicorn-fy on GitHub">Star</a>
<br />
<a class="github-button" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/subscription"
data-icon="octicon-eye" data-show-count="true"
aria-label="Watch LUCIT-Systems-and-Development/unicorn-fy on GitHub">Watch</a>
<br />
<a class="github-button" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/fork"
data-icon="octicon-repo-forked" data-show-count="true"
aria-label="Fork LUCIT-Systems-and-Development/unicorn-fy on GitHub">Fork</a>
<br />
<a class="github-button" href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/issues"
data-icon="octicon-issue-opened"
data-show-count="true" aria-label="Issue LUCIT-Systems-and-Development/unicorn-fy on GitHub">Issue</a>
</li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="modules.html" title="unicorn_fy"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to UnicornFy’s documentation!"
>previous</a> |</li>
<li><img src="_static/lucit.png" alt="LUCIT Logo"
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://docs.lucit.tech">Docs Index</a> | </li>
<li><a href="https://www.lucit.tech/unicorn-fy.html">unicorn-fy</a> »</li>
<a href="index.html">Docs</a> »
<li class="nav-item nav-item-this"><a href="">UnicornFy</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="search.html" method="get">
<input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
|
</li>
</ul>
</div>
<div class="footer">
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
© <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on May 13 2024 at 14:24 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
with <a href="https://github.com/LUCIT-Systems-and-Development/python-docs-theme-lucit">python-docs-theme-lucit</a>
by <a href="https://www.lucit.tech">LUCIT Systems and Development</a>.
</div>
<img referrerpolicy="no-referrer-when-downgrade" src="https://webmon.lucit.services/matomo.php?idsite=7&rec=1" style="border:0" alt="" />
</body>
</html>![https://www.lucit.tech/files/images/logos/LUCIT-LOGO.png"></a><br](https://www.lucit.tech/files/images/logos/LUCIT-LOGO.png"></a><br){kind=link}
