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

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:

	# Create 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()

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

	# Unstake 300.0 Solana
	kr.unstake_asset("SOL", 300.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 ABSOLUTELY 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

krakipy-0.1.10-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: krakipy-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.8

File hashes

Hashes for krakipy-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 fcadf35b983f081f173bac6615a6b053481a9fef1ed3996c25950a6d52add9c7
MD5 e06f767606bd1dc2a3b18385a135d152
BLAKE2b-256 02b064bd957e6d243aed54d1c5033c6e79259d662218e940167a97175878d27f

See more details on using hashes here.

Supported by

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