kraken_connector 0.2.0

WS and HTTP clients for Kraken exchange API

kraken-connector

A typed Python client for the Kraken cryptocurrency exchange, covering both the REST API and WebSocket API v2. Built on httpx for HTTP, websockets for streaming, and attrs for data models.

Features

• REST API -- typed request/response models across 7 endpoint groups (market data, account data, trading, funding, earn, subaccounts, websocket auth)
• WebSocket v2 -- async client with typed channel models for ticker, OHLC, trades, order book, executions, and balances
• Trading -- all 8 WS v2 trading methods (add, edit, cancel, batch add, batch cancel, cancel all, cancel all after, amend)
• Order book management -- local order book state with incremental updates and CRC32 checksum validation
• Automatic reconnection -- configurable backoff with subscription and sequence tracking across reconnects
• Rate limiting -- caller-controlled token-bucket limiter matching Kraken's tier-based rate limits
• Retry -- configurable retry transport with exponential backoff for transient network errors
• Request logging -- optional request/response logging via Python's stdlib logging
• Fully typed -- py.typed marker, strict mypy, attrs-based models with to_dict()/from_dict()

Requirements

Python 3.11+

Installation

pip install kraken-connector

Quick Start

REST API

from kraken_connector import HTTPClient
from kraken_connector.api.market_data import get_server_time

client = HTTPClient("https://api.kraken.com")
response = get_server_time.sync(client=client)
print(response)

WebSocket

import asyncio
from kraken_connector.ws import KrakenWSClient
from kraken_connector.ws.subscribe import TickerParams
from kraken_connector.ws.envelopes import WSDataMessage

async def main():
    async with KrakenWSClient() as client:
        await client.subscribe(TickerParams(symbol=["BTC/USD"]))
        async for msg in client:
            if isinstance(msg, WSDataMessage) and msg.channel == "ticker":
                print(msg.data)

asyncio.run(main())

See the documentation for guides on authentication, rate limiting, trading, order book management, error handling, and more.

Development

See CONTRIBUTING.md for development setup and guidelines.

License

MIT