Struct BybitExecutionClientConfig 

pub struct BybitExecutionClientConfig {

    pub api_key: Option<String>,
    pub api_secret: Option<String>,
    pub product_types: Vec<BybitProductType>,
    pub environment: BybitEnvironment,
    pub base_url_http: Option<String>,
    pub base_url_ws_private: Option<String>,
    pub base_url_ws_trade: Option<String>,
    pub proxy_url: Option<String>,
    pub http_timeout_secs: u64,
    pub max_retries: u32,
    pub retry_delay_initial_ms: u64,
    pub retry_delay_max_ms: u64,
    pub heartbeat_interval_secs: u64,
    pub auth_timeout_secs: Option<u64>,
    pub recv_window_ms: u64,
    pub account_id: Option<AccountId>,
    pub use_spot_position_reports: bool,
    pub auto_repay_spot_borrows: bool,
    pub futures_leverages: Option<HashMap<String, u32>>,
    pub position_mode: Option<HashMap<String, BybitPositionMode>>,
    pub margin_mode: Option<BybitMarginMode>,
    pub transport_backend: TransportBackend,
}

Configuration for the Bybit live execution client.

Fields

api_key: Option<String>

API key for authenticated requests.

api_secret: Option<String>

API secret for authenticated requests.

product_types: Vec<BybitProductType>

Product types to support (e.g., Linear, Spot, Inverse, Option).

environment: BybitEnvironment

Environment selection (Mainnet, Testnet, Demo).

base_url_http: Option<String>

Optional override for the REST base URL.

base_url_ws_private: Option<String>

Optional override for the private WebSocket URL.

base_url_ws_trade: Option<String>

Optional override for the trade WebSocket URL.

proxy_url: Option<String>

Optional proxy URL for HTTP and WebSocket transports.

http_timeout_secs: u64

REST timeout in seconds.

max_retries: u32

Maximum retry attempts for REST requests.

retry_delay_initial_ms: u64

Initial retry backoff in milliseconds.

retry_delay_max_ms: u64

Maximum retry backoff in milliseconds.

heartbeat_interval_secs: u64

Heartbeat interval in seconds for WebSocket clients.

auth_timeout_secs: Option<u64>

Optional WebSocket authentication wait timeout (seconds), defaulting to the client default when unset.

recv_window_ms: u64

Receive window in milliseconds for signed requests.

account_id: Option<AccountId>

Optional account identifier to associate with the execution client.

use_spot_position_reports: bool

Whether scoped execution-client SPOT position requests derive positions from wallet balances. The HTTP client rejects enabled unscoped SPOT requests because balances cannot be attributed to pairs. The execution client omits SPOT from bulk requests and reports its bulk coverage as unavailable.

auto_repay_spot_borrows: bool

Whether to automatically repay SPOT margin borrows after BUY orders tracked by this client and reported on the standard execution channel (not execution.fast) fully fill.

futures_leverages: Option<HashMap<String, u32>>

Leverage configuration for futures (symbol -> leverage).

position_mode: Option<HashMap<String, BybitPositionMode>>

Position mode configuration for symbols (symbol -> mode).

margin_mode: Option<BybitMarginMode>

Unified margin mode setting.

transport_backend: TransportBackend

WebSocket transport backend (defaults to Tungstenite).

Implementations

impl BybitExecutionClientConfig

pub fn builder() -> BybitExecutionClientConfigBuilder

Create an instance of BybitExecutionClientConfig using the builder syntax

impl BybitExecutionClientConfig

pub fn new() -> Self

Creates a configuration with default values.

pub fn has_api_credentials(&self) -> bool

Returns true if both API key and secret are available.

pub fn http_base_url(&self) -> String

Returns the REST base URL, considering overrides and environment.

pub fn ws_private_url(&self) -> String

Returns the private WebSocket URL, considering overrides and environment.

pub fn ws_trade_url(&self) -> String

Returns the trade WebSocket URL, considering overrides and environment.

Trait Implementations

impl ClientConfig for BybitExecutionClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for BybitExecutionClientConfig

fn clone(&self) -> BybitExecutionClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BybitExecutionClientConfig

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

Formats the value using the given formatter.

impl Default for BybitExecutionClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for BybitExecutionClientConfig

impl<'de> Deserialize<'de> for BybitExecutionClientConfig

where BybitExecutionClientConfig: 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 BybitExecutionClientConfig

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 BybitExecutionClientConfig

type Target = BybitExecutionClientConfig

The Python output type

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

const NAME: &str = "BybitExecutionClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BybitExecutionClientConfig

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 Bybit live 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 = <<BybitExecutionClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<BybitExecutionClientConfig>

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 = Pyo3MethodsInventoryForBybitExecutionClientConfig

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 BybitExecutionClientConfig

const TEXT_SIGNATURE: &'static str = "(product_types=None, environment=None, api_key=None, api_secret=None, base_url_http=None, base_url_ws_private=None, base_url_ws_trade=None, proxy_url=None, http_timeout_secs=None, max_retries=None, retry_delay_initial_ms=None, retry_delay_max_ms=None, heartbeat_interval_secs=None, auth_timeout_secs=None, recv_window_ms=None, account_id=None, use_spot_position_reports=None, auto_repay_spot_borrows=None, margin_mode=None, transport_backend=None)"

impl PyStubType for BybitExecutionClientConfig

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 BybitExecutionClientConfig

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 BybitExecutionClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.