kraken-cryptoexchange-api

About

This package provides a modern javascript solution for interfacing with the Kraken cryptoexchange API. Currently, only the REST API has been implemented. Support for for the Push API is in the works.

This library is intended to be used with ES6, TypeScript, etc. In the interest of moving towards the more-readable async/await pattern, callbacks are not supported. Only native Promise-based interaction is supported.

This library does not track your request rate. Kraken throttles/disables api access if the request rate exceeds certain limits. It is the responsibility of the user to track rate limits.

Getting Started

Install

npm

npm i kraken-cryptoexchange-api

yarn

yarn add kraken-cryptoexchange-api

Quick Start

TypeScript

import { getClient, IKrakenClient } from 'kraken-cryptoexchange-api';

const main = async (): Promise<{}> => {
    try {
        const client: IKrakenClient = getClient({
            publicKey : '', // Your public key
            privateKey: '', // Your private key
        });

        const { status, data } = await client.getAccountBalance();
        return Promise.resolve(data);
    } catch (err) {
        return Promise.reject(err);
    }
};

main().then(data => console.log(data))
      .catch(err => console.error(err));

JavaScript

This example shows usage without async/await.

const kraken = require('kraken-cryptoexchange-api');

const client = kraken.getClient({
    publicKey : '', // Your public key
    privateKey: '', // Your private key
});

client.getAccountBalance()
      .then(response => {
          const { status, data } = response;
          console.log(data);
      })
      .catch(err => console.error(err));

Note: the remainder of this README.md will use TypeScript examples.

Configuration

This project leverages the axios package under the hood. All request configuration is forwarded to the underlying request architecture. See the documentation for more information.

API Detail

All endpoints are available via the client. If authentication keys are provided during client construction, public and private endpoints will succeed. If no keys are given, only public endpoints will succeed. Private endpoints will return a promise rejection when not authenticated, so be sure to properly trap your errors.

No attempt is made to mitigate private calls when not authenticated. It is the responsibility of the user to trap any errors resulting from incorrect/invalid authentication

A few convenience properties and methods are provided:

rawAgent

This gives the user access to the underlying request forwarder. While not very useful to a user, it does expose the request signing algorithm via rawAgent#signMessage.

isUpgraded()

This method returns a boolean corresponding to whether or not the user has provided API keys to the client.

upgrade()

This method allows a user to upgrade a public client with credentials. If the client already has credentials, this method will replace the existing keys.

Public Requests

In order to place requests with public endpoints, simply instantiate the client with no parameters:

const client: IKrakenClient = getClient(); 

Private Requests

Authentication

In order to authenticate a client with the Kraken API, a private request must provide a public key and a correctly signed request. This library handles request signatures - the user simply provides a public/private key pair. You can generate your own API keys through the Kraken interface.