Skip to main content
Latest Travis continuous integration build Read latest documentation Latest PyPI release Development discussion at https://gitter.im/python3-krakenex/Lobby

krakenex

Kraken.com exchange REST 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

Libraries

  • pykrakenapi - nicely wraps API methods into regular Python methods, and JSON responses into Pandas dataframes (available on PyPI!)

  • CurrencyViewer - short python3 framework for data extraction, conversion, and smooth development experience (available on PyPI!)

Clients

  • clikraken - command-line client for the Kraken exchange (available on PyPI!)

  • Telegram-Kraken-Bot - Telegram bot to trade on Kraken exchange

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 the most up-to-date list of public/private Kraken API methods, see their API documentation.

Examples

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

Installation

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

A PyPI package is available.

For general use, there is only one direct dependency: requests.

For the user

Using pip:

# install from PyPI
pip install --user krakenex
# ... or from local git repo clone
cd CLONE-OF-GIT-REPO
pip install --user .

Attribution

“Core” code is licensed under LGPLv3. See LICENSE.txt and LICENSE-GPLv3.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.

Development notes

Do not annoy the Kraken with tests

Some tests may be making queries to the Kraken API server.

If you intend to do development on this package, and have tests enabled on Travis CI, be sure to limit concurrent jobs to 1, and enable all possible auto-cancellations.

(Better yet, don’t rely on public infrastructure, but run the tests locally first.)

No Python 2

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.

Metadata

Release files for krakenex 2.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for krakenex 2.2.2
File Size Uploaded
krakenex-2.2.2.tar.gz 39.5 kB Details

Release files / krakenex-2.2.2.tar.gz

Download URL krakenex-2.2.2.tar.gz
Size 39.5 kB
Tags Source
SHA-256 checksum
How to use checksums
3f7553c3295ce03c79a47701f3949066a64ab5d8656f9e97d13cf6bf22eacf7a
BLAKE2b-256 checksum
How to use checksums
9ab33e5edae73c8438602be16c2faa1126d720136e83af9980a4e73e1f0b4480
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.3

Release history Release notifications | RSS feed

This release

2.2.2 This release

1 release file

2.2.1

1 release file

2.2.0

1 release file

2.1.0

1 release file

2.0.0

1 release file

1.0.0

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page