luno

luno{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchCurrencies
• fetchMarkets
• fetchAccounts
• fetchBalance
• fetchOrderBook
• fetchOrder
• fetchOrders
• fetchOpenOrders
• fetchClosedOrders
• fetchTickers
• fetchTicker
• fetchTrades
• fetchOHLCV
• fetchMyTrades
• fetchTradingFee
• createOrder
• cancelOrder
• fetchLedger
• createDepositAddress
• fetchDepositAddress
• watchTrades
• watchOrderBook

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

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

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

luno.fetchCurrencies (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for luno

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

See: https://www.luno.com/en/developers/api#tag/Market/operation/Markets

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

luno.fetchMarkets (params?)

fetchAccounts{docsify-ignore}

fetch all the accounts associated with a profile

Kind: instance method of luno
Returns: object - a dictionary of account structures indexed by the account type

See: https://www.luno.com/en/developers/api#tag/Accounts/operation/getBalances

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

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

See: https://www.luno.com/en/developers/api#tag/Accounts/operation/getBalances

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

luno.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 luno
Returns: object - A dictionary of order book structures indexed by market symbols

See

• https://www.luno.com/en/developers/api#tag/Market/operation/GetOrderBookFull
• https://www.luno.com/en/developers/api#tag/Market/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

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

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://www.luno.com/en/developers/api#tag/Orders/operation/GetOrder

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	not used by luno fetchOrder
params	object	No	extra parameters specific to the exchange API endpoint

luno.fetchOrder (id, symbol, params?)

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See: https://www.luno.com/en/developers/api#tag/Orders/operation/ListOrders

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

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

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://www.luno.com/en/developers/api#tag/Orders/operation/ListOrders

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

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

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See: https://www.luno.com/en/developers/api#tag/Orders/operation/ListOrders

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

luno.fetchClosedOrders (symbol, since?, limit?, 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 luno
Returns: object - a dictionary of ticker structures

See: https://www.luno.com/en/developers/api#tag/Market/operation/GetTickers

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

luno.fetchTickers (symbols, 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 luno
Returns: object - a ticker structure

See: https://www.luno.com/en/developers/api#tag/Market/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

luno.fetchTicker (symbol, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://www.luno.com/en/developers/api#tag/Market/operation/ListTrades

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

luno.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 luno
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://www.luno.com/en/developers/api#tag/Market/operation/GetCandles

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	Yes	extra parameters specific to the luno api endpoint

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

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://www.luno.com/en/developers/api#tag/Orders/operation/ListUserTrades

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

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

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

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

See: https://www.luno.com/en/developers/api#tag/Orders/operation/getFeeInfo

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

luno.fetchTradingFee (symbol, params?)

createOrder{docsify-ignore}

create a trade order

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

See

• https://www.luno.com/en/developers/api#tag/Orders/operation/PostMarketOrder
• https://www.luno.com/en/developers/api#tag/Orders/operation/PostLimitOrder

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

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

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://www.luno.com/en/developers/api#tag/Orders/operation/StopOrder

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

luno.cancelOrder (id, symbol, params?)

fetchLedger{docsify-ignore}

fetch the history of changes, actions done by the user or operations that altered the balance of the user

Kind: instance method of luno
Returns: object - a ledger structure

See: https://www.luno.com/en/developers/api#tag/Accounts/operation/ListTransactions

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

luno.fetchLedger (code?, since?, limit?, params?)

createDepositAddress{docsify-ignore}

create a currency deposit address

Kind: instance method of luno
Returns: object - an address structure

See: https://www.luno.com/en/developers/api#tag/Receive/operation/createFundingAddress

Param	Type	Required	Description
code	string	Yes	unified currency code of the currency for the deposit address
params	object	No	extra parameters specific to the exchange API endpoint
params.name	string	No	an optional name for the new address
params.account_id	int	No	an optional account id for the new address

luno.createDepositAddress (code, params?)

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of luno
Returns: object - an address structure

See: https://www.luno.com/en/developers/api#tag/Receive/operation/getFundingAddress

Param	Type	Required	Description
code	string	Yes	unified currency code
params	object	No	extra parameters specific to the exchange API endpoint
params.address	string	No	a specific cryptocurrency address to retrieve

luno.fetchDepositAddress (code, params?)

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://www.luno.com/en/developers/api#tag/Streaming-API

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

luno.watchTrades (symbol, since?, 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 luno
Returns: object - A dictionary of order book structures indexed by market symbols

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	objectConstructor	No	extra parameters specific to the exchange API endpoint
params.type	string	No	accepts l2 or l3 for level 2 or level 3 order book

luno.watchOrderBook (symbol, limit?, params?)