wassname/catalyst
1
0
Fork 0
mirror of https://github.com/wassname/catalyst.git synced 2026-07-01 08:17:33 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
2247159a87d404f41b84a01fe800519507e3e3da
catalyst/features.html
T
AvishaiW 2247159a87 DOC: compling the docs
2018-03-29 18:15:26 +03:00

225 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Features &#8212; Catalyst 0.4 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Example Algorithms" href="example-algos.html" />
<link rel="prev" title="Live Trading" href="live-trading.html" />
</head>
<body>
<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="example-algos.html" title="Example Algorithms"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="live-trading.html" title="Live Trading"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Catalyst 0.4 documentation</a> &#187;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="features">
<h1>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h1>
<p>This page describes the features that Catalyst provides in the current version,
and what is planned for future releases.</p>
<div class="section" id="current-functionality">
<h2>Current Functionality<a class="headerlink" href="#current-functionality" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Backtesting and live-trading modes to run your trading algorithms, with a
seamless transition between the two.</li>
<li>Paper trading simulates order in live-trading mode.</li>
<li>Support for 3 exchanges: Bitfinex, Bittrex and Poloniex in both modes
(backtesting and live-trading). Historical data for backtesting is provided
with daily resolution for all three exchanges, and minute resolution for
Bitfinex and Poloniex. No minute-resolution data is currently available for
Bittrex. Refer to
<a class="reference external" href="https://www.enigma.co/catalyst/status">Catalyst Market Coverage</a> for
details.</li>
<li>Interface with over 90 exchanges available in live and paper trading modes.</li>
<li>Granular commission models which closely simulates each exchange fee
structure in backtesting and paper trading.</li>
<li>Standardized naming convention for all asset pairs trading on any exchange in
the form <code class="docutils literal"><span class="pre">{market_currency}_{base_currency}</span></code>. See
<a class="reference internal" href="#naming"><span class="std std-ref">Naming Convention</span></a>.</li>
<li>Output of performance statistics based on Pandas DataFrames to integrate
nicely into the existing PyData ecosystem.</li>
<li>Support for accessing multiple exchanges per algorithm, which opens the door
to cross-exchange arbitrage opportunities.</li>
<li>Support for running multiple algorithms on the same exchange independently of
one another. Catalyst performance tracker stores just enough data to allow
algorithms to run independently while still sharing critical data through
exchanges.</li>
<li>Benchmark defaults to Bitcoin price (btc_usdt in Poloniex exchange) for the
purpose of comparing performance across trading algorithms. A custom benchmark
can be specified through <code class="docutils literal"><span class="pre">set_benchmark()</span></code> (but see
<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/86">issue #86</a>).</li>
<li>Support for MacOS, Linux and Windows installations.</li>
<li>Support for Python2 and Python3.</li>
</ul>
<p>For additional details on the functionality added on recent releases, see the
<a class="reference internal" href="releases.html"><span class="doc">Release Notes</span></a>.</p>
</div>
<div class="section" id="upcoming-features">
<h2>Upcoming features<a class="headerlink" href="#upcoming-features" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Additional datasets beyond pricing data (Q1 2018)</li>
<li>API documentation (Q1 2018)</li>
<li>Support for decentralized exchanges (Q1 2018)</li>
<li>Support for data ingestion of community-contributed data sets (Q1 2018)</li>
<li>Pipeline support (Q1 2018)</li>
<li>Web UI (Q2 2018)</li>
</ul>
<blockquote>
<div></div></blockquote>
</div>
<div class="section" id="naming-convention">
<span id="naming"></span><h2>Naming Convention<a class="headerlink" href="#naming-convention" title="Permalink to this headline"></a></h2>
<p>Catalyst introduces a standardized naming convention for all asset pairs
trading on any exchange in the following form:</p>
<blockquote>
<div><strong>{market_currency}_{base_currency}</strong></div></blockquote>
<p>Where {market_currency} is the asset to be traded using {base_currency} as
the reference, both written in lowercase and separated with an underscore.</p>
<p>This standardization is needed to overcome the lack of consistency in the
naming of assets across different exchanges, and making it easier to the user
to refer to the asset pairs that you want to trade.</p>
<p>Catalyst maintains a <a class="reference external" href="https://www.enigma.co/catalyst/status">Market Coverage Overview</a>
where you can check the mapping between Catalyst naming pairs and that of each
exchange. Catalyst will always expect in all its functions that you will refer to
the asset pairs by using the Catalyst naming convention.</p>
<p>If at any point, you input the wrong name for an asset pair, you will get an error
of that pair not found in the given exchange, and a list of pairs available on that exchange:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$ catalyst ingest-exchange -x poloniex -i btc_usd
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">Ingesting</span> <span class="n">exchange</span> <span class="n">bundle</span> <span class="n">poloniex</span><span class="o">...</span>
<span class="n">Error</span> <span class="n">traceback</span><span class="p">:</span> <span class="o">/</span><span class="n">Volumes</span><span class="o">/</span><span class="n">Data</span><span class="o">/</span><span class="n">Users</span><span class="o">/</span><span class="n">victoris</span><span class="o">/</span><span class="n">Desktop</span><span class="o">/</span><span class="n">Enigma</span><span class="o">/</span><span class="n">user</span><span class="o">-</span><span class="n">install</span><span class="o">/</span><span class="n">catalyst</span><span class="o">-</span><span class="n">dev</span><span class="o">/</span><span class="n">catalyst</span><span class="o">/</span><span class="n">exchange</span><span class="o">/</span><span class="n">exchange</span><span class="o">.</span><span class="n">py</span> <span class="p">(</span><span class="n">line</span> <span class="mi">175</span><span class="p">)</span>
<span class="n">SymbolNotFoundOnExchange</span><span class="p">:</span> <span class="n">Symbol</span> <span class="n">btc_usd</span> <span class="ow">not</span> <span class="n">found</span> <span class="n">on</span> <span class="n">exchange</span> <span class="n">Poloniex</span><span class="o">.</span>
<span class="n">Choose</span> <span class="n">from</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;rep_usdt&#39;</span><span class="p">,</span> <span class="s1">&#39;gno_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;xvc_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;pink_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;sys_btc&#39;</span><span class="p">,</span>
<span class="s1">&#39;emc2_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;rads_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;note_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;maid_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;bch_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;gnt_btc&#39;</span><span class="p">,</span>
<span class="s1">&#39;bcn_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;rep_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;bcy_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;cvc_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;nxt_xmr&#39;</span><span class="p">,</span> <span class="s1">&#39;zec_usdt&#39;</span><span class="p">,</span>
<span class="s1">&#39;fct_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;gas_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;pot_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;eth_usdt&#39;</span><span class="p">,</span> <span class="s1">&#39;btc_usdt&#39;</span><span class="p">,</span> <span class="s1">&#39;lbc_btc&#39;</span><span class="p">,</span>
<span class="s1">&#39;dcr_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;etc_usdt&#39;</span><span class="p">,</span> <span class="s1">&#39;omg_eth&#39;</span><span class="p">,</span> <span class="s1">&#39;amp_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;xpm_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;nxt_btc&#39;</span><span class="p">,</span>
<span class="s1">&#39;vtc_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;steem_eth&#39;</span><span class="p">,</span> <span class="s1">&#39;blk_xmr&#39;</span><span class="p">,</span> <span class="s1">&#39;pasc_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;zec_xmr&#39;</span><span class="p">,</span> <span class="s1">&#39;grc_btc&#39;</span><span class="p">,</span>
<span class="s1">&#39;nxc_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;btcd_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;ltc_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;dash_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;naut_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;zec_eth&#39;</span><span class="p">,</span>
<span class="s1">&#39;zec_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;burst_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;zrx_eth&#39;</span><span class="p">,</span> <span class="s1">&#39;bela_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;steem_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;etc_btc&#39;</span><span class="p">,</span>
<span class="s1">&#39;eth_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;huc_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;strat_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;lsk_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;exp_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;clam_btc&#39;</span><span class="p">,</span>
<span class="s1">&#39;rep_eth&#39;</span><span class="p">,</span> <span class="s1">&#39;dash_xmr&#39;</span><span class="p">,</span> <span class="s1">&#39;cvc_eth&#39;</span><span class="p">,</span> <span class="s1">&#39;bch_usdt&#39;</span><span class="p">,</span> <span class="s1">&#39;zrx_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;dash_usdt&#39;</span><span class="p">,</span>
<span class="s1">&#39;blk_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;xrp_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;nxt_usdt&#39;</span><span class="p">,</span> <span class="s1">&#39;neos_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;omg_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;bts_btc&#39;</span><span class="p">,</span>
<span class="s1">&#39;doge_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;gnt_eth&#39;</span><span class="p">,</span> <span class="s1">&#39;sbd_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;gno_eth&#39;</span><span class="p">,</span> <span class="s1">&#39;xcp_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;ltc_usdt&#39;</span><span class="p">,</span>
<span class="s1">&#39;btm_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;xmr_usdt&#39;</span><span class="p">,</span> <span class="s1">&#39;lsk_eth&#39;</span><span class="p">,</span> <span class="s1">&#39;omni_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;nav_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;fldc_btc&#39;</span><span class="p">,</span>
<span class="s1">&#39;ppc_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;xbc_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;dgb_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;sc_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;btcd_xmr&#39;</span><span class="p">,</span> <span class="s1">&#39;vrc_btc&#39;</span><span class="p">,</span>
<span class="s1">&#39;ric_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;str_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;maid_xmr&#39;</span><span class="p">,</span> <span class="s1">&#39;xmr_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;sjcx_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;via_btc&#39;</span><span class="p">,</span>
<span class="s1">&#39;xem_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;nmc_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;etc_eth&#39;</span><span class="p">,</span> <span class="s1">&#39;ltc_xmr&#39;</span><span class="p">,</span> <span class="s1">&#39;ardr_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;gas_eth&#39;</span><span class="p">,</span>
<span class="s1">&#39;flo_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;xrp_usdt&#39;</span><span class="p">,</span> <span class="s1">&#39;game_btc&#39;</span><span class="p">,</span> <span class="s1">&#39;bch_eth&#39;</span><span class="p">,</span> <span class="s1">&#39;bcn_xmr&#39;</span><span class="p">,</span> <span class="s1">&#39;str_usdt&#39;</span><span class="p">]</span>
</pre></div>
</div>
<p>In the example above, exchange Poloniex does not use USD, but uses instead the
USDT cryptocurrency asset that is issued on the Bitcoin blockchain via the Omni
Layer Protocol. Each USDT unit is backed by a U.S Dollar held in the reserves of
Tether Limited. USDT can be transferred, stored, and spent, just like bitcoins
or any other cryptocurrency. Given its 1:1 mapping to the USD, is a viable alternative.</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$ catalyst ingest-exchange -x poloniex -i btc_usdt
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">Ingesting</span> <span class="n">exchange</span> <span class="n">bundle</span> <span class="n">poloniex</span><span class="o">...</span>
<span class="p">[</span><span class="o">====================================</span><span class="p">]</span> <span class="n">Fetching</span> <span class="n">poloniex</span> <span class="n">daily</span> <span class="n">candles</span><span class="p">:</span> <span class="p">:</span> <span class="mi">100</span><span class="o">%</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Features</a><ul>
<li><a class="reference internal" href="#current-functionality">Current Functionality</a></li>
<li><a class="reference internal" href="#upcoming-features">Upcoming features</a></li>
<li><a class="reference internal" href="#naming-convention">Naming Convention</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="live-trading.html"
title="previous chapter">Live Trading</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="example-algos.html"
title="next chapter">Example Algorithms</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/features.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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="example-algos.html" title="Example Algorithms"
>next</a> |</li>
<li class="right" >
<a href="live-trading.html" title="Live Trading"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Catalyst 0.4 documentation</a> &#187;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2018, Enigma MPC, Inc..
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink