ke

kraken-exchange

A library to access the Kraken Bitcoin Exchange

Showing:

Popularity

Downloads/wk

13

GitHub Stars

10

Maintenance

Last Commit

10mos ago

Contributors

4

Package

Dependencies

2

Size (min+gzip)

4.4KB

License

GPL-3.0

Type Definitions

Tree-Shakeable

No?

Categories

Readme

kraken-exchange

Access all elements of the Kraken API

This module fully implements the Kraken API. The full documentation for the API is available on the API help page.

It is written in Coffescript V2 using native Promises and its only dependency is bent. You do not need Coffeescript to use the library; it is pre-compiled to Javascript ES6.

Kraken uses currency symbols preceded by an X or a Z to bring all symbols to four characters. For example XXBT, ZUSD, XETH but DASH with no preceding X. This library uses the three-letter forms thoughout, other than where the base symbol is four letters, e.g. DASH. Thus Euros are always referred to as EUR and Bitcoin as XBT.

There are a few extra methods that are not provided by the Kraken API. These are utility methods which generally give a simplified view of another method. Examples are kraken.profitLoss() and kraken.bidAsk().

Install

npm install kraken-exchange

Get your API key and private key from here.

Example

Kraken = require('kraken-exchange');

const API_KEY = 'MlWItZtB4hqE2c2I9lg3DfnlYFvLQ9CR19Nmd373UEsJtpdAHQlk4NC3';
const PRIV_KEY = 'NZxR7Qyy7vf59fiomB0j1VFVL4J4BAVpKrHmf4hUUQefVFzhlw6as9CScA24cNNsmjb14nl65ZRyy13zlkWxzA';

const kraken = new Kraken(API_KEY, PRIV_KEY);

kraken.time()
.then(response => console.log(response));
.catch(err => console.error(err));

Constructor

const kraken = new Kraken(API_KEY, PRIV_KEY);

Methods

For each method (other than the derived methods), please see the API documentation. Below I have simply documented the call; the response will generally be as documented by Kraken. Currency codes will have been converted and floating responses may be returned as floats rather than strings.

All methods return Promises and pass a single result object to the .then(). Optional parameters are shown within square brackets: [ and ]. It may be necessary to pass a null for some parameters in order to pass later ones.

No errors are caught or reported within the library. All calls should have a .catch(err) to pick up the error.

N.B. The order of parameters in methods is as below which may differ from the Kraken documentation in order to put less-used parameters twards the end of the list.

Derived methods

Average price between bid and ask

kraken.bidAsk(...pairs)

The parameters can be a list of pairs or a single array can be passed.

So kraken.bidAsk('XBTEUR', 'ETHEUR'); or kraken.bidAsk(['XBTEUR', 'ETHEUR']);, whichever is easier for the application.

Profit and loss on open positions

kraken.profitLoss(byPair = false)

This will return an object with the current net profit or loss for each currency in open positions.

If byPair is passed as true, it will return the current net profit or loss for each currency pair rather than each currency.

Public market data

Get server time

kraken.time()

Get asset info

kraken.assets(...assets)

The parameters can be a list of assets or a single array can be passed.

So kraken.assets('XBT', 'ETH'); or kraken.assets(['XBT', 'ETH']);, whichever is easier for the application.

Get tradable asset pairs

kraken.assetPairs(...pairs)

The parameters can be a list of pairs or a single array can be passed.

So kraken.assetPairs('XBTEUR', 'ETHEUR'); or kraken.assetPairs(['XBTEUR', 'ETHEUR']);, whichever is easier for the application.

Get ticker information

kraken.ticker(...pairs)

The parameters can be a list of pairs or a single array can be passed.

Get OHLC data

kraken.ohlc(pair[, interval[, last]])

Get order book

kraken.depth(pair[, count])

Get recent trades

kraken.trades(pair[, since])

Get recent spread data

kraken.spread(pair[, since])

Private user data

Get account balance

kraken.balance()

Get trade balance

kraken.tradeBalance([currency])

Get open orders

kraken.openOrders([trades[, userref]])

Get closed orders

kraken.closedOrders([trades[, userref[, start[, end[, ofs[, closetime]]]]]])

Query orders info

kraken.queryOrders(txids[, trades[, userref]])

Note that txids can be a single transaction id, an array of transaction ids or a comma-separated list of transaction ids.

Get trades history

kraken.tradesHistory([type[, trades[, start[, end[, ofs]]]]])

Query trades info

kraken.queryTrades(txids[, trades])

Note that txids can be a single transaction id, an array of transaction ids or a comma-separated list of transaction ids.

Get open positions

kraken.openPositions([docalcs[, txids]]);

Note that txids can be a single transaction id, an array of transaction ids or a comma-separated list of transaction ids.

Get ledgers info

kraken.ledgers([assets[, type[, start[, end[, ofs]]]]])

Note that assets can be a single asset, an array of assets, a comma-separated list of assets or undefined.

Query ledgers

kraken.queryLedgers(...ids)

The parameters can be a list of ledger ids or a single array can be passed.

Get trade volume

kraken.tradeVolume(..pairs)

The parameters can be a list of currency pairs or a single array can be passed.

Private user trading

Add standard order

kraken.addOrder(pair, type, ordertype, volume[, price[, price2[, leverage[, closetype[, closeprice[, closeprice2]]]]]])

or

kraken.addOrder(params)

where params is an object with the required keys and values from the list above.

Cancel open order

kraken.cancelOrder(txid)

Private user funding

Get deposit methods

kraken.depositMethods(asset)

Get deposit addresses

kraken.depositAddresses(asset, method[, newAddress])

Get status of recent deposits

kraken.depositStatus(asset, method)

Get withdrawal information

kraken.withdrawInfo(asset, key, amount)

Withdraw funds

kraken.withdraw(asset, key, amount)

Wallet Transfer

kraken.walletTransfer(asset, amount)

Get status of recent withdrawals

kraken.withdrawStatus(asset[, method])

Request withdrawal cancelation

kraken.withdrawCancel(asset, refid)

Versions

Version 1.8.0 onwards replaces request (which has been deprecated) with bent by the same author. This has considerably reduced the size of this package and of its dependencies.

Issues

Please report any bugs or make any suggestions at the Github Issue page.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial