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