kraken

kraken{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchMarkets
• fetchStatus
• fetchCurrencies
• fetchTradingFee
• fetchOrderBook
• fetchTickers
• fetchTicker
• fetchOHLCV
• fetchLedger
• fetchTrades
• fetchBalance
• createMarketOrderWithCost
• createMarketBuyOrderWithCost
• createOrder
• createOrders
• editOrder
• fetchOrder
• fetchOrderTrades
• fetchOrdersByIds
• fetchMyTrades
• cancelOrder
• cancelOrders
• cancelAllOrders
• cancelAllOrdersAfter
• fetchOpenOrders
• fetchClosedOrders
• fetchDeposits
• fetchTime
• fetchWithdrawals
• createDepositAddress
• fetchDepositMethods
• fetchDepositAddress
• withdraw
• fetchPositions
• transferOut
• transfer

kraken{docsify-ignore}

Set rateLimit to 1000 if fully verified

kraken.kraken ()

fetchMarkets{docsify-ignore}

retrieves data on all markets for kraken

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

See: https://docs.kraken.com/rest/#tag/Spot-Market-Data/operation/getTradableAssetPairs

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

kraken.fetchMarkets (params?)

fetchStatus{docsify-ignore}

the latest known information on the availability of the exchange API

Kind: instance method of kraken
Returns: object - a status structure

See: https://docs.kraken.com/api/docs/rest-api/get-system-status/

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

kraken.fetchStatus (params?)

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

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

See: https://docs.kraken.com/rest/#tag/Spot-Market-Data/operation/getAssetInfo

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

kraken.fetchCurrencies (params?)

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

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

See: https://docs.kraken.com/rest/#tag/Account-Data/operation/getTradeVolume

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

kraken.fetchTradingFee (symbol, params?)

fetchOrderBook{docsify-ignore}

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

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

See: https://docs.kraken.com/rest/#tag/Spot-Market-Data/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

kraken.fetchOrderBook (symbol, 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 kraken
Returns: object - a dictionary of ticker structures

See: https://docs.kraken.com/rest/#tag/Spot-Market-Data/operation/getTickerInformation

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

kraken.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 kraken
Returns: object - a ticker structure

See: https://docs.kraken.com/rest/#tag/Spot-Market-Data/operation/getTickerInformation

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

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

See: https://docs.kraken.com/api/docs/rest-api/get-ohlc-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
params.paginate	boolean	No	default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters

kraken.fetchOHLCV (symbol, timeframe, since?, limit?, 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 kraken
Returns: object - a ledger structure

See: https://docs.kraken.com/rest/#tag/Account-Data/operation/getLedgers

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
params.until	int	No	timestamp in ms of the latest ledger entry
params.end	int	No	timestamp in seconds of the latest ledger entry

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

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://docs.kraken.com/rest/#tag/Spot-Market-Data/operation/getRecentTrades

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

kraken.fetchTrades (symbol, 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 kraken
Returns: object - a balance structure

See: https://docs.kraken.com/rest/#tag/Account-Data/operation/getExtendedBalance

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

kraken.fetchBalance (params?)

createMarketOrderWithCost{docsify-ignore}

create a market order by providing the symbol, side and cost

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

See: https://docs.kraken.com/rest/#tag/Spot-Trading/operation/addOrder

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to create an order in (only USD markets are supported)
side	string	Yes	'buy' or 'sell'
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

kraken.createMarketOrderWithCost (symbol, side, cost, params?)

createMarketBuyOrderWithCost{docsify-ignore}

create a market buy order by providing the symbol, side and cost

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

See: https://docs.kraken.com/rest/#tag/Spot-Trading/operation/addOrder

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

kraken.createMarketBuyOrderWithCost (symbol, cost, params?)

createOrder{docsify-ignore}

create a trade order

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

See: https://docs.kraken.com/api/docs/rest-api/add-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
params.postOnly	bool	No	if true, the order will only be posted to the order book and not executed immediately
params.reduceOnly	bool	No	margin only indicates if this order is to reduce the size of a position
params.stopLossPrice	float	No	margin only the price that a stop loss order is triggered at
params.takeProfitPrice	float	No	margin only the price that a take profit order is triggered at
params.trailingAmount	string	No	margin only the quote amount to trail away from the current market price
params.trailingPercent	string	No	margin only the percent to trail away from the current market price
params.trailingLimitAmount	string	No	margin only the quote amount away from the trailingAmount
params.trailingLimitPercent	string	No	margin only the percent away from the trailingAmount
params.offset	string	No	margin only '+' or '-' whether you want the trailingLimitAmount value to be positive or negative, default is negative '-'
params.trigger	string	No	margin only the activation price type, 'last' or 'index', default is 'last'

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

createOrders{docsify-ignore}

create a list of trade orders

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

See: https://docs.kraken.com/api/docs/rest-api/add-order-batch/

Param	Type	Required	Description
orders	Array	Yes	list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params	object	No	extra parameters specific to the exchange API endpoint

kraken.createOrders (orders, params?)

editOrder{docsify-ignore}

edit a trade order

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

See: https://docs.kraken.com/api/docs/rest-api/amend-order

Param	Type	Required	Description
id	string	Yes	order id
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	No	how much of the currency you want to trade in units of the 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.stopLossPrice	float	No	the price that a stop loss order is triggered at
params.takeProfitPrice	float	No	the price that a take profit order is triggered at
params.trailingAmount	string	No	the quote amount to trail away from the current market price
params.trailingPercent	string	No	the percent to trail away from the current market price
params.trailingLimitAmount	string	No	the quote amount away from the trailingAmount
params.trailingLimitPercent	string	No	the percent away from the trailingAmount
params.offset	string	No	'+' or '-' whether you want the trailingLimitAmount value to be positive or negative
params.postOnly	boolean	No	if true, the order will only be posted to the order book and not executed immediately
params.clientOrderId	string	No	the orders client order id

kraken.editOrder (id, symbol, type, side, amount?, price?, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://docs.kraken.com/rest/#tag/Account-Data/operation/getOrdersInfo

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

kraken.fetchOrder (id, symbol, params?)

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

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

See: https://docs.kraken.com/rest/#tag/Account-Data/operation/getTradesInfo

Param	Type	Required	Description
id	string	Yes	order id
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 to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

kraken.fetchOrderTrades (id, symbol, since?, limit?, params?)

fetchOrdersByIds{docsify-ignore}

fetch orders by the list of order id

Kind: instance method of kraken
Returns: Array<object> - a list of order structure

See: https://docs.kraken.com/rest/#tag/Account-Data/operation/getClosedOrders

Param	Type	Required	Description
ids	Array<string>	No	list of order id
symbol	string	No	unified ccxt market symbol
params	object	No	extra parameters specific to the kraken api endpoint

kraken.fetchOrdersByIds (ids?, symbol?, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://docs.kraken.com/api/docs/rest-api/get-trade-history

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
params.until	int	No	timestamp in ms of the latest trade entry
params.end	int	No	timestamp in seconds of the latest trade entry

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

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://docs.kraken.com/api/docs/rest-api/cancel-order

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	No	unified symbol of the market the order was made in
params	object	No	extra parameters specific to the exchange API endpoint
params.clientOrderId	string	No	the orders client order id
params.userref	int	No	the orders user reference id

kraken.cancelOrder (id, symbol?, params?)

cancelOrders{docsify-ignore}

cancel multiple orders

Kind: instance method of kraken
Returns: object - an list of order structures

See: https://docs.kraken.com/rest/#tag/Spot-Trading/operation/cancelOrderBatch

Param	Type	Required	Description
ids	Array<string>	Yes	open orders transaction ID (txid) or user reference (userref)
symbol	string	Yes	unified market symbol
params	object	No	extra parameters specific to the exchange API endpoint

kraken.cancelOrders (ids, symbol, params?)

cancelAllOrders{docsify-ignore}

cancel all open orders

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

See: https://docs.kraken.com/rest/#tag/Spot-Trading/operation/cancelAllOrders

Param	Type	Required	Description
symbol	string	Yes	unified market symbol, not used by kraken cancelAllOrders (all open orders are cancelled)
params	object	No	extra parameters specific to the exchange API endpoint

kraken.cancelAllOrders (symbol, params?)

cancelAllOrdersAfter{docsify-ignore}

dead man's switch, cancel all orders after the given timeout

Kind: instance method of kraken
Returns: object - the api result

See: https://docs.kraken.com/rest/#tag/Spot-Trading/operation/cancelAllOrdersAfter

Param	Type	Required	Description
timeout	number	Yes	time in milliseconds, 0 represents cancel the timer
params	object	No	extra parameters specific to the exchange API endpoint

kraken.cancelAllOrdersAfter (timeout, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://docs.kraken.com/api/docs/rest-api/get-open-orders

Param	Type	Required	Description
symbol	string	No	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.clientOrderId	string	No	the orders client order id
params.userref	int	No	the orders user reference id

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

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See: https://docs.kraken.com/api/docs/rest-api/get-closed-orders

Param	Type	Required	Description
symbol	string	No	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.until	int	No	timestamp in ms of the latest entry
params.clientOrderId	string	No	the orders client order id
params.userref	int	No	the orders user reference id

kraken.fetchClosedOrders (symbol?, since?, limit?, params?)

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

See: https://docs.kraken.com/rest/#tag/Funding/operation/getStatusRecentDeposits

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
params.until	int	No	timestamp in ms of the latest transaction entry
params.end	int	No	timestamp in seconds of the latest transaction entry

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

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

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

See: https://docs.kraken.com/rest/#tag/Spot-Market-Data/operation/getServerTime

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

kraken.fetchTime (params?)

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

See: https://docs.kraken.com/rest/#tag/Funding/operation/getStatusRecentWithdrawals

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
params.until	int	No	timestamp in ms of the latest transaction entry
params.end	int	No	timestamp in seconds of the latest transaction entry
params.paginate	boolean	No	default false, when true will automatically paginate by calling this endpoint multiple times

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

createDepositAddress{docsify-ignore}

create a currency deposit address

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

See: https://docs.kraken.com/rest/#tag/Funding/operation/getDepositAddresses

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

kraken.createDepositAddress (code, params?)

fetchDepositMethods{docsify-ignore}

fetch deposit methods for a currency associated with this account

Kind: instance method of kraken
Returns: object - of deposit methods

See: https://docs.kraken.com/rest/#tag/Funding/operation/getDepositMethods

Param	Type	Required	Description
code	string	Yes	unified currency code
params	object	No	extra parameters specific to the kraken api endpoint

kraken.fetchDepositMethods (code, params?)

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

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

See: https://docs.kraken.com/rest/#tag/Funding/operation/getDepositAddresses

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

kraken.fetchDepositAddress (code, params?)

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of kraken
Returns: object - a transaction structure

See: https://docs.kraken.com/rest/#tag/Funding/operation/withdrawFunds

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, not required can be '' or undefined/none/null
tag	string	Yes
params	object	No	extra parameters specific to the exchange API endpoint

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

fetchPositions{docsify-ignore}

fetch all open positions

Kind: instance method of kraken
Returns: Array<object> - a list of position structure

See: https://docs.kraken.com/rest/#tag/Account-Data/operation/getOpenPositions

Param	Type	Required	Description
symbols	Array<string>	No	not used by kraken fetchPositions ()
params	object	No	extra parameters specific to the exchange API endpoint

kraken.fetchPositions (symbols?, params?)

transferOut{docsify-ignore}

transfer from spot wallet to futures wallet

Kind: instance method of kraken
Returns: a transfer structure

See: https://docs.kraken.com/rest/#tag/User-Funding/operation/walletTransfer

Param	Type	Required	Description
code	str	Yes	Unified currency code
amount	float	Yes	Size of the transfer
params	dict	No	Exchange specific parameters

kraken.transferOut (code, amount, params?)

transfer{docsify-ignore}

transfers currencies between sub-accounts (only spot->swap direction is supported)

Kind: instance method of kraken
Returns: a transfer structure

See: https://docs.kraken.com/rest/#tag/User-Funding/operation/walletTransfer

Param	Type	Required	Description
code	string	Yes	Unified currency code
amount	float	Yes	Size of the transfer
fromAccount	string	Yes	'spot' or 'Spot Wallet'
toAccount	string	Yes	'swap' or 'Futures Wallet'
params	object	No	Exchange specific parameters

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