Skip to main content

A well-documented Python API for the Kraken Cryptocurrency Exchange

Project description

Krakipy

PyPI version Documentation Status Downloads License: MIT

Krakipy is an easy to use Kraken API.

It uses the REST-API of the Kraken.com cryptocurrency exchange.

For more information please visit the krakipy documentation

16.08.2025 - Updated krakipy to amend_order, get_credit_line, add_order_batch, get_websocket_token, create_subaccount, account_transfer, get_withdrawal_adresses, get_pre_trade_data, get_post_trade_data and fixed bugs

08.03.2025 - Updated krakipy to include get_order_amends and get_withdrawal_methods and fixed bugs

29.10.2023 - Updated krakipy to include new functions and fixed bugs

31.07.2021 - Updated krakipy to support staking and unstaking

Features

  • All methods of the Kraken Rest API are included (Krakipy documentation also updated)
  • Easy and fast to use
  • Two factor authentification support (static and OTP)
  • Tor support

Installation

Use the package manager pip to install krakipy.

pip install krakipy

Usage Examples

Public Requests

Public requests dont need API keys.

from krakipy import KrakenAPI

# Create a session
kr = KrakenAPI()

# Get Ticker for Bitcoin/EUR
kr.get_ticker_information("XXBTZEUR")

# Get OHLC for Doge/Tether
kr.get_ohlc_data("XDGUSDT")

# Get Spreads for Ether/USD
kr.get_recent_spreads("XETHZUSD")

# Check the Kraken API system status
kr.get_system_status()

Private Requests

Private requests need a valid API key pair to your Kraken account for validation.

from krakipy import KrakenAPI

api_key = "*************************************************"
api_key_secret = "*************************************************"

# Create a validated session
with KrakenAPI(api_key, api_key_secret) as kr:

	# Send a limit order to buy 1.5 Bitcoin at 100,000.0 EUR/BTC
	kr.add_standard_order("XXBTZEUR", "buy", "limit", volume = 1.5, price = 100000.0)

	# Check your account balance
	kr.get_account_balance()

	# Check your withdrawal adresses
	kr.get_withdrawal_adresses()

	# Withdraw 1.0 Bitcoin to myBTCWallet
	kr.withdraw("XBT", "myBTCWallet", 1.0)

	# Download and save an export report to kraken_reports/
	kr.retrieve_export_report(report_id, dir="kraken_reports/")

License

The krakipy code is licensed under the MIT LICENSE. This program comes with no WARRANTY.

Krakipy Copyright (C) 2020-2025 Hubertus Wilisch

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

krakipy-0.1.11-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

Details for the file krakipy-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: krakipy-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 19.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for krakipy-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 8df680ab1ee82dfaffee5637a0433e5a4b2f252d735827516ca25173b9833d99
MD5 bf189ec454f2f8f3a6f97cc4b38c398c
BLAKE2b-256 0648b2fa4aeb24eca3b5432b0dfcb6b2cef114e17228fa04cc93b1474203beba

See more details on using hashes here.

Supported by

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