mirror of
https://github.com/wassname/catalyst.git
synced 2026-06-27 20:04:30 +08:00
DOC: documented paper trading and updated the release notes
This commit is contained in:
@@ -106,6 +106,10 @@ What differs are the arguments provided to the catalyst client or
|
||||
Here is the breakdown of the new arguments:
|
||||
|
||||
- ``live``: Boolean flag which enables live trading.
|
||||
- ``capital_base``: The amount of base_currency assigned to the strategy.
|
||||
It has to be lower or equal to the amount of base currency available for
|
||||
trading on the exchange. For illustration, order_target_percent(asset, 1)
|
||||
will order the capital_base amount specified here of the specified asset.
|
||||
- ``exchange_name``: The name of the targeted exchange
|
||||
(supported values: *bitfinex*, *bittrex*).
|
||||
- ``algo_namespace``: A arbitrary label assigned to your algorithm for
|
||||
@@ -113,6 +117,8 @@ Here is the breakdown of the new arguments:
|
||||
- ``base_currency``: The base currency used to calculate the
|
||||
statistics of your algorithm. Currently, the base currency of all
|
||||
trading pairs of your algorithm must match this value.
|
||||
- ``simulate_orders``: Enables the paper trading mode, in which orders are
|
||||
simulated in Catalyst instead of processed on the exchange.
|
||||
|
||||
Here is a complete algorithm for reference:
|
||||
`Buy Low and Sell High <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/buy_low_sell_high_live.py>`_
|
||||
|
||||
@@ -2,6 +2,15 @@
|
||||
Release Notes
|
||||
=============
|
||||
|
||||
Version 0.3.10
|
||||
^^^^^^^^^^^^^
|
||||
**Release Date**: 2017-12-12
|
||||
|
||||
Bug Fixes
|
||||
~~~~~~~~~
|
||||
|
||||
- Fixed issue with fetching assets with daily frequency
|
||||
|
||||
Version 0.3.10
|
||||
^^^^^^^^^^^^^
|
||||
**Release Date**: 2017-11-28
|
||||
@@ -10,6 +19,16 @@ Bug Fixes
|
||||
~~~~~~~~~
|
||||
|
||||
- Fixed issue with fetching assets with daily frequency
|
||||
- Changed Poloniex interface (should solve :issue:`95` and :issue:`94`)
|
||||
- Solved issue with overriding commission and slippage (:issue:`87`)
|
||||
- Fixed inefficiency with Bittrex current prices (:issue:`76`)
|
||||
|
||||
Build
|
||||
~~~~~
|
||||
- Integrated with CCXT
|
||||
- Added paper trading capability (`simulate_orders=True` param in live mode)
|
||||
- More granular commissions (:issue:`82`)
|
||||
- Added market orders in live mode (:issue:`81`)
|
||||
|
||||
Version 0.3.9
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Reference in New Issue
Block a user