Struct KrakenExecutionClientConfig 

pub struct KrakenExecutionClientConfig {

    pub account_id: AccountId,
    pub api_key: String,
    pub api_secret: String,
    pub product_type: KrakenProductType,
    pub environment: KrakenEnvironment,
    pub base_url: Option<String>,
    pub ws_url: Option<String>,
    pub proxy_url: Option<String>,
    pub timeout_secs: u64,
    pub heartbeat_interval_secs: u64,
    pub auth_timeout_secs: Option<u64>,
    pub max_requests_per_second: Option<u32>,
    pub transport_backend: TransportBackend,
    pub spot_account_type: AccountType,
    pub default_leverage: Option<u16>,
    pub use_spot_position_reports: bool,
    pub spot_positions_quote_currency: String,
    pub margin_balance_asset: Option<String>,
    pub use_ws_trade: bool,
    pub ws_request_timeout_secs: u64,
}

Configuration for the Kraken execution client.

Fields

account_id: AccountId

api_key: String

api_secret: String

product_type: KrakenProductType

environment: KrakenEnvironment

base_url: Option<String>

ws_url: Option<String>

proxy_url: Option<String>

Optional proxy URL for HTTP and WebSocket transports.

timeout_secs: u64

heartbeat_interval_secs: u64

auth_timeout_secs: Option<u64>

Optional WebSocket authentication timeout (seconds), defaulting to AUTHENTICATION_TIMEOUT_SECS when unset (Kraken Futures login).

max_requests_per_second: Option<u32>

transport_backend: TransportBackend

spot_account_type: AccountType

Account type for spot trading (Cash or Margin).

When set to Margin, the adapter calls TradeBalance for margin reporting and OpenPositions for position reconciliation. Per-order leverage is set via SubmitOrder.params["leverage"] (u16 multiplier).

default_leverage: Option<u16>

Default leverage multiplier for spot margin orders when not overridden per-order.

Sent as "N:1" to Kraken (e.g., 3 becomes "3:1"). Valid tiers per pair are in AssetPairInfo.leverage_buy / leverage_sell. None means cash orders (no leverage field sent).

use_spot_position_reports: bool

Whether to generate PositionStatusReports from spot wallet balances.

Set true for spot-only (cash) accounts that need position tracking from balance snapshots. For margin accounts leave false; positions are reconciled via OpenPositions instead.

spot_positions_quote_currency: String

Quote currency used for synthetic spot position reports.

Only relevant when use_spot_position_reports is true.

margin_balance_asset: Option<String>

Summary-display asset for TradeBalance margin metrics.

Controls the denomination of equity, free margin, used margin, and other summary figures returned by Kraken’s TradeBalance endpoint (e.g. "ZUSD", "ZGBP", "ZEUR", "USDT"). None lets Kraken default to ZUSD. Display-only: Kraken converts internally; per-position figures from OpenPositions remain in the traded pair’s quote currency.

use_ws_trade: bool

Use WebSocket v2 for order submission, modification, and cancellation.

When true (default), submit_order, modify_order, cancel_order, and submit_order_list route through the authenticated WebSocket connection when active, falling back to REST when the WebSocket is inactive. When false, all order operations use REST only.

ws_request_timeout_secs: u64

Timeout in seconds for WebSocket order responses.

Timeouts preserve request correlation until a matching response or shutdown, without emitting a terminal event. submit_order and submit_order_list also send a best-effort compensating cancel.

Implementations

impl KrakenExecutionClientConfig

pub fn builder() -> KrakenExecutionClientConfigBuilder

Create an instance of KrakenExecutionClientConfig using the builder syntax

impl KrakenExecutionClientConfig

pub fn http_base_url(&self) -> String

Returns the HTTP base URL for the configured product type and environment.

pub fn ws_url(&self) -> String

Returns the WebSocket URL for the configured product type and environment.

pub fn validate(&self) -> Result<()>

Validates config invariants.

Errors

Returns an error if default_leverage is set on a Cash account or the demo environment is used for Spot.

Trait Implementations

impl ClientConfig for KrakenExecutionClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for KrakenExecutionClientConfig

fn clone(&self) -> KrakenExecutionClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KrakenExecutionClientConfig

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

Formats the value using the given formatter.

impl Default for KrakenExecutionClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for KrakenExecutionClientConfig

impl<'de> Deserialize<'de> for KrakenExecutionClientConfig

where KrakenExecutionClientConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'py> FromPyObject<'a, 'py> for KrakenExecutionClientConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for KrakenExecutionClientConfig

type Target = KrakenExecutionClientConfig

The Python output type

type Output = Bound<'py, <KrakenExecutionClientConfig 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 KrakenExecutionClientConfig

const NAME: &str = "KrakenExecutionClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for KrakenExecutionClientConfig

const MODULE: Option<&str>

Module which the class will be associated with.

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 = /// Configuration for the Kraken execution client.

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 Layout = <<KrakenExecutionClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<KrakenExecutionClientConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForKrakenExecutionClientConfig

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<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for KrakenExecutionClientConfig

const TEXT_SIGNATURE: &'static str = "(account_id, api_key, api_secret, product_type=None, environment=None, base_url=None, ws_url=None, proxy_url=None, timeout_secs=None, heartbeat_interval_secs=None, auth_timeout_secs=None, max_requests_per_second=None, spot_account_type=None, default_leverage=None, use_spot_position_reports=None, spot_positions_quote_currency=None, margin_balance_asset=None, use_ws_trade=None, ws_request_timeout_secs=None, transport_backend=None)"

impl PyStubType for KrakenExecutionClientConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for KrakenExecutionClientConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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 Serialize for KrakenExecutionClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.