Skip to content
NodeJS Client Library for the Kraken (kraken.com) API
JavaScript
Branch: master
Clone or download
Latest commit 816fa67 Jul 23, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
LICENSE.md initial commit Nov 22, 2013
README.md update README Jul 23, 2017
kraken.js switch "request" to "got", formatting Jul 23, 2017
package-lock.json switch "request" to "got", formatting Jul 23, 2017
package.json update version Jul 23, 2017

README.md

Node Kraken

NodeJS Client Library for the Kraken (kraken.com) API

This is an asynchronous node js client for the kraken.com API. It exposes all the API methods found here: https://www.kraken.com/help/api through the api method:

Example Usage:

const key          = '...'; // API Key
const secret       = '...'; // API Private Key
const KrakenClient = require('kraken-api');
const kraken       = new KrakenClient(key, secret);

(async () => {
	// Display user's balance
	console.log(await kraken.api('Balance'));

	// Get Ticker Info
	console.log(await kraken.api('Ticker', { pair : 'XXBTZUSD' }));
})();

Updates:

As of version 1.0.0:

  • All methods return a promise.
  • The second argument (parameters) can be omitted.
  • The third argument to the constructor can be an object (configuration) or a string (OTP), for backwards compatibility.

As of version 0.1.0, the callback passed to the api function conforms to the Node.js standard of

function(error, data) {
	// ...
}

Thanks to @tehsenaus and @petermrg for pointing this out.

Credit:

I used the example php implementation at https://github.com/payward/kraken-api-client and the python implementation at https://github.com/veox/python3-krakenex as references.

BTC donation address: 12X8GyUpfYxEP7sh1QaU4ngWYpzXJByQn5

You can’t perform that action at this time.