ccxt 4.2.73 → 4.2.74

package/examples/js/tickers.js

@@ -0,0 +1,106 @@
+
+
+import ccxt from '../../js/ccxt.js';
+import asTable from 'as-table';
+import ansicolor from 'ansicolor';
+import ololog from 'ololog';
+
+const log = ololog.configure ({ locate: false }), verbose   = process.argv.includes ('--verbose');
+
+ansicolor.nice
+
+//-----------------------------------------------------------------------------
+
+let printSupportedExchanges = function () {
+    log ('Supported exchanges:', ccxt.exchanges.join (', ').green)
+}
+
+let printUsage = function () {
+    log ('Usage: node', process.argv[1], 'id'.green, '[symbol]'.yellow)
+    printSupportedExchanges ()
+}
+
+let printSymbols = function (exchange) {
+    log (id.green, 'has', exchange.symbols.length, 'symbols:', exchange.symbols.join (', ').yellow)
+}
+
+let sleep = (ms) => new Promise (resolve => setTimeout (resolve, ms))
+
+let printTicker = async (exchange, symbol) => {
+    let ticker = await exchange.fetchTicker (symbol)
+    log (exchange.id.green, symbol.yellow, 'ticker',
+        ticker['datetime'],
+        'high: '    + ticker['high'],
+        'low: '     + ticker['low'],
+        'bid: '     + ticker['bid'],
+        'ask: '     + ticker['ask'],
+        'volume: '  + ticker['baseVolume'])
+    return ticker
+}
+
+//-----------------------------------------------------------------------------
+
+let printTickers = async (id) => {
+
+    log ('Instantiating', id.green, 'exchange exchange')
+
+    // instantiate the exchange by id
+    let exchange = new ccxt[id] ({ verbose })
+
+    // load all markets from the exchange
+    let markets = await exchange.loadMarkets ()
+
+    if (process.argv.length > 3) { // if a symbol was supplied, get that symbol only
+
+        let symbol = process.argv[3]
+
+        await printTicker (exchange, symbol)
+
+    } else { // otherwise run through all symbols one by one
+
+        for (let symbol of exchange.symbols)
+            if ((symbol.indexOf ('.d') < 0)) { // skip darkpool symbols
+
+                const market = exchange.markets[symbol];
+
+                if (!market['active']) {
+                    log.red (exchange.id + ' ' + symbol + ' inactive');
+                    continue;
+                }
+
+                await sleep (exchange.rateLimit)
+                await printTicker (exchange, symbol)
+            }
+    }
+}
+
+//-----------------------------------------------------------------------------
+
+;(async function main () {
+
+    if (process.argv.length > 2) {
+
+        let id = process.argv[2]
+
+        // check if the exchange is supported by ccxt
+        let exchangeFound = ccxt.exchanges.indexOf (id) > -1
+
+        if (exchangeFound) {
+
+            await printTickers (id)
+
+        } else {
+
+            log ('Exchange ' + id.red + ' not found')
+            printUsage ()
+        }
+
+    } else {
+
+        printUsage ()
+
+    }
+
+    process.exit ()
+
+}) ()

package/examples/js/validate-paginated-data.js

@@ -0,0 +1,61 @@
+
+
+import ccxt from '../../js/ccxt.js';
+import ololog from 'ololog'
+import ansicolor from 'ansicolor';
+
+const log = ololog.configure ({ locate: false })
+
+ansicolor.nice
+
+//-----------------------------------------------------------------------------
+
+/*
+* Warning: Sometimes the exchanges have gaps in their OHLCV data, so it does not mean
+* that CCXT is broken if you see gaps in the chart.
+*/
+
+async function fetchData(exchange, symbol, timeframe) {
+    await exchange.loadMarkets()
+    // exchange.verbose = true;
+    const duration = exchange.parseTimeframe (timeframe) *1000; // in milliseconds
+    const ohlcv = await exchange.fetchOHLCV (symbol, timeframe, undefined, undefined, {'paginate': true, 'paginationCalls': 5})
+    validateTimeframes(ohlcv, duration, exchange, symbol)
+}
+
+function validateTimeframes(ohlcv, duration, exchange, symbol) {
+    for (let j = 0; j < ohlcv.length; j++) {
+        const [timestamp, open, high, low, close, volume] = ohlcv[j]
+        if (j > 0) {
+            const [prevTimestamp, prevOpen, prevHigh, prevLow, prevClose, prevVolume] = ohlcv[j - 1]
+            if (timestamp - prevTimestamp !== duration) {
+                log.red ('[' + j + ']',exchange.id, symbol, 'OHLCV data is not continuous, at', exchange.iso8601 (timestamp), 'diff:', ((timestamp - prevTimestamp) / 1000), 's expected:', duration/ 1000, 's')
+            }
+        }
+    }
+    log.green(exchange.id, symbol, `All the ${ohlcv.length} candles returned are continuous`)
+}
+
+async function main () {
+
+    const exchanges = {
+        'binance': 'BTC/USDT',
+        'bitget': 'BTC/USDT',
+        'kucoin': 'BTC/USDT',
+        'kucoinfutures': 'BTC/USDT:USDT',
+        'okex': 'BTC/USDT',
+        'bybit': 'BTC/USDT'
+    }
+    const timeframe = '1m';
+    const keys = Object.keys (exchanges)
+    const promises = [];
+    for (let i = 0; i < keys.length; i++) {
+        const name = keys[i]
+        const symbol = exchanges[name]
+        const exchange = new ccxt[name] ({ enableRateLimit: true })
+        promises.push(fetchData(exchange, symbol, timeframe))
+    }
+    await Promise.all(promises)
+}
+
+main()

package/examples/js/watch-OHLCV-For-Symbols.js

@@ -0,0 +1,15 @@
+import ccxt from '../../js/ccxt.js';
+// AUTO-TRANSPILE //
+async function example() {
+    const binance = new ccxt.pro.binance({});
+    const subscriptions = [
+        ['BTC/USDT', '5m'],
+        ['ETH/USDT', '5m'],
+        ['BTC/USDT', '1h'],
+    ];
+    while (true) {
+        const ohlcv = await binance.watchOHLCVForSymbols(subscriptions);
+        console.log(ohlcv);
+    }
+}
+await example();

package/examples/js/watch-OHLCV.js

@@ -0,0 +1,12 @@
+import ccxt from '../../js/ccxt.js';
+// AUTO-TRANSPILE //
+async function example() {
+    const binance = new ccxt.pro.binance({});
+    const symbol = 'BTC/USDT';
+    const timeframe = '1m';
+    while (true) {
+        const ohlcv = await binance.watchOHLCV(symbol, timeframe);
+        console.log(ohlcv);
+    }
+}
+await example();

package/examples/js/watch-OrderBook-For-Symbols.js

@@ -0,0 +1,11 @@
+import ccxt from '../../js/ccxt.js';
+// AUTO-TRANSPILE //
+async function example() {
+    const binance = new ccxt.pro.binance({});
+    const symbols = ['BTC/USDT', 'ETH/USDT', 'DOGE/USDT'];
+    while (true) {
+        const orderbook = await binance.watchOrderBookForSymbols(symbols);
+        console.log(orderbook['symbol'], orderbook['asks'][0], orderbook['bids'][0]);
+    }
+}
+await example();

package/examples/js/watch-Trades-For-Symbols.js

@@ -0,0 +1,11 @@
+import ccxt from '../../js/ccxt.js';
+// AUTO-TRANSPILE //
+async function example() {
+    const binance = new ccxt.pro.binance({});
+    const symbols = ['BTC/USDT', 'ETH/USDT', 'DOGE/USDT'];
+    while (true) {
+        const trades = await binance.watchTradesForSymbols(symbols);
+        console.log(trades);
+    }
+}
+await example();

package/examples/js/watch-tickers.js

@@ -0,0 +1,11 @@
+import ccxt from '../../js/ccxt.js';
+// AUTO-TRANSPILE //
+async function example() {
+    const binance = new ccxt.pro.binance({});
+    const symbols = ['BTC/USDT', 'ETH/USDT', 'DOGE/USDT'];
+    while (true) {
+        const tickers = await binance.watchTickers(symbols);
+        console.log(tickers['BTC/USDT'], tickers['ETH/USDT'], tickers['DOGE/USDT']);
+    }
+}
+await example();

package/examples/js/watchOHLCVForSymbols.js

@@ -0,0 +1,15 @@
+import ccxt from '../../js/ccxt.js';
+// AUTO-TRANSPILE //
+async function example() {
+    const binance = new ccxt.pro.binance({});
+    const subscriptions = [
+        ['BTC/USDT', '5m'],
+        ['ETH/USDT', '5m'],
+        ['BTC/USDT', '1h'],
+    ];
+    while (true) {
+        const ohlcv = await binance.watchOHLCVForSymbols(subscriptions);
+        console.log(ohlcv);
+    }
+}
+await example();

package/examples/js/watchOrderBookForSymbols.js

@@ -0,0 +1,11 @@
+import ccxt from '../../js/ccxt.js';
+// AUTO-TRANSPILE //
+async function example() {
+    const binance = new ccxt.pro.binance({});
+    const symbol = ['BTC/USDT', 'ETH/USDT', 'DOGE/USDT'];
+    while (true) {
+        const orderbook = await binance.watchOrderBookForSymbols(symbol);
+        console.log(orderbook['symbol'], orderbook['asks'][0], orderbook['bids'][0]);
+    }
+}
+await example();

package/examples/js/watchPositions-many-exchanges-continuosly.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=watchPositions-many-exchanges-continuosly.d.ts.map

package/examples/js/watchPositions-many-exchanges-continuosly.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"watchPositions-many-exchanges-continuosly.d.ts","sourceRoot":"","sources":["../ts/watchPositions-many-exchanges-continuosly.ts"],"names":[],"mappings":""}

package/examples/js/watchPositions-many-exchanges-continuosly.js

@@ -0,0 +1,49 @@
+import ccxt from '../../js/ccxt.js';
+// AUTO-TRANSPILE //
+// watch and handle constinuosly
+async function watchPositionsContinuously(exchange) {
+    while (true) {
+        try {
+            const positions = await exchange.watchPositions();
+            console.log('Fetched ', exchange.id, ' - Positions: ', positions);
+        }
+        catch (e) {
+            console.log(e);
+            break;
+        }
+    }
+}
+// start exchanges and fetch OHLCV loop
+async function startExchange(exchangeName, config) {
+    const ex = new ccxt[exchangeName](config);
+    const promises = [];
+    promises.push(watchPositionsContinuously(ex));
+    await Promise.all(promises);
+    await ex.close();
+}
+// main function
+async function example() {
+    const exchanges = {
+        'binanceusdm': {
+            'apiKey': 'YOUR_API_KEY',
+            'secret': 'YOUR_API_SECRET',
+        },
+        'okx': {
+            'apiKey': 'YOUR_API_KEY',
+            'secret': 'YOUR_API_SECRET',
+        },
+        'huobi': {
+            'apiKey': 'YOUR_API_KEY',
+            'secret': 'YOUR_API_SECRET',
+        },
+    };
+    const promises = [];
+    const exchangeIds = Object.keys(exchanges);
+    for (let i = 0; i < exchangeIds.length; i++) {
+        const exchangeName = exchangeIds[i];
+        const config = exchanges[exchangeName];
+        promises.push(startExchange(exchangeName, config));
+    }
+    await Promise.all(promises);
+}
+await example();

package/examples/js/watchPositions.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=watchPositions.d.ts.map

package/examples/js/watchPositions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"watchPositions.d.ts","sourceRoot":"","sources":["../ts/watchPositions.ts"],"names":[],"mappings":""}

package/examples/js/watchPositions.js

@@ -0,0 +1,13 @@
+import ccxt from '../../js/ccxt.js';
+// AUTO-TRANSPILE //
+async function example() {
+    const exchange = new ccxt.pro.binanceusdm({
+        'apiKey': 'YOUR_API_KEY',
+        'secret': 'YOUR_API_SECRET'
+    });
+    while (true) {
+        const trades = await exchange.watchPositions();
+        console.log(trades);
+    }
+}
+await example();

package/examples/js/watchPositionsForSymbols.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=watchPositionsForSymbols.d.ts.map

package/examples/js/watchPositionsForSymbols.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"watchPositionsForSymbols.d.ts","sourceRoot":"","sources":["../ts/watchPositionsForSymbols.ts"],"names":[],"mappings":""}

package/examples/js/watchPositionsForSymbols.js

@@ -0,0 +1,14 @@
+import ccxt from '../../js/ccxt.js';
+// AUTO-TRANSPILE //
+async function example() {
+    const exchange = new ccxt.pro.binanceusdm({
+        'apiKey': 'YOUR_API_KEY',
+        'secret': 'Your_API_SECRET'
+    });
+    const symbols = ['BTC/USDT:USDT', 'ETH/USDT:USDT', 'DOGE/USDT:USDT'];
+    while (true) {
+        const trades = await exchange.watchPositions(symbols);
+        console.log(trades);
+    }
+}
+await example();

package/examples/js/watchTradesForSymbols.js

@@ -0,0 +1,11 @@
+import ccxt from '../../js/ccxt.js';
+// AUTO-TRANSPILE //
+async function example() {
+    const binance = new ccxt.pro.binance({});
+    const symbols = ['BTC/USDT', 'ETH/USDT', 'DOGE/USDT'];
+    while (true) {
+        const trades = await binance.watchTradesForSymbols(symbols);
+        console.log(trades);
+    }
+}
+await example();

package/examples/js/withdraw-from-one-exchange-to-another.js

@@ -0,0 +1,50 @@
+import ccxt from '../../js/ccxt.js';
+
+console.log ('CCXT Version', ccxt.version)
+
+async function main () {
+
+    const binance = new ccxt.binance ({
+        'apiKey': 'YOUR_API_KEY',
+        'secret': 'YOUR_SECRET',
+        'options': {
+            'fetchCurrencies': true,
+        },
+    })
+
+    const kucoin = new ccxt.kucoin ({
+        'apiKey': 'YOUR_API_KEY',
+        'secret': 'YOUR_SECRET',
+        'password': 'YOUR_API_PASSWORD',
+    })
+
+    await binance.loadMarkets ()
+    await kucoin.loadMarkets ()
+
+    binance.verbose = true
+    kucoin.verbose = true
+
+    const code = 'COTI'
+    const amount = 40
+
+    // https://github.com/ccxt/ccxt/wiki/Manual#overriding-unified-api-params
+    // https://binance-docs.github.io/apidocs/spot/en/#deposit-address-supporting-network-user_data
+    const deposit = await binance.fetchDepositAddress (code, { 'network': 'ETH' })
+
+    console.log ('-----------------------------------------------------------')
+
+    console.log (depositAddress)
+
+    console.log ('-----------------------------------------------------------')
+
+    // https://github.com/ccxt/ccxt/wiki/Manual#overriding-unified-api-params
+    // https://docs.kucoin.com/#apply-withdraw-2
+    const withdrawal = await kucoin.withdraw (code, amount, deposit['address'], deposit['tag'], { 'chain': 'ERC20' })
+
+    console.log ('-----------------------------------------------------------')
+
+    console.log (withdrawal)
+
+}
+
+main ()

package/examples/php/README.md

@@ -0,0 +1,7 @@
+# CCXT PHP Examples
+
+To run PHP examples from any folder type in console:
+
+```shell
+php -f path/to/example.php # substitute for actual filename here
+```

package/examples/py/README.md

@@ -0,0 +1,15 @@
+# CCXT Python Examples
+
+To run Python examples from any folder, type in console:
+
+```shell
+python path/to/example.py # substitute for actual filename here
+```
+
+Example files starting with `async-` require Python 3.6 with `async`/`await` and async generators support.
+
+![basic-chart](https://user-images.githubusercontent.com/1294454/29979754-6d62354c-8f4f-11e7-9e0a-22e87b4a093b.jpg)
+
+## See Also
+
+[co3k-crypto-currency-note](https://github.com/co3k/co3k-crypto-currency-note/blob/master/Untitled.ipynb) – an example of using ccxt to fetch OHLCV candles from Kraken and charting them with matplotlib in a Jupyter Notebook, made by [co3k](https://github.com/co3k).