ccxt 4.4.30 → 4.4.32

package/js/src/pro/mexc.js

@@ -71,19 +71,19 @@ export default class mexc extends mexcRest {
             'exceptions': {},
         });
     }
+    /**
+     * @method
+     * @name mexc#watchTicker
+     * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#individual-symbol-book-ticker-streams
+     * @see https://mexcdevelop.github.io/apidocs/contract_v1_en/#public-channels
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#miniticker
+     * @param {string} symbol unified symbol of the market to fetch the ticker for
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @param {boolean} [params.miniTicker] set to true for using the miniTicker endpoint
+     * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
+     */
     async watchTicker(symbol, params = {}) {
-        /**
-         * @method
-         * @name mexc#watchTicker
-         * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#individual-symbol-book-ticker-streams
-         * @see https://mexcdevelop.github.io/apidocs/contract_v1_en/#public-channels
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#miniticker
-         * @param {string} symbol unified symbol of the market to fetch the ticker for
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @param {boolean} [params.miniTicker] set to true for using the miniTicker endpoint
-         * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const messageHash = 'ticker:' + market['symbol'];
@@ -194,19 +194,19 @@ export default class mexc extends mexcRest {
         const messageHash = 'ticker:' + symbol;
         client.resolve(ticker, messageHash);
     }
+    /**
+     * @method
+     * @name mexc#watchTickers
+     * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#individual-symbol-book-ticker-streams
+     * @see https://mexcdevelop.github.io/apidocs/contract_v1_en/#public-channels
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#minitickers
+     * @param {string[]} symbols unified symbol of the market to fetch the ticker for
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @param {boolean} [params.miniTicker] set to true for using the miniTicker endpoint
+     * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
+     */
     async watchTickers(symbols = undefined, params = {}) {
-        /**
-         * @method
-         * @name mexc#watchTickers
-         * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#individual-symbol-book-ticker-streams
-         * @see https://mexcdevelop.github.io/apidocs/contract_v1_en/#public-channels
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#minitickers
-         * @param {string[]} symbols unified symbol of the market to fetch the ticker for
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @param {boolean} [params.miniTicker] set to true for using the miniTicker endpoint
-         * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
-         */
         await this.loadMarkets();
         symbols = this.marketSymbols(symbols, undefined);
         const messageHashes = [];
@@ -406,16 +406,16 @@ export default class mexc extends mexcRest {
             'quoteVolume': this.safeNumber(ticker, 'q'),
         }, market);
     }
+    /**
+     * @method
+     * @name mexc#watchBidsAsks
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#individual-symbol-book-ticker-streams
+     * @description watches best bid & ask for symbols
+     * @param {string[]} symbols unified symbol of the market to fetch the ticker for
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
+     */
     async watchBidsAsks(symbols = undefined, params = {}) {
-        /**
-         * @method
-         * @name mexc#watchBidsAsks
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#individual-symbol-book-ticker-streams
-         * @description watches best bid & ask for symbols
-         * @param {string[]} symbols unified symbol of the market to fetch the ticker for
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
-         */
         await this.loadMarkets();
         symbols = this.marketSymbols(symbols, undefined, true, false, true);
         let marketType = undefined;
@@ -532,19 +532,19 @@ export default class mexc extends mexcRest {
         const message = this.extend(request, params);
         return await this.watch(url, messageHash, message, channel);
     }
+    /**
+     * @method
+     * @name mexc#watchOHLCV
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#kline-streams
+     * @description watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+     * @param {string} symbol unified symbol of the market to fetch OHLCV data for
+     * @param {string} timeframe the length of time each candle represents
+     * @param {int} [since] timestamp in ms of the earliest candle to fetch
+     * @param {int} [limit] the maximum amount of candles to fetch
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
+     */
     async watchOHLCV(symbol, timeframe = '1m', since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name mexc#watchOHLCV
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#kline-streams
-         * @description watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
-         * @param {string} symbol unified symbol of the market to fetch OHLCV data for
-         * @param {string} timeframe the length of time each candle represents
-         * @param {int} [since] timestamp in ms of the earliest candle to fetch
-         * @param {int} [limit] the maximum amount of candles to fetch
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         symbol = market['symbol'];
@@ -678,18 +678,18 @@ export default class mexc extends mexcRest {
             this.safeNumber2(ohlcv, 'v', 'q'),
         ];
     }
+    /**
+     * @method
+     * @name mexc#watchOrderBook
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#diff-depth-stream
+     * @see https://mexcdevelop.github.io/apidocs/contract_v1_en/#public-channels
+     * @description watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+     * @param {string} symbol unified symbol of the market to fetch the order book for
+     * @param {int} [limit] the maximum amount of order book entries to return
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
+     */
     async watchOrderBook(symbol, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name mexc#watchOrderBook
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#diff-depth-stream
-         * @see https://mexcdevelop.github.io/apidocs/contract_v1_en/#public-channels
-         * @description watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
-         * @param {string} symbol unified symbol of the market to fetch the order book for
-         * @param {int} [limit] the maximum amount of order book entries to return
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         symbol = market['symbol'];
@@ -849,19 +849,19 @@ export default class mexc extends mexcRest {
         this.handleBooksideDelta(asksOrderSide, asks);
         this.handleBooksideDelta(bidsOrderSide, bids);
     }
+    /**
+     * @method
+     * @name mexc#watchTrades
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#trade-streams
+     * @see https://mexcdevelop.github.io/apidocs/contract_v1_en/#public-channels
+     * @description get the list of most recent trades for a particular symbol
+     * @param {string} symbol unified symbol of the market to fetch trades for
+     * @param {int} [since] timestamp in ms of the earliest trade to fetch
+     * @param {int} [limit] the maximum amount of trades to fetch
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
+     */
     async watchTrades(symbol, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name mexc#watchTrades
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#trade-streams
-         * @see https://mexcdevelop.github.io/apidocs/contract_v1_en/#public-channels
-         * @description get the list of most recent trades for a particular symbol
-         * @param {string} symbol unified symbol of the market to fetch trades for
-         * @param {int} [since] timestamp in ms of the earliest trade to fetch
-         * @param {int} [limit] the maximum amount of trades to fetch
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         symbol = market['symbol'];
@@ -939,19 +939,19 @@ export default class mexc extends mexcRest {
         }
         client.resolve(stored, messageHash);
     }
+    /**
+     * @method
+     * @name mexc#watchMyTrades
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#spot-account-deals
+     * @see https://mexcdevelop.github.io/apidocs/contract_v1_en/#private-channels
+     * @description watches information on multiple trades made by the user
+     * @param {string} symbol unified market symbol of the market trades were made in
+     * @param {int} [since] the earliest time in ms to fetch trades for
+     * @param {int} [limit] the maximum number of trade structures to retrieve
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
+     */
     async watchMyTrades(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name mexc#watchMyTrades
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#spot-account-deals
-         * @see https://mexcdevelop.github.io/apidocs/contract_v1_en/#private-channels
-         * @description watches information on multiple trades made by the user
-         * @param {string} symbol unified market symbol of the market trades were made in
-         * @param {int} [since] the earliest time in ms to fetch trades for
-         * @param {int} [limit] the maximum number of trade structures to retrieve
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
-         */
         await this.loadMarkets();
         let messageHash = 'myTrades';
         let market = undefined;
@@ -1087,20 +1087,20 @@ export default class mexc extends mexcRest {
             },
         }, market);
     }
+    /**
+     * @method
+     * @name mexc#watchOrders
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#spot-account-orders
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#margin-account-orders
+     * @description watches information on multiple orders made by the user
+     * @param {string} symbol unified market symbol of the market orders were made in
+     * @param {int} [since] the earliest time in ms to fetch orders for
+     * @param {int} [limit] the maximum number of order structures to retrieve
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @param {string|undefined} params.type the type of orders to retrieve, can be 'spot' or 'margin'
+     * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
+     */
     async watchOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name mexc#watchOrders
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#spot-account-orders
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#margin-account-orders
-         * @description watches information on multiple orders made by the user
-         * @param {string} symbol unified market symbol of the market orders were made in
-         * @param {int} [since] the earliest time in ms to fetch orders for
-         * @param {int} [limit] the maximum number of order structures to retrieve
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @param {string|undefined} params.type the type of orders to retrieve, can be 'spot' or 'margin'
-         * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
-         */
         await this.loadMarkets();
         params = this.omit(params, 'type');
         let messageHash = 'orders';
@@ -1308,8 +1308,7 @@ export default class mexc extends mexcRest {
             '2': 'closed',
             '3': 'open',
             '4': 'canceled',
-            '5': 'open',
-            '6': 'closed',
+            '5': 'closed',
             'NEW': 'open',
             'CANCELED': 'canceled',
             'EXECUTED': 'closed',
@@ -1339,15 +1338,15 @@ export default class mexc extends mexcRest {
         };
         return this.safeString(timeInForceIds, timeInForce);
     }
+    /**
+     * @method
+     * @name mexc#watchBalance
+     * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#spot-account-upadte
+     * @description watch balance and get the amount of funds available for trading or funds locked in orders
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
+     */
     async watchBalance(params = {}) {
-        /**
-         * @method
-         * @name mexc#watchBalance
-         * @see https://mexcdevelop.github.io/apidocs/spot_v3_en/#spot-account-upadte
-         * @description watch balance and get the amount of funds available for trading or funds locked in orders
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
-         */
         await this.loadMarkets();
         let type = undefined;
         [type, params] = this.handleMarketTypeAndParams('watchBalance', undefined, params);

package/js/src/pro/ndax.d.ts

@@ -4,12 +4,54 @@ import Client from '../base/ws/Client.js';
 export default class ndax extends ndaxRest {
     describe(): any;
     requestId(): any;
+    /**
+     * @method
+     * @name ndax#watchTicker
+     * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+     * @see https://apidoc.ndax.io/#subscribelevel1
+     * @param {string} symbol unified symbol of the market to fetch the ticker for
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
+     */
     watchTicker(symbol: string, params?: {}): Promise<Ticker>;
     handleTicker(client: Client, message: any): void;
+    /**
+     * @method
+     * @name ndax#watchTrades
+     * @description get the list of most recent trades for a particular symbol
+     * @see https://apidoc.ndax.io/#subscribetrades
+     * @param {string} symbol unified symbol of the market to fetch trades for
+     * @param {int} [since] timestamp in ms of the earliest trade to fetch
+     * @param {int} [limit] the maximum amount of trades to fetch
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
+     */
     watchTrades(symbol: string, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
     handleTrades(client: Client, message: any): void;
+    /**
+     * @method
+     * @name ndax#watchOHLCV
+     * @description watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+     * @see https://apidoc.ndax.io/#subscribeticker
+     * @param {string} symbol unified symbol of the market to fetch OHLCV data for
+     * @param {string} timeframe the length of time each candle represents
+     * @param {int} [since] timestamp in ms of the earliest candle to fetch
+     * @param {int} [limit] the maximum amount of candles to fetch
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
+     */
     watchOHLCV(symbol: string, timeframe?: string, since?: Int, limit?: Int, params?: {}): Promise<OHLCV[]>;
     handleOHLCV(client: Client, message: any): void;
+    /**
+     * @method
+     * @name ndax#watchOrderBook
+     * @description watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+     * @see https://apidoc.ndax.io/#subscribelevel2
+     * @param {string} symbol unified symbol of the market to fetch the order book for
+     * @param {int} [limit] the maximum amount of order book entries to return
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
+     */
     watchOrderBook(symbol: string, limit?: Int, params?: {}): Promise<OrderBook>;
     handleOrderBook(client: Client, message: any): void;
     handleOrderBookSubscription(client: Client, message: any, subscription: any): void;

package/js/src/pro/ndax.js

@@ -39,16 +39,16 @@ export default class ndax extends ndaxRest {
         this.options['requestId'] = requestId;
         return requestId;
     }
+    /**
+     * @method
+     * @name ndax#watchTicker
+     * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+     * @see https://apidoc.ndax.io/#subscribelevel1
+     * @param {string} symbol unified symbol of the market to fetch the ticker for
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
+     */
     async watchTicker(symbol, params = {}) {
-        /**
-         * @method
-         * @name ndax#watchTicker
-         * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-         * @see https://apidoc.ndax.io/#subscribelevel1
-         * @param {string} symbol unified symbol of the market to fetch the ticker for
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
-         */
         const omsId = this.safeInteger(this.options, 'omsId', 1);
         await this.loadMarkets();
         const market = this.market(symbol);
@@ -105,18 +105,18 @@ export default class ndax extends ndaxRest {
         const messageHash = name + ':' + market['id'];
         client.resolve(ticker, messageHash);
     }
+    /**
+     * @method
+     * @name ndax#watchTrades
+     * @description get the list of most recent trades for a particular symbol
+     * @see https://apidoc.ndax.io/#subscribetrades
+     * @param {string} symbol unified symbol of the market to fetch trades for
+     * @param {int} [since] timestamp in ms of the earliest trade to fetch
+     * @param {int} [limit] the maximum amount of trades to fetch
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
+     */
     async watchTrades(symbol, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name ndax#watchTrades
-         * @description get the list of most recent trades for a particular symbol
-         * @see https://apidoc.ndax.io/#subscribetrades
-         * @param {string} symbol unified symbol of the market to fetch trades for
-         * @param {int} [since] timestamp in ms of the earliest trade to fetch
-         * @param {int} [limit] the maximum amount of trades to fetch
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
-         */
         const omsId = this.safeInteger(this.options, 'omsId', 1);
         await this.loadMarkets();
         const market = this.market(symbol);
@@ -187,19 +187,19 @@ export default class ndax extends ndaxRest {
             client.resolve(tradesArray, messageHash);
         }
     }
+    /**
+     * @method
+     * @name ndax#watchOHLCV
+     * @description watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+     * @see https://apidoc.ndax.io/#subscribeticker
+     * @param {string} symbol unified symbol of the market to fetch OHLCV data for
+     * @param {string} timeframe the length of time each candle represents
+     * @param {int} [since] timestamp in ms of the earliest candle to fetch
+     * @param {int} [limit] the maximum amount of candles to fetch
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
+     */
     async watchOHLCV(symbol, timeframe = '1m', since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name ndax#watchOHLCV
-         * @description watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
-         * @see https://apidoc.ndax.io/#subscribeticker
-         * @param {string} symbol unified symbol of the market to fetch OHLCV data for
-         * @param {string} timeframe the length of time each candle represents
-         * @param {int} [since] timestamp in ms of the earliest candle to fetch
-         * @param {int} [limit] the maximum amount of candles to fetch
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
-         */
         const omsId = this.safeInteger(this.options, 'omsId', 1);
         await this.loadMarkets();
         const market = this.market(symbol);
@@ -320,17 +320,17 @@ export default class ndax extends ndaxRest {
             }
         }
     }
+    /**
+     * @method
+     * @name ndax#watchOrderBook
+     * @description watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+     * @see https://apidoc.ndax.io/#subscribelevel2
+     * @param {string} symbol unified symbol of the market to fetch the order book for
+     * @param {int} [limit] the maximum amount of order book entries to return
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
+     */
     async watchOrderBook(symbol, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name ndax#watchOrderBook
-         * @description watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
-         * @see https://apidoc.ndax.io/#subscribelevel2
-         * @param {string} symbol unified symbol of the market to fetch the order book for
-         * @param {int} [limit] the maximum amount of order book entries to return
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
-         */
         const omsId = this.safeInteger(this.options, 'omsId', 1);
         await this.loadMarkets();
         const market = this.market(symbol);

package/js/src/pro/okcoin.d.ts

@@ -4,20 +4,81 @@ import Client from '../base/ws/Client.js';
 export default class okcoin extends okcoinRest {
     describe(): any;
     subscribe(channel: any, symbol: any, params?: {}): Promise<any>;
+    /**
+     * @method
+     * @name okcoin#watchTrades
+     * @description get the list of most recent trades for a particular symbol
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-trades-channel
+     * @param {string} symbol unified symbol of the market to fetch trades for
+     * @param {int} [since] timestamp in ms of the earliest trade to fetch
+     * @param {int} [limit] the maximum amount of trades to fetch
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
+     */
     watchTrades(symbol: string, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
+    /**
+     * @method
+     * @name okcoin#watchOrders
+     * @description watches information on multiple orders made by the user
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-private-channel-order-channel
+     * @param {string} symbol unified market symbol of the market orders were made in
+     * @param {int} [since] the earliest time in ms to fetch orders for
+     * @param {int} [limit] the maximum number of order structures to retrieve
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
+     */
     watchOrders(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Order[]>;
     handleOrders(client: Client, message: any, subscription?: any): void;
+    /**
+     * @method
+     * @name okcoin#watchTicker
+     * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-tickers-channel
+     * @param {string} symbol unified symbol of the market to fetch the ticker for
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
+     */
     watchTicker(symbol: string, params?: {}): Promise<Ticker>;
     handleTrade(client: Client, message: any): any;
     handleTicker(client: Client, message: any): any;
+    /**
+     * @method
+     * @name okcoin#watchOHLCV
+     * @description watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-candlesticks-channel
+     * @param {string} symbol unified symbol of the market to fetch OHLCV data for
+     * @param {string} timeframe the length of time each candle represents
+     * @param {int} [since] timestamp in ms of the earliest candle to fetch
+     * @param {int} [limit] the maximum amount of candles to fetch
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
+     */
     watchOHLCV(symbol: string, timeframe?: string, since?: Int, limit?: Int, params?: {}): Promise<OHLCV[]>;
     handleOHLCV(client: Client, message: any): void;
+    /**
+     * @method
+     * @name okcoin#watchOrderBook
+     * @description watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-order-book-channel
+     * @param {string} symbol unified symbol of the market to fetch the order book for
+     * @param {int} [limit] the maximum amount of order book entries to return
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
+     */
     watchOrderBook(symbol: string, limit?: Int, params?: {}): Promise<OrderBook>;
     handleDelta(bookside: any, delta: any): void;
     handleDeltas(bookside: any, deltas: any): void;
     handleOrderBookMessage(client: Client, message: any, orderbook: any): any;
     handleOrderBook(client: Client, message: any): any;
     authenticate(params?: {}): Promise<any>;
+    /**
+     * @method
+     * @name okcoin#watchBalance
+     * @description watch balance and get the amount of funds available for trading or funds locked in orders
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-private-channel-account-channel
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
+     */
     watchBalance(params?: {}): Promise<Balances>;
     subscribeToUserAccount(negotiation: any, params?: {}): Promise<any>;
     handleBalance(client: Client, message: any): void;