Struct KrakenFuturesWebSocketClient 

pub struct KrakenFuturesWebSocketClient { /* private fields */ }

WebSocket client for the Kraken Futures v1 streaming API.

Implementations

impl KrakenFuturesWebSocketClient

pub fn new(url: String, heartbeat_secs: Option<u64>) -> Self

Creates a new client with the given URL.

pub fn with_credentials( url: String, heartbeat_secs: Option<u64>, credential: Option<KrakenCredential>, ) -> Self

Creates a new client with API credentials for authenticated feeds.

pub fn has_credentials(&self) -> bool

Returns true if the client has API credentials set.

pub fn url(&self) -> &str

Returns the WebSocket URL.

pub fn is_closed(&self) -> bool

Returns true if the connection is closed.

pub fn is_active(&self) -> bool

Returns true if the connection is active.

pub async fn wait_until_active( &self, timeout_secs: f64, ) -> Result<(), KrakenWsError>

Waits until the WebSocket connection is active or timeout.

pub async fn authenticate(&self) -> Result<(), KrakenWsError>

Authenticates the WebSocket connection for private feeds.

This sends a challenge request, waits for the response, signs it, and stores the credentials for use in private subscriptions.

pub fn cache_instruments(&self, instruments: Vec<InstrumentAny>)

Caches instruments for price precision lookup (bulk replace).

Must be called after connect() when the handler is ready to receive commands.

pub fn cache_instrument(&self, instrument: InstrumentAny)

Caches a single instrument for price precision lookup (upsert).

Must be called after connect() when the handler is ready to receive commands.

pub async fn connect(&mut self) -> Result<(), KrakenWsError>

Connects to the WebSocket server.

pub async fn disconnect(&mut self) -> Result<(), KrakenWsError>

Disconnects from the WebSocket server.

pub async fn close(&mut self) -> Result<(), KrakenWsError>

Closes the WebSocket connection.

pub async fn subscribe_mark_price( &self, instrument_id: InstrumentId, ) -> Result<(), KrakenWsError>

Subscribes to mark price updates for the given instrument.

pub async fn unsubscribe_mark_price( &self, instrument_id: InstrumentId, ) -> Result<(), KrakenWsError>

Unsubscribes from mark price updates for the given instrument.

pub async fn subscribe_index_price( &self, instrument_id: InstrumentId, ) -> Result<(), KrakenWsError>

Subscribes to index price updates for the given instrument.

pub async fn unsubscribe_index_price( &self, instrument_id: InstrumentId, ) -> Result<(), KrakenWsError>

Unsubscribes from index price updates for the given instrument.

pub async fn subscribe_quotes( &self, instrument_id: InstrumentId, ) -> Result<(), KrakenWsError>

Subscribes to quote updates for the given instrument.

Uses the order book channel for low-latency top-of-book quotes.

pub async fn unsubscribe_quotes( &self, instrument_id: InstrumentId, ) -> Result<(), KrakenWsError>

Unsubscribes from quote updates for the given instrument.

pub async fn subscribe_trades( &self, instrument_id: InstrumentId, ) -> Result<(), KrakenWsError>

Subscribes to trade updates for the given instrument.

pub async fn unsubscribe_trades( &self, instrument_id: InstrumentId, ) -> Result<(), KrakenWsError>

Unsubscribes from trade updates for the given instrument.

pub async fn subscribe_book( &self, instrument_id: InstrumentId, _depth: Option<u32>, ) -> Result<(), KrakenWsError>

Subscribes to order book updates for the given instrument.

Note: The depth parameter is accepted for API compatibility with spot client but is not used by Kraken Futures (full book is always returned).

pub async fn unsubscribe_book( &self, instrument_id: InstrumentId, ) -> Result<(), KrakenWsError>

Unsubscribes from order book updates for the given instrument.

pub fn take_output_rx( &mut self, ) -> Option<UnboundedReceiver<KrakenFuturesWsMessage>>

Gets the output receiver for processed messages.

pub fn set_account_id(&self, account_id: AccountId)

Sets the account ID for execution reports.

Must be called before subscribing to execution feeds to properly generate OrderStatusReport and FillReport objects.

pub fn cache_client_order( &self, client_order_id: ClientOrderId, venue_order_id: Option<VenueOrderId>, instrument_id: InstrumentId, trader_id: TraderId, strategy_id: StrategyId, )

Caches a client order ID mapping for order tracking.

This caches the trader_id, strategy_id, and instrument_id for an order, allowing the handler to emit proper order events with correct identifiers when WebSocket messages arrive.

pub async fn request_challenge(&self) -> Result<(), KrakenWsError>

Requests a challenge from the WebSocket for authentication.

After calling this, listen for the challenge response message and then call authenticate_with_challenge() to complete authentication.

pub async fn set_auth_credentials( &self, original_challenge: String, signed_challenge: String, ) -> Result<(), KrakenWsError>

Set authentication credentials directly (for when challenge is obtained externally).

pub fn sign_challenge(&self, challenge: &str) -> Result<String, KrakenWsError>

Sign a challenge with the API credentials.

Returns the signed challenge on success.

pub async fn authenticate_with_challenge( &self, challenge: &str, ) -> Result<(), KrakenWsError>

Complete authentication with a received challenge.

pub async fn subscribe_open_orders(&self) -> Result<(), KrakenWsError>

Subscribes to open orders feed (private, requires authentication).

pub async fn subscribe_fills(&self) -> Result<(), KrakenWsError>

Subscribes to fills feed (private, requires authentication).

pub async fn subscribe_executions(&self) -> Result<(), KrakenWsError>

Subscribes to both open orders and fills (convenience method).

impl KrakenFuturesWebSocketClient

pub fn py_has_credentials(&self) -> bool

pub fn py_url(&self) -> &str

Trait Implementations

impl Clone for KrakenFuturesWebSocketClient

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KrakenFuturesWebSocketClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for KrakenFuturesWebSocketClient

type Target = KrakenFuturesWebSocketClient

The Python output type

type Output = Bound<'py, <KrakenFuturesWebSocketClient as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for KrakenFuturesWebSocketClient

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for KrakenFuturesWebSocketClient

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// WebSocket client for the Kraken Futures v1 streaming API.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<KrakenFuturesWebSocketClient>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for KrakenFuturesWebSocketClient

const TEXT_SIGNATURE: &'static str = "(environment=None, base_url=None, heartbeat_secs=None, api_key=None, api_secret=None)"

impl PyMethods<KrakenFuturesWebSocketClient> for PyClassImplCollector<KrakenFuturesWebSocketClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for KrakenFuturesWebSocketClient

const NAME: &'static str = "KrakenFuturesWebSocketClient"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for KrakenFuturesWebSocketClient

impl ExtractPyClassWithClone for KrakenFuturesWebSocketClient