## lbank{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchTime](#fetchtime) * [fetchMarkets](#fetchmarkets) * [fetchTicker](#fetchticker) * [fetchTickers](#fetchtickers) * [fetchOrderBook](#fetchorderbook) * [fetchTrades](#fetchtrades) * [fetchOHLCV](#fetchohlcv) * [fetchBalance](#fetchbalance) * [fetchTradingFee](#fetchtradingfee) * [fetchTradingFees](#fetchtradingfees) * [createMarketBuyOrderWithCost](#createmarketbuyorderwithcost) * [createOrder](#createorder) * [fetchOrder](#fetchorder) * [fetchMyTrades](#fetchmytrades) * [fetchOrders](#fetchorders) * [fetchOpenOrders](#fetchopenorders) * [cancelOrder](#cancelorder) * [cancelAllOrders](#cancelallorders) * [fetchDepositAddress](#fetchdepositaddress) * [withdraw](#withdraw) * [fetchDeposits](#fetchdeposits) * [fetchWithdrawals](#fetchwithdrawals) * [fetchTransactionFees](#fetchtransactionfees) * [fetchDepositWithdrawFees](#fetchdepositwithdrawfees) * [fetchOHLCVWs](#fetchohlcvws) * [watchOHLCV](#watchohlcv) * [fetchTickerWs](#fetchtickerws) * [watchTicker](#watchticker) * [fetchTradesWs](#fetchtradesws) * [watchTrades](#watchtrades) * [watchOrders](#watchorders) * [fetchOrderBookWs](#fetchorderbookws) * [watchOrderBook](#watchorderbook) ### fetchTime{docsify-ignore} fetches the current integer timestamp in milliseconds from the exchange server **Kind**: instance method of [lbank](#lbank) **Returns**: int - the current integer timestamp in milliseconds from the exchange server **See** - https://www.lbank.com/en-US/docs/index.html#get-timestamp - https://www.lbank.com/en-US/docs/contract.html#get-the-current-time | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchTime ([params]) ``` ### fetchMarkets{docsify-ignore} retrieves data on all markets for lbank **Kind**: instance method of [lbank](#lbank) **Returns**: Array<object> - an array of objects representing market data **See** - https://www.lbank.com/en-US/docs/index.html#trading-pairs - https://www.lbank.com/en-US/docs/contract.html#query-contract-information-list | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchMarkets ([params]) ``` ### fetchTicker{docsify-ignore} fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market **Kind**: instance method of [lbank](#lbank) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://www.lbank.com/en-US/docs/index.html#query-current-market-data-new | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchTicker (symbol[, params]) ``` ### fetchTickers{docsify-ignore} fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market **Kind**: instance method of [lbank](#lbank) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure) **See** - https://www.lbank.com/en-US/docs/index.html#query-current-market-data-new - https://www.lbank.com/en-US/docs/contract.html#query-contract-market-list | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchTickers (symbols[, params]) ``` ### fetchOrderBook{docsify-ignore} fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [lbank](#lbank) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See** - https://www.lbank.com/en-US/docs/index.html#query-market-depth - https://www.lbank.com/en-US/docs/contract.html#get-handicap | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the order book for | | limit | int | No | the maximum amount of order book entries to return | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchOrderBook (symbol[, limit, params]) ``` ### fetchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [lbank](#lbank) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See** - https://www.lbank.com/en-US/docs/index.html#query-historical-transactions - https://www.lbank.com/en-US/docs/index.html#recent-transactions-list | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch trades for | | since | int | No | timestamp in ms of the earliest trade to fetch | | limit | int | No | the maximum amount of trades to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchTrades (symbol[, since, limit, params]) ``` ### fetchOHLCV{docsify-ignore} fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [lbank](#lbank) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://www.lbank.com/en-US/docs/index.html#query-k-bar-data | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | since | int | No | timestamp in ms of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### fetchBalance{docsify-ignore} query for balance and get the amount of funds available for trading or funds locked in orders **Kind**: instance method of [lbank](#lbank) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See** - https://www.lbank.com/en-US/docs/index.html#asset-information - https://www.lbank.com/en-US/docs/index.html#account-information - https://www.lbank.com/en-US/docs/index.html#get-all-coins-information | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchBalance ([params]) ``` ### fetchTradingFee{docsify-ignore} fetch the trading fees for a market **Kind**: instance method of [lbank](#lbank) **Returns**: object - a [fee structure](https://docs.ccxt.com/#/?id=fee-structure) **See**: https://www.lbank.com/en-US/docs/index.html#transaction-fee-rate-query | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchTradingFee (symbol[, params]) ``` ### fetchTradingFees{docsify-ignore} fetch the trading fees for multiple markets **Kind**: instance method of [lbank](#lbank) **Returns**: object - a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols **See**: https://www.lbank.com/en-US/docs/index.html#transaction-fee-rate-query | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchTradingFees ([params]) ``` ### createMarketBuyOrderWithCost{docsify-ignore} create a market buy order by providing the symbol and cost **Kind**: instance method of [lbank](#lbank) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.lbank.com/en-US/docs/index.html#place-order - https://www.lbank.com/en-US/docs/index.html#place-an-order | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to create an order in | | cost | float | Yes | how much you want to trade in units of the quote currency | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.createMarketBuyOrderWithCost (symbol, cost[, params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [lbank](#lbank) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.lbank.com/en-US/docs/index.html#place-order - https://www.lbank.com/en-US/docs/index.html#place-an-order | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to create an order in | | type | string | Yes | 'market' or 'limit' | | side | string | Yes | 'buy' or 'sell' | | amount | float | Yes | how much of currency you want to trade in units of base currency | | price | float | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.createOrder (symbol, type, side, amount[, price, params]) ``` ### fetchOrder{docsify-ignore} fetches information on an order made by the user **Kind**: instance method of [lbank](#lbank) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.lbank.com/en-US/docs/index.html#query-order - https://www.lbank.com/en-US/docs/index.html#query-order-new | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market the order was made in | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchOrder (symbol[, params]) ``` ### fetchMyTrades{docsify-ignore} fetch all trades made by the user **Kind**: instance method of [lbank](#lbank) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See**: https://www.lbank.com/en-US/docs/index.html#past-transaction-details | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch trades for | | limit | int | No | the maximum number of trade structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchMyTrades (symbol[, since, limit, params]) ``` ### fetchOrders{docsify-ignore} fetches information on multiple orders made by the user **Kind**: instance method of [lbank](#lbank) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://www.lbank.com/en-US/docs/index.html#query-all-orders | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market orders were made in | | since | int | No | the earliest time in ms to fetch orders for | | limit | int | No | the maximum number of order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchOrders (symbol[, since, limit, params]) ``` ### fetchOpenOrders{docsify-ignore} fetch all unfilled currently open orders **Kind**: instance method of [lbank](#lbank) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://www.lbank.com/en-US/docs/index.html#current-pending-order | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch open orders for | | limit | int | No | the maximum number of open order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchOpenOrders (symbol[, since, limit, params]) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [lbank](#lbank) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://www.lbank.com/en-US/docs/index.html#cancel-order-new | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | unified symbol of the market the order was made in | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.cancelOrder (id, symbol[, params]) ``` ### cancelAllOrders{docsify-ignore} cancel all open orders in a market **Kind**: instance method of [lbank](#lbank) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://www.lbank.com/en-US/docs/index.html#cancel-all-pending-orders-for-a-single-trading-pair | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market to cancel orders in | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.cancelAllOrders (symbol[, params]) ``` ### fetchDepositAddress{docsify-ignore} fetch the deposit address for a currency associated with this account **Kind**: instance method of [lbank](#lbank) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See** - https://www.lbank.com/en-US/docs/index.html#get-deposit-address - https://www.lbank.com/en-US/docs/index.html#the-user-obtains-the-deposit-address | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchDepositAddress (code[, params]) ``` ### withdraw{docsify-ignore} make a withdrawal **Kind**: instance method of [lbank](#lbank) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://www.lbank.com/en-US/docs/index.html#withdrawal | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | amount | float | Yes | the amount to withdraw | | address | string | Yes | the address to withdraw to | | tag | string | Yes | | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.withdraw (code, amount, address, tag[, params]) ``` ### fetchDeposits{docsify-ignore} fetch all deposits made to an account **Kind**: instance method of [lbank](#lbank) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://www.lbank.com/en-US/docs/index.html#get-recharge-history | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | since | int | No | the earliest time in ms to fetch deposits for | | limit | int | No | the maximum number of deposits structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchDeposits (code[, since, limit, params]) ``` ### fetchWithdrawals{docsify-ignore} fetch all withdrawals made from an account **Kind**: instance method of [lbank](#lbank) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://www.lbank.com/en-US/docs/index.html#get-withdrawal-history | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | since | int | No | the earliest time in ms to fetch withdrawals for | | limit | int | No | the maximum number of withdrawals structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchWithdrawals (code[, since, limit, params]) ``` ### fetchTransactionFees{docsify-ignore} `DEPRECATED` please use fetchDepositWithdrawFees instead **Kind**: instance method of [lbank](#lbank) **Returns**: object - a list of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | codes | Array<string>, undefined | Yes | not used by lbank fetchTransactionFees () | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchTransactionFees (codes[, params]) ``` ### fetchDepositWithdrawFees{docsify-ignore} when using private endpoint, only returns information for currencies with non-zero balance, use public method by specifying this.options['fetchDepositWithdrawFees']['method'] = 'fetchPublicDepositWithdrawFees' **Kind**: instance method of [lbank](#lbank) **Returns**: object - a list of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) **See** - https://www.lbank.com/en-US/docs/index.html#get-all-coins-information - https://www.lbank.com/en-US/docs/index.html#withdrawal-configurations | Param | Type | Required | Description | | --- | --- | --- | --- | | codes | Array<string>, undefined | Yes | array of unified currency codes | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchDepositWithdrawFees (codes[, params]) ``` ### fetchOHLCVWs{docsify-ignore} watches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [lbank](#lbank) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://www.lbank.com/en-US/docs/index.html#request-amp-subscription-instruction | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | since | int | No | timestamp in ms of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchOHLCVWs (symbol, timeframe[, since, limit, params]) ``` ### watchOHLCV{docsify-ignore} watches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [lbank](#lbank) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://www.lbank.com/en-US/docs/index.html#subscription-of-k-line-data | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | since | int | No | timestamp in ms of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.watchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### fetchTickerWs{docsify-ignore} fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market **Kind**: instance method of [lbank](#lbank) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://www.lbank.com/en-US/docs/index.html#request-amp-subscription-instruction | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the cex api endpoint | ```javascript lbank.fetchTickerWs (symbol[, params]) ``` ### watchTicker{docsify-ignore} watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market **Kind**: instance method of [lbank](#lbank) **Returns**: object - a [ticker structure](https://docs.ccxt.com/en/latest/manual.html#ticker-structure) **See**: https://www.lbank.com/en-US/docs/index.html#market | Param | Type | Description | | --- | --- | --- | | symbol | string | unified symbol of the market to fetch the ticker for | | params | object | extra parameters specific to the lbank api endpoint | ```javascript lbank.watchTicker (symbol, params[]) ``` ### fetchTradesWs{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [lbank](#lbank) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://www.lbank.com/en-US/docs/index.html#request-amp-subscription-instruction | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch trades for | | since | int | No | timestamp in ms of the earliest trade to fetch | | limit | int | No | the maximum amount of trades to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.fetchTradesWs (symbol[, since, limit, params]) ``` ### watchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [lbank](#lbank) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://www.lbank.com/en-US/docs/index.html#trade-record | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch trades for | | since | int | No | timestamp in ms of the earliest trade to fetch | | limit | int | No | the maximum amount of trades to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript lbank.watchTrades (symbol[, since, limit, params]) ``` ### watchOrders{docsify-ignore} get the list of trades associated with the user **Kind**: instance method of [lbank](#lbank) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://www.lbank.com/en-US/docs/index.html#update-subscribed-orders | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | No | unified symbol of the market to fetch trades for | | since | int | No | timestamp in ms of the earliest trade to fetch | | limit | int | No | the maximum amount of trades to fetch | | params | object | Yes | extra parameters specific to the lbank api endpoint | ```javascript lbank.watchOrders ([symbol, since, limit, params]) ``` ### fetchOrderBookWs{docsify-ignore} watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [lbank](#lbank) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/en/latest/manual.html#order-book-structure) indexed by market symbols **See**: https://www.lbank.com/en-US/docs/index.html#request-amp-subscription-instruction | Param | Type | Description | | --- | --- | --- | | symbol | string | unified symbol of the market to fetch the order book for | | limit | int, undefined | the maximum amount of order book entries to return | | params | object | extra parameters specific to the lbank api endpoint | ```javascript lbank.fetchOrderBookWs (symbol, limit, params[]) ``` ### watchOrderBook{docsify-ignore} watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [lbank](#lbank) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/en/latest/manual.html#order-book-structure) indexed by market symbols **See**: https://www.lbank.com/en-US/docs/index.html#market-depth | Param | Type | Description | | --- | --- | --- | | symbol | string | unified symbol of the market to fetch the order book for | | limit | int, undefined | the maximum amount of order book entries to return | | params | object | extra parameters specific to the lbank api endpoint | ```javascript lbank.watchOrderBook (symbol, limit, params[]) ```