1.0.0 • Published 2 years ago

@bleskomat/kraken-api-client v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

KrakenApiClient

Node.js client for the Kraken bitcoin exchange API.

Installation

Add to your application via npm:

npm install @bleskomat/kraken-api-client

Usage

Public API end-points:

const KrakenApiClient = require('@bleskomat/kraken-api-client');

const kraken = new KrakenApiClient();

kraken.api('Ticker').then(result => {
	console.log(JSON.stringify(result, null, 2));
}).catch(error => console.error(error));

Private API end-points require API key and private key:

const KrakenApiClient = require('@bleskomat/kraken-api-client');

const kraken = new KrakenApiClient({
	apiKey: 'API_KEY',
	privateKey: 'PRIVATE_KEY',
});

kraken.api('Balance').then(result => {
	console.log(JSON.stringify(result, null, 2));
}).catch(error => console.error(error));

Tests

Run automated tests as follows:

npm test

Changelog

See CHANGELOG.md

License

This software is MIT licensed:

A short, permissive software license. Basically, you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source. There are many variations of this license in use.