Skip to main content

Crate nautilus_kraken

Crate nautilus_kraken 

Source
Expand description

NautilusTrader adapter for the Kraken exchange.

The nautilus-kraken crate provides separate Spot and Futures data and execution clients over HTTP and WebSocket. It includes typed API models, instrument loading, order and account updates, and live-node factories for both markets.

The official Kraken API reference can be found at https://docs.kraken.com/.

§NautilusTrader

NautilusTrader is an open-source, production-grade, Rust-native trading engine with a deterministic, event-driven architecture for multi-asset, multi-venue systems.

The system spans research, simulation, and live execution, providing research-to-live semantic parity.

§Features

  • REST API v2 client for market data and account operations.
  • WebSocket v2 client for real-time data feeds.
  • Support for Spot and Futures markets.
  • Instrument, ticker, trade, orderbook, and OHLC data.
  • Prepared for execution support (orders, positions, balances).

§Feature Flags

Feature flags control code inclusion for Rust builds and Python bindings:

  • examples: Enables the crate’s example binaries.
  • extension-module: Builds as a Python extension module.
  • high-precision (default): Enables high-precision mode to use 128-bit value types. Keep this default for Futures because Kraken may return instrument precision above standard-precision mode’s nine-decimal limit.
  • python: Enables Python bindings from PyO3.

§Integrator Attribution

Spot and Futures HTTP order builders set broker to NautilusTrader’s integration ID. Raw HTTP clients preserve caller-provided parameters, and Spot WebSocket orders omit attribution.

§Documentation

Re-exports§

pub use config::KrakenDataClientConfig;
pub use config::KrakenExecutionClientConfig;
pub use data::KrakenFuturesDataClient;
pub use data::KrakenSpotDataClient;
pub use execution::KrakenFuturesExecutionClient;
pub use execution::KrakenSpotExecutionClient;
pub use http::KrakenFuturesHttpClient;
pub use http::KrakenFuturesRawHttpClient;
pub use http::KrakenHttpError;
pub use http::KrakenSpotHttpClient;
pub use http::KrakenSpotRawHttpClient;
pub use websocket::futures::client::KrakenFuturesWebSocketClient;
pub use websocket::spot_v2::client::KrakenSpotWebSocketClient;

Modules§

common
Shared primitives and utilities for the Kraken adapter.
config
Configuration types for Kraken data and execution clients.
data
Live market data client implementations for the Kraken adapter.
execution
Live execution client implementations for the Kraken adapter.
factories
Factory functions for creating Kraken clients and components.
http
HTTP/REST client implementations for Kraken APIs.
python
Python bindings from pyo3.
websocket
WebSocket client implementations for Kraken APIs.