Python Kraken Sdk
btschwertfeger88 ดาว
Command-line tool, MCP server, and SDK to access the Kraken Crypto Asset Exchange API (Spot, xStocks, and Futures, REST and Websocket API)
- ทรานสปอร์ต
- stdio
- สถานะ
- โลคัล
Power your agent
การติดตั้งจากผู้เผยแพร่ ไม่ใช่เอนด์พอยต์ของ PlugMCP
URL แบบรีโมตหรือคำสั่งบนเครื่องของคุณ? การติดตั้งสองแบบต่างกันอย่างไร
รันบน PlugMCP
A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.
เปิด⚠️ This is an unofficial collection of REST and websocket clients for Spot and Futures trading on the Kraken Crypto Asset Exchange using Python. Payward Ltd. and Kraken are in no way associated with the authors of this package and documentation.
Please note that this project is independent and not endorsed by Kraken or Payward Ltd. Users should be aware that they are using third-party software, and the authors of this project are not responsible for any issues, losses, or risks associated with its usage.
There is no guarantee that this software will work flawlessly at this or later times. Of course, no responsibility is taken for possible profits or losses. This software probably has some errors in it, so use it at your own risk. Also no one should be motivated or tempted to invest assets in speculative forms of investment. By using this software you release the author(s) from any liability regarding the use of this software.
General:
Available Clients:
Documentation:
Projects using this SDK:
ONLY tagged releases are available at PyPI. So the content of the master may not match with the content of the latest release. - Please have a look at the release specific READMEs and changelogs.
It is also recommended to pin the used version to avoid unexpected behavior on new releases.
python3 -m pip install python-kraken-sdk
If any unexpected behavior occurs, please check your API permissions, rate limits, update the python-kraken-sdk, see the Troubleshooting section, and if the error persists please open an issue.
The python-kraken-sdk provides a command-line interface to access the Kraken API
using basic instructions while performing authentication tasks in the
background. The Spot and Futures API are accessible and follow the pattern
kraken {spot,futures} [OPTIONS] URL. See examples below.
# get server time
kraken spot https://api.kraken.com/0/public/Time
{'unixtime': 1716707589, 'rfc1123': 'Sun, 26 May 24 07:13:09 +0000'}
# get user's balances
kraken spot --api-key=<api-key> --secret-key=<secret-key> -X POST https://api.kraken.com/0/private/Balance
{'ATOM': '17.28229999', 'BCH': '0.0000077100', 'ZUSD': '1000.0000'}
# get user's trade balances
kraken spot --api-key=<api-key> --secret-key=<secret-key> -X POST https://api.kraken.com/0/private/TradeBalance --data '{"asset": "DOT"}'
{'eb': '2.8987347115', 'tb': '1.1694303513', 'm': '0.0000000000', 'uv': '0', 'n': '0.0000000000', 'c': '0.0000000000', 'v': '0.0000000000', 'e': '1.1694303513', 'mf': '1.1694303513'}
# get 1D candles for a futures instrument
kraken futures https://futures.kraken.com/api/charts/v1/spot/PI_XBTUSD/1d
{'candles': [{'time': 1625616000000, 'open': '34557.84000000000', 'high': '34803.20000000000', 'low': '33816.32000000000', 'close': '33880.22000000000', 'volume': '0' ...
# get user's open futures positions
kraken futures --api-key=<api-key> --secret-key=<secret-key> https://futures.kraken.com/derivatives/api/v3/openpositions
{'result': 'success', 'openPositions': [], 'serverTime': '2024-05-26T07:15:38.91Z'}
... All endpoints of the Kraken Spot and Futurs API can be accessed like that.
The python-kraken-sdk also ships an MCP server exposing the Spot (incl.
xStocks — pass "asset_class": "tokenized_asset" inside params where the
Kraken API docs require it) and Futures request methods as two tools,
spot_request and futures_request.
uv tool install "python-kraken-sdk[mcp]"
# e.g. Claude setup:
claude mcp add kraken --scope user -- kraken-mcp
Credentials are never tool arguments. Configure them as environment
variables instead: KRAKEN_SPOT_API_KEY / KRAKEN_SPOT_SECRET_KEY,
KRAKEN_FUTURES_API_KEY / KRAKEN_FUTURES_SECRET_KEY, and optionally
KRAKEN_FUTURES_SANDBOX=1 to target the Futures demo environment. Example
client for Claude Code configuration:
// ~/.claude.json
{
"mcpServers": {
"kraken": {
"command": "kraken-mcp",
"env": {
// Only public endpoints are available without credentials
"KRAKEN_SPOT_API_KEY": "<your-api-key>",
"KRAKEN_SPOT_SECRET_KEY": "<your-secret-key>"
}
}
}
}
The python-kraken-sdk provides lots of functions to easily access most of the REST and websocket endpoints of the Kraken Crypto Asset Exchange API. Since these endpoints and their parameters may change, all implemented endpoints are tested on a regular basis.
The Kraken Spot API can be accessed by executing requests to the endpoints
directly using the request method provided by any client. This is demonstrated
below.
See https://docs.kraken.com/api/docs/guides/global-intro for information about the available endpoints and their usage.
SpotClientThe Spot client provides access to all un-and authenticated endpoints of Kraken's Spot API.
from kraken.spot import SpotClient
client = SpotClient(key="<your-api-key>", secret="<your-secret-key>")
print(client.request("POST", "/0/private/Balance"))
SpotAsyncClientThe async Spot client allows for asynchronous access to Kraken's Spot API endpoints. Below are two examples demonstrating its usage.
Using SpotAsyncClient without a context manager; In this example, the client is manually closed after the request is made.
import asyncio
from kraken.spot import SpotAsyncClient
async def main():
client = SpotAsyncClient(key="<your-api-key>", secret="<your-secret-key>")
try:
response = await client.request("POST", "/0/private/Balance")
print(response)
finally:
await client.close()
if __name__ == "__main__":
asyncio.run(main())
Using SpotAsyncClient as a context manager; This example demonstrates the use of the context manager, which ensures the client is automatically closed after the request is completed.
import asyncio
from kraken.spot import SpotAsyncClient
async def main():
async with SpotAsyncClient(key="<your-api-key>", secret="<your-secret-key>") as client:
response = await client.request("POST", "/0/private/Balance")
print(response)
if __name__ == "__main__":
asyncio.run(main())
SpotWSClient (Websocket API)Kraken offers two versions of their websocket API (V1 and V2). Since V2 is offers more possibilities, is way faster and easier to use, only the never version is supported by this SDK.
The official documentation for can be found at:
Note that authenticated Spot websocket clients can also un-/subscribe from/to public feeds.
The example below can be found in an extended way in
examples/spot_ws_examples.py.
import asyncio
from kraken.spot import SpotWSClient
class Client(SpotWSClient):
"""Can be used to create a custom trading strategy"""
async def on_message(self, message):
"""Receives the websocket messages"""
if message.get("method") == "pong" \
or message.get("channel") == "heartbeat":
return
print(message)
# Here we can access lots of methods, for example to create an order:
# if self.is_auth: # only if the client is authenticated …
# await self.send_message(
# message={
# "method": "add_order",
# "params": {
# "limit_price": 1234.56,
# "order_type": "limit",
# "order_userref": 123456789,
# "order_qty": 1.0,
# "side": "buy",
# "symbol": "BTC/USD",
# "validate": True,
# },
# }
# )
# … it is also possible to call regular REST endpoints
# but using the websocket messages is more efficient.
# You can also un-/subscribe here using self.subscribe/self.unsubscribe.
async def main():
try:
# Public/unauthenticated websocket client
client = Client() # only use this one if you don't need private feeds
await client.start()
await client.subscribe(
params={"channel": "ticker", "symbol": ["BTC/USD", "DOT/USD"]}
)
await client.subscribe(
params={"channel": "book", "depth": 25, "symbol": ["BTC/USD"]}
)
# wait because unsubscribing is faster than unsubscribing … (just for that example)
await asyncio.sleep(3)
# print(client.active_public_subscriptions) # to list active subscriptions
await client.unsubscribe(
params={"channel": "ticker", "symbol": ["BTC/USD", "DOT/USD"]}
)
# …
# AS default, the authenticated client starts two websocket connections,
# one for authenticated and one for public messages. If there is no need
# for a public connection, it can be disabled using the ``no_public``
# parameter.
client_auth = Client(key="api-key", secret="secret-key", no_public=True)
await client_auth.start()
await client_auth.subscribe(params={"channel": "balances"})
while not client.exception_occur and not client_auth.exception_occur:
await asyncio.sleep(6)
finally:
await client.close()
await client_auth.close()
if __name__ == "__main__":
asyncio.run(main())
Kraken recently added support for trading of tokenized stocks (xStocks) on their platform. The python-kraken-sdk fully supports this new feature, allowing users to trade xStocks seamlessly alongside other crypto assets.
For accessing xStocks, you can use the same SpotClient and SpotAsyncClient
classes that are used for regular spot trading. The endpoints and methods for
xStocks are integrated into these clients, making it easy to manage your xStock
trades.
It is important to note that the xStocks feature is not available globally. Please check Kraken's documentation to understand the availability zones and ensure that you can trade xStocks from your location.
For trading or filtering for xStocks assets, the new asset class
tokenized_asset must be used, e.g. when creating an order:
from kraken.spot import SpotClient, Trade
# Option 1: Create an order using the SpotClient directly:
client = SpotClient(key="api-public-key", secret="api-secret-key")
client.request(
method="POST",
uri="/0/private/AddOrder",
params={
"type": "buy",
"volume": "1",
"ordertype": "limit",
"pair": "AAPLxUSD",
"price": "100.0",
"validate": True,
"asset_class": "tokenized_asset", # <- important!
},
)
# Option 2: Create an order using the Trade client:
trade = Trade(key="api-public-key", secret="api-secret-key")
trade.create_order(
pair="AAPLxUSD",
side="buy",
ordertype="limit",
volume="1",
price="100.0",
validate=True,
extra_params={"asset_class": "tokenized_asset"}, # <- important!
)
The Kraken Spot API can be accessed by executing requests to the endpoints
directly using the request method provided by any client. This is demonstrated
below.
See https://docs.kraken.com/api/docs/guides/global-intro for information about the available endpoints and their usage.
FuturesClientThe simple Futures client provides access to all un-and authenticated endpoints.
from kraken.futures import FuturesClient
client = FuturesClient(key="<your-api-key>", secret="<your-secret-key>")
print(client.request("GET", "/derivatives/api/v3/accounts"))
FuturesAsyncClientThe async Futures client allows for asynchronous access to Kraken's Futures endpoints. Below are two examples demonstrating its usage.
Using FuturesAsyncClient without a context manager; In this example, the client is manually closed after the request is made.
import asyncio
from kraken.futures import FuturesAsyncClient
async def main():
client = FuturesAsyncClient(key="<your-api-key>", secret="<your-secret-key>")
try:
response = await client.request("GET", "/derivatives/api/v3/accounts")
print(response)
finally:
await client.close()
if __name__ == "__main__":
asyncio.run(main())
Using FuturesAsyncClient as context manager; This example demonstrates the use of the context manager, which ensures the client is automatically closed after the request is completed.
import asyncio
from kraken.futures import FuturesAsyncClient
async def main():
async with FuturesAsyncClient(key="<your-api-key>", secret="<your-secret-key>") as client:
response = await client.request("GET", "/derivatives/api/v3/accounts")
print(response)
if __name__ == "__main__":
asyncio.run(main())
FuturesWSClient (Websocket API)Not only REST, also the websocket API for Kraken Futures is available. Examples
are shown below and demonstrated in examples/futures_ws_examples.py.
Note: Authenticated Futures websocket clients can also un-/subscribe from/to public feeds.
import asyncio
from kraken.futures import FuturesWSClient
class Client(FuturesWSClient):
async def on_message(self, event):
print(event)
async def main():
try:
# Public/unauthenticated websocket connection
client = Client()
await client.start()
products = ["PI_XBTUSD", "PF_ETHUSD"]
# subscribe to a public websocket feed
await client.subscribe(feed="ticker", products=products)
# await client.subscribe(feed="book", products=products)
# …
# unsubscribe from a public websocket feed
# await client.unsubscribe(feed="ticker", products=products)
# Private/authenticated websocket connection (+public)
client_auth = Client(key="key-key", secret="secret-key")
await client_auth.start()
# print(client_auth.get_available_private_subscription_feeds())
# subscribe to a private/authenticated websocket feed
await client_auth.subscribe(feed="fills")
await client_auth.subscribe(feed="open_positions")
await client_auth.subscribe(feed="open_orders")
# …
# unsubscribe from a private/authenticated websocket feed
await client_auth.unsubscribe(feed="fills")
while not client.exception_occur and not client_auth.exception_occur:
await asyncio.sleep(6)
finally:
await client.close()
await client_auth.close()
if __name__ == "__main__":
asyncio.run(main())
… are welcome - but:
The versioning scheme follows the pattern v<Major>.<Minor>.<Patch>. Here's
what each part signifies:
Coding standards are not always followed to make arguments and function names as similar as possible to those of the Kraken API documentations.
The tool aims to be fast, easy to use and maintain. In the past, lots of clients
were implemented, that provided functions for almost all available endpoints of
the Kraken API. The effort to maintain this collection grew to a level where it
was not possible to check various changelogs to apply new updates on a regular
basis. Instead, it was decided to concentrate on the request functions of
the SpotClient, SpotAsyncClient, FuturesClient and the
FuturesAsyncClient (as well as their websocket client implementations). All
those clients named "User", "Trade", "Market", "Funding" and so on will no
longer be extended, but maintained to a certain degree. The client's request
method takes the raw method, URI, and parameters directly, so every endpoint
and parameter documented by Kraken's API is already reachable without a named
wrapper method. Existing wrapper methods still receive bug fixes. Websocket
clients keep gaining new channels and features, since those cannot be reached
through a plain request call.
Command-line tool, MCP server, and SDK to access the Kraken Crypto Asset Exchange API (Spot, xStocks, and Futures, REST and Websocket API)
เครื่องมือ
ยังไม่มีรายการเครื่องมือ เซิร์ฟเวอร์แบบรีโมตจะได้รายการหลังการตรวจสอบสถานะครั้งแรก
FAQ
คัดลอกคอนฟิก stdio สำหรับ Cursor, Claude Desktop, Claude Code หรือ VS Code ได้ในหน้านี้ คอนฟิกนี้ใช้การติดตั้งของผู้เผยแพร่ ไม่ใช่พร็อกซีของ PlugMCP
ระเบียนนี้ไม่ได้ระบุตัวแปรสภาพแวดล้อมที่จำเป็น
Python Kraken Sdk ทำงานแบบโลคัลผ่าน stdio
ตรวจสอบล่าสุดเมื่อ 2026-11-08 Command-line tool, MCP server, and SDK to access the Kraken Crypto Asset Exchange API (Spot, xStocks, and Futures, REST and Websocket API)