krakenex

Kraken.com exchange API, Python 3 package.

This package is intentionally as lean as possible, and only provides a minimal interface to the Kraken cryptocurrency exchange.

Intended for developers, not traders.

Software that uses krakenex

• clikraken - command-line client for the Kraken exchange
• CurrencyViewer - short program for crypto to fiat conversion and data extraction
• Telegram-Kraken-Bot - Telegram bot to trade on Kraken exchange

Installation

This package requires Python 3.3 or later. The module will be called krakenex.

To install system-wide using standard-library setuptools, run:

python3 ./setup.py install

Add --user to install locally for the user:

python3 ./setup.py install --user

A PyPI package is also available. To install system-wide using pip:

pip install krakenex

Or, to install locally for the user:

pip install --user krakenex

Documentation

View the latest or stable online at ReadTheDocs.

The code is documented in docstrings, and can be viewed with a text editor.

You can also generate your own with, e.g., make html in doc. This requires sphinx and its rtd theme.

For a list of public/private Kraken API methods, see their API documentation.

Examples

A few package use examples are available in the examples directory.

Development

This package will never support Python 2. There will be no changes made to enable compatibility with Python 2. Python 3.0 was released in 2008, before Bitcoin was.

There is no reason to support Python 2 except for compatibility with systems from the pre-blockchain era.

The fact that some GNU/Linux distributions still ship with Python 2 as the default seems unfortunate to me. However, I will not support this madness with my precious time.

If you have a valid reason to use Python 2, see python2-krakenex. Be warned, though, that it is unmaintained.

Attribution

Core code is licensed under LGPLv3. See LICENSE.txt.

Examples are licensed under the Simplified BSD license. See examples/LICENSE.txt.

Payward's PHP API, Alan McIntyre's BTC-e API, and ScriptProdigy's Cryptsy Python API were used as examples when writing the original python2-krakenex package. It was then ported to Python 3.