lbank

lbank{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchTime
• fetchCurrencies
• fetchMarkets
• fetchTicker
• fetchTickers
• fetchOrderBook
• fetchTrades
• fetchOHLCV
• fetchFundingRate
• fetchFundingRates
• fetchBalance
• fetchTradingFee
• fetchTradingFees
• createMarketBuyOrderWithCost
• createOrder
• fetchOrder
• fetchMyTrades
• fetchOrders
• fetchOpenOrders
• cancelOrder
• cancelAllOrders
• fetchDepositAddress
• withdraw
• fetchDeposits
• fetchWithdrawals
• fetchTransactionFees
• fetchDepositWithdrawFees
• fetchOHLCVWs
• watchOHLCV
• fetchTickerWs
• watchTicker
• fetchTradesWs
• watchTrades
• watchOrders
• watchBalance
• fetchOrderBookWs
• watchOrderBook

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of 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

lbank.fetchTime (params?)

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of lbank
Returns: dict - an associative dictionary of currencies

Param	Type	Required	Description
params	dict	No	extra parameters specific to the exchange API endpoint

lbank.fetchCurrencies (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for lbank

Kind: instance method of 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

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
Returns: object - a 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

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
Returns: object - a dictionary of ticker structures

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

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
Returns: object - A dictionary of order book structures 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

lbank.fetchOrderBook (symbol, limit?, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of lbank
Returns: Array<Trade> - a list of trade structures

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

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
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

lbank.fetchOHLCV (symbol, timeframe, since?, limit?, params?)

fetchFundingRate{docsify-ignore}

fetch the current funding rate

Kind: instance method of lbank
Returns: object - a funding rate structure

See: https://www.lbank.com/en-US/docs/contract.html#query-contract-market-list

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
params	object	No	extra parameters specific to the exchange API endpoint

lbank.fetchFundingRate (symbol, params?)

fetchFundingRates{docsify-ignore}

fetch the funding rate for multiple markets

Kind: instance method of lbank
Returns: object - 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	Array<string>, undefined	Yes	list of unified market symbols
params	object	No	extra parameters specific to the exchange API endpoint

lbank.fetchFundingRates (symbols, 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
Returns: object - a 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

lbank.fetchBalance (params?)

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of lbank
Returns: object - a 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

lbank.fetchTradingFee (symbol, params?)

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

Kind: instance method of lbank
Returns: object - 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	object	No	extra parameters specific to the exchange API endpoint

lbank.fetchTradingFees (params?)

createMarketBuyOrderWithCost{docsify-ignore}

create a market buy order by providing the symbol and cost

Kind: instance method of lbank
Returns: object - an 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

lbank.createMarketBuyOrderWithCost (symbol, cost, params?)

createOrder{docsify-ignore}

create a trade order

Kind: instance method of lbank
Returns: object - an 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

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
Returns: object - An 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
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

lbank.fetchOrder (id, symbol, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of lbank
Returns: Array<Trade> - a list of trade structures

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

lbank.fetchMyTrades (symbol, since?, limit?, params?)

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

Kind: instance method of lbank
Returns: Array<Order> - a list of order structures

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

lbank.fetchOrders (symbol, since?, limit?, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of lbank
Returns: Array<Order> - a list of order structures

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

lbank.fetchOpenOrders (symbol, since?, limit?, params?)

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of lbank
Returns: object - An 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

lbank.cancelOrder (id, symbol, params?)

cancelAllOrders{docsify-ignore}

cancel all open orders in a market

Kind: instance method of lbank
Returns: Array<object> - 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	string	Yes	unified market symbol of the market to cancel orders in
params	object	No	extra parameters specific to the exchange API endpoint

lbank.cancelAllOrders (symbol, params?)

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of lbank
Returns: object - an 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

lbank.fetchDepositAddress (code, params?)

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of lbank
Returns: object - a 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

lbank.withdraw (code, amount, address, tag, params?)

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of lbank
Returns: Array<object> - a list of transaction structures

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

lbank.fetchDeposits (code, since?, limit?, params?)

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of lbank
Returns: Array<object> - a list of transaction structures

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

lbank.fetchWithdrawals (code, since?, limit?, params?)

fetchTransactionFees{docsify-ignore}

DEPRECATED

please use fetchDepositWithdrawFees instead

Kind: instance method of lbank
Returns: object - a list of fee structures

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

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
Returns: object - a list of fee structures

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>	No	array of unified currency codes
params	object	No	extra parameters specific to the exchange API endpoint

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
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

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
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

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
Returns: object - a 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

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
Returns: object - a 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

lbank.watchTicker (symbol, params)

fetchTradesWs{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of lbank
Returns: Array<Trade> - a list of trade structures

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

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
Returns: Array<object> - a list of trade structures

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

lbank.watchTrades (symbol, since?, limit?, params?)

watchOrders{docsify-ignore}

get the list of trades associated with the user

Kind: instance method of lbank
Returns: Array<object> - a list of trade structures

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

lbank.watchOrders (symbol?, since?, limit?, params)

watchBalance{docsify-ignore}

watch balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of lbank
Returns: object - a balance structure

See: https://www.lbank.com/docs/index.html#update-subscribed-asset

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

lbank.watchBalance (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
Returns: object - 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	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

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
Returns: object - 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	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

lbank.watchOrderBook (symbol, limit, params)