latoken

latoken{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchTime
• fetchMarkets
• fetchCurrencies
• fetchBalance
• fetchOrderBook
• fetchTicker
• fetchTickers
• fetchTrades
• fetchTradingFee
• fetchMyTrades
• fetchOpenOrders
• fetchOrders
• fetchOrder
• createOrder
• cancelOrder
• cancelAllOrders
• fetchTransactions
• fetchTransfers
• transfer

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of latoken
Returns: int - the current integer timestamp in milliseconds from the exchange server

See: https://api.latoken.com/doc/v2/#tag/Time/operation/currentTime

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

latoken.fetchTime (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for latoken

Kind: instance method of latoken
Returns: Array<object> - an array of objects representing market data

See: https://api.latoken.com/doc/v2/#tag/Pair/operation/getActivePairs

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

latoken.fetchMarkets (params?)

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of latoken
Returns: object - an associative dictionary of currencies

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

latoken.fetchCurrencies (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 latoken
Returns: object - a balance structure

See: https://api.latoken.com/doc/v2/#tag/Account/operation/getBalancesByUser

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

latoken.fetchBalance (params?)

fetchOrderBook{docsify-ignore}

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of latoken
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://api.latoken.com/doc/v2/#tag/Order-Book/operation/getOrderBook

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

latoken.fetchOrderBook (symbol, limit?, 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 latoken
Returns: object - a ticker structure

See: https://api.latoken.com/doc/v2/#tag/Ticker/operation/getTicker

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

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

See: https://api.latoken.com/doc/v2/#tag/Ticker/operation/getAllTickers

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

latoken.fetchTickers (symbols, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://api.latoken.com/doc/v2/#tag/Trade/operation/getTradesByPair

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

latoken.fetchTrades (symbol, since?, limit?, params?)

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of latoken
Returns: object - a fee structure

See

• https://api.latoken.com/doc/v2/#tag/Trade/operation/getFeeByPair
• https://api.latoken.com/doc/v2/#tag/Trade/operation/getAuthFeeByPair

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

latoken.fetchTradingFee (symbol, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See

• https://api.latoken.com/doc/v2/#tag/Trade/operation/getTradesByTrader
• https://api.latoken.com/doc/v2/#tag/Trade/operation/getTradesByAssetAndTrader

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 trades structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

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

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See

• https://api.latoken.com/doc/v2/#tag/Order/operation/getMyActiveOrdersByPair
• https://api.latoken.com/doc/v2/#tag/StopOrder/operation/getMyActiveStopOrdersByPair // stop

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 orders structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint
params.trigger	boolean	No	true if fetching trigger orders

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

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See

• https://api.latoken.com/doc/v2/#tag/Order/operation/getMyOrders
• https://api.latoken.com/doc/v2/#tag/Order/operation/getMyOrdersByPair
• https://api.latoken.com/doc/v2/#tag/StopOrder/operation/getMyStopOrders // stop
• https://api.latoken.com/doc/v2/#tag/StopOrder/operation/getMyStopOrdersByPair // stop

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
params.trigger	boolean	No	true if fetching trigger orders

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

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of latoken
Returns: object - An order structure

See

• https://api.latoken.com/doc/v2/#tag/Order/operation/getOrderById
• https://api.latoken.com/doc/v2/#tag/StopOrder/operation/getStopOrderById

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	No	not used by latoken fetchOrder
params	object	No	extra parameters specific to the exchange API endpoint
params.trigger	boolean	No	true if fetching a trigger order

latoken.fetchOrder (id, symbol?, params?)

createOrder{docsify-ignore}

create a trade order

Kind: instance method of latoken
Returns: object - an order structure

See

• https://api.latoken.com/doc/v2/#tag/Order/operation/placeOrder
• https://api.latoken.com/doc/v2/#tag/StopOrder/operation/placeStopOrder // stop

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
params.triggerPrice	float	No	the price at which a trigger order is triggered at EXCHANGE SPECIFIC PARAMETERS
params.condition	string	No	"GTC", "IOC", or "FOK"
params.clientOrderId	string	No	[ 0 .. 50 ] characters, client's custom order id (free field for your convenience)

latoken.createOrder (symbol, type, side, amount, price?, params?)

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of latoken
Returns: object - An order structure

See

• https://api.latoken.com/doc/v2/#tag/Order/operation/cancelOrder
• https://api.latoken.com/doc/v2/#tag/StopOrder/operation/cancelStopOrder // stop

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	not used by latoken cancelOrder ()
params	object	No	extra parameters specific to the exchange API endpoint
params.trigger	boolean	No	true if cancelling a trigger order

latoken.cancelOrder (id, symbol, params?)

cancelAllOrders{docsify-ignore}

cancel all open orders in a market

Kind: instance method of latoken
Returns: Array<object> - a list of order structures

See

• https://api.latoken.com/doc/v2/#tag/Order/operation/cancelAllOrders
• https://api.latoken.com/doc/v2/#tag/Order/operation/cancelAllOrdersByPair

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
params.trigger	boolean	No	true if cancelling trigger orders

latoken.cancelAllOrders (symbol, params?)

fetchTransactions{docsify-ignore}

DEPRECATED

use fetchDepositsWithdrawals instead

Kind: instance method of latoken
Returns: object - a list of transaction structure

See: https://api.latoken.com/doc/v2/#tag/Transaction/operation/getUserTransactions

Param	Type	Required	Description
code	string	Yes	unified currency code for the currency of the transactions, default is undefined
since	int	No	timestamp in ms of the earliest transaction, default is undefined
limit	int	No	max number of transactions to return, default is undefined
params	object	No	extra parameters specific to the exchange API endpoint

latoken.fetchTransactions (code, since?, limit?, params?)

fetchTransfers{docsify-ignore}

fetch a history of internal transfers made on an account

Kind: instance method of latoken
Returns: Array<object> - a list of transfer structures

See: https://api.latoken.com/doc/v2/#tag/Transfer/operation/getUsersTransfers

Param	Type	Required	Description
code	string	Yes	unified currency code of the currency transferred
since	int	No	the earliest time in ms to fetch transfers for
limit	int	No	the maximum number of transfers structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

latoken.fetchTransfers (code, since?, limit?, params?)

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

Kind: instance method of latoken
Returns: object - a transfer structure

See

• https://api.latoken.com/doc/v2/#tag/Transfer/operation/transferByEmail
• https://api.latoken.com/doc/v2/#tag/Transfer/operation/transferById
• https://api.latoken.com/doc/v2/#tag/Transfer/operation/transferByPhone

Param	Type	Required	Description
code	string	Yes	unified currency code
amount	float	Yes	amount to transfer
fromAccount	string	Yes	account to transfer from
toAccount	string	Yes	account to transfer to
params	object	No	extra parameters specific to the exchange API endpoint

latoken.transfer (code, amount, fromAccount, toAccount, params?)