Skip to main content

Kraken extension for the Bitcoin Exchange (BitEx) REST API Framwork

Project description

CI Status Documentation Status


Installation is simple, as it should be:

pip install bitex-kraken


After installing, requesting data is easy:

>>>from bitex import BitexSession
>>>session = BitexSession()
# bitex.BitexSession provides a set of methods to execute the most common queries
>>>r = session.ticker("kraken", "XBTUSD")
# The response objects returned are bitex.BitexResponses, which behave like regular requests.Response objects.
<KrakenResponse [200]>
    "result": {
# bitex-kraken also provides convenience methods for data piping
  "uid": "<uid>",
  "received": "<ts>",
  "ask_price": "52131.00000",
  "ask_size": "1.000",
  "ask_size": "52130.10000",
  "bid_size": "2.000",
  "last_price": "52130.20000",
  "last_size": "0.04000000",
  "vol": "1231.07009049",
  "vol_24h": "6124.65870266",
  "vwap": "52031.82478",
  "vwap_24h": "51669.15093",
  "trades": "14674",
  "trades_24h": "59777",
  "high": "52555.10000",
  "high_24h": "52779.60000",
  "low": "51370.00000",
  "low_24h": "50519.00000",
  "open": "52130.00000"
# Or for storing them as uid-label-value triples
  ["<uid>", "ask_price", "52131.00000"],
  ["<uid>", "ask_size", "1.000"],
  ["<uid>", "ask_size", "52130.10000"],
  ["<uid>", "bid_size", "2.000"],
  ["<uid>", "last_price", "52130.20000"],
  ["<uid>", "last_size", "0.04000000"],
  ["<uid>", "vol", "1231.07009049"],
  ["<uid>", "vol_24h", "6124.65870266"],
  ["<uid>", "vwap", "52031.82478"],
  ["<uid>", "vwap_24h", "51669.15093"],
  ["<uid>", "trades", "14674"],
  ["<uid>", "trades_24h", "59777"],
  ["<uid>", "high", "52555.10000"],
  ["<uid>", "high_24h", "52779.60000"],
  ["<uid>", "low", "51370.00000"],
  ["<uid>", "low_24h", "50519.00000"],
  ["<uid>", "open", "52130.00000"],
  ["<uid>", "received", "<ts>"]


If you’re looking to work on or with bitex-framework, you’ll want the development environment setup. We’ve supplied a few make targets to make your life easier:

# Install bitex and its development requirements
make development

We also supply targets to run code formatters, linters and tests:

# Run code formatters
make pretty

# Verify code style
make style-check

# Run tests via tox
tox -e testenv

If you’d like to contribute to the project, please have a look at CONTRIBUTING.rst on some general pointers about how development takes place, what the expected steps of you are and what requirements we have to merge a PR.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bitex-kraken-1.0.0.tar.gz (9.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page