1.10.854

[ci skip]
nhewitt1 · Jan 26, 2018 · a516e29 · a516e29
1 parent 46a1d79
commit a516e29
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 15 deletions.
diff --git a/build/ccxt.browser.js b/build/ccxt.browser.js
diff --git a/ccxt.js b/ccxt.js
@@ -37,7 +37,7 @@ const Exchange  = require ('./js/base/Exchange')
 //-----------------------------------------------------------------------------
 // this is updated by vss.js when building
 
-const version = '1.10.853'
+const version = '1.10.854'
 
 Exchange.ccxtVersion = version
 

diff --git a/doc/manual.rst b/doc/manual.rst
@@ -983,8 +983,8 @@ Market Data
 -  `OHLCV Candlestick Charts <https://github.com/ccxt/ccxt/wiki/Manual#ohlcv-candlestick-charts>`__
 -  `Public Trades And Closed Orders <https://github.com/ccxt/ccxt/wiki/Manual#trades-orders-executions-transactions>`__
 
-Order Book / Market Depth
--------------------------
+Order Book
+----------
 
 Exchanges expose information on open orders with bid (buy) and ask (sell) prices, volumes and other data. Usually there is a separate endpoint for querying current state (stack frame) of the *order book* for a particular market. An order book is also often called *market depth*. The order book information is used in the trading decision making process.
 
@@ -1042,7 +1042,10 @@ Prices and amounts are floats. The bids array is sorted by price in descending o
 
 Exchanges may return the stack of orders in various levels of details for analysis. It is either in full detail containing each and every order, or it is aggregated having slightly less detail where orders are grouped and merged by price and volume. Having greater detail requires more traffic and bandwidth and is slower in general but gives a benefit of higher precision. Having less detail is usually faster, but may not be enough in some very specific cases.
 
-Some exchanges accept a second dictionary of extra parameters to the ``fetchOrderBook () / fetch_order_book ()`` function allowing you to get the level of aggregation you need, like so:
+Market Depth
+~~~~~~~~~~~~
+
+Some exchanges accept a second dictionary of extra parameters to the ``fetchOrderBook () / fetch_order_book ()`` function. **All extra ``params`` are exchange-specific (non-unified)**. You will need to consult exchanges docs if you want to override a particular param, like the depth of the order book (or the count of returned orders on both sides). You can get a limited count of returned orders or a desired level of aggregation (aka *market depth*) by specifying an exchange-specific extra ``param`` like so:
 
 .. code:: javascript
 
@@ -1052,7 +1055,7 @@ Some exchanges accept a second dictionary of extra parameters to the ``fetchOrde
         const ccxt = require ('ccxt')
         const exchange = new ccxt.bitfinex ()
         const orders = await exchange.fetchOrderBook ('BTC/USD', {
-            'limit_bids': 5, // max = 50
+            'limit_bids': 5, // max = 50, bitfinex-specific!
             'limit_asks': 5, // may be 0 in which case the array is empty
             'group': 1, // 1 = orders are grouped by price, 0 = orders are separate
         })
@@ -1064,7 +1067,7 @@ Some exchanges accept a second dictionary of extra parameters to the ``fetchOrde
 
     import ccxt
     # return up to ten bidasks on each side of the order book stack
-    ccxt.cex().fetch_order_book('BTC/USD', {'depth': 10})
+    ccxt.cex().fetch_order_book('BTC/USD', {'depth': 10})  # cex-specific!
 
 .. code:: php
 
@@ -1074,7 +1077,7 @@ Some exchanges accept a second dictionary of extra parameters to the ``fetchOrde
     $exchange = '\\ccxt\\kraken';
     $exchange = new $exchange ();
     var_dump ($exchange->fetch_order_book ('BTC/USD', array (
-        'count' => 10, // up to ten orders on each side for example
+        'count' => 10, // up to ten orders on each side for example, kraken-specific
     )));
 
 The levels of detail or levels of order book aggregation are often number-labelled like L1, L2, L3...

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ccxt",
-  "version": "1.10.853",
+  "version": "1.10.854",
   "description": "A JavaScript / Python / PHP cryptocurrency trading library with support for 90+ exchanges",
   "main": "./ccxt.js",
   "unpkg": "build/ccxt.browser.js",

diff --git a/php/Exchange.php b/php/Exchange.php
@@ -30,7 +30,7 @@
 
 namespace ccxt;
 
-$version = '1.10.853';
+$version = '1.10.854';
 
 abstract class Exchange {
 

diff --git a/python/ccxt/__init__.py b/python/ccxt/__init__.py
@@ -28,7 +28,7 @@
 
 # ----------------------------------------------------------------------------
 
-__version__ = '1.10.853'
+__version__ = '1.10.854'
 
 # ----------------------------------------------------------------------------
 

diff --git a/python/ccxt/async/__init__.py b/python/ccxt/async/__init__.py
@@ -4,7 +4,7 @@
 
 # -----------------------------------------------------------------------------
 
-__version__ = '1.10.853'
+__version__ = '1.10.854'
 
 # -----------------------------------------------------------------------------
 

diff --git a/python/ccxt/async/base/exchange.py b/python/ccxt/async/base/exchange.py
@@ -2,7 +2,7 @@
 
 # -----------------------------------------------------------------------------
 
-__version__ = '1.10.853'
+__version__ = '1.10.854'
 
 # -----------------------------------------------------------------------------
 

diff --git a/python/ccxt/base/exchange.py b/python/ccxt/base/exchange.py
@@ -4,7 +4,7 @@
 
 # -----------------------------------------------------------------------------
 
-__version__ = '1.10.853'
+__version__ = '1.10.854'
 
 # -----------------------------------------------------------------------------