Struct BitmexExecutionClientConfig 

pub struct BitmexExecutionClientConfig {

    pub api_key: Option<String>,
    pub api_secret: Option<String>,
    pub base_url_http: Option<String>,
    pub base_url_ws: 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 active_only: bool,
    pub environment: BitmexEnvironment,
    pub account_id: Option<AccountId>,
    pub max_requests_per_second: u32,
    pub max_requests_per_minute: u32,
    pub submitter_pool_size: Option<usize>,
    pub canceller_pool_size: Option<usize>,
    pub submitter_proxy_urls: Option<Vec<String>>,
    pub canceller_proxy_urls: Option<Vec<String>>,
    pub deadmans_switch_timeout_secs: Option<u64>,
    pub transport_backend: TransportBackend,
}

Configuration for the BitMEX live execution client.

Fields

api_key: Option<String>

API key used for authenticated requests.

api_secret: Option<String>

API secret used for authenticated requests.

base_url_http: Option<String>

Optional override for the REST base URL.

base_url_ws: Option<String>

Optional override for the 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 (seconds) for the WebSocket client.

auth_timeout_secs: Option<u64>

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

recv_window_ms: u64

Receive window in milliseconds for signed requests.

This value determines how far in the future the api-expires timestamp will be set for signed REST requests. BitMEX uses seconds-granularity Unix timestamps in the api-expires header, calculated as: current_timestamp + (recv_window_ms / 1000).

Note: This parameter is specified in milliseconds for consistency with other adapter configurations (e.g., Bybit’s recv_window_ms), but BitMEX only supports seconds-granularity timestamps. The value is converted via integer division, so 10000ms becomes 10 seconds, 15500ms becomes 15 seconds, etc.

A larger window provides more tolerance for clock skew and network latency, but increases the replay attack window. The default of 10 seconds should be sufficient for most deployments. Consider increasing this value (e.g., to 30000ms = 30s) if you experience request expiration errors due to clock drift or high network latency.

active_only: bool

When true, only active instruments are requested during bootstrap.

environment: BitmexEnvironment

BitMEX environment (mainnet or testnet).

account_id: Option<AccountId>

Optional account identifier to associate with the execution client.

max_requests_per_second: u32

Maximum number of requests per second (burst limit).

max_requests_per_minute: u32

Maximum number of requests per minute (rolling window).

submitter_pool_size: Option<usize>

Number of HTTP clients in the submit broadcaster pool (defaults to 1).

canceller_pool_size: Option<usize>

Number of HTTP clients in the cancel broadcaster pool (defaults to 1).

submitter_proxy_urls: Option<Vec<String>>

Optional list of proxy URLs for submit broadcaster pool (path diversity).

canceller_proxy_urls: Option<Vec<String>>

Optional list of proxy URLs for cancel broadcaster pool (path diversity).

deadmans_switch_timeout_secs: Option<u64>

Optional dead man’s switch timeout in seconds.

When set, a background task periodically calls the BitMEX cancelAllAfter endpoint to keep a server-side timer alive. If the client loses connectivity the timer expires and BitMEX cancels all open orders. Calling with timeout=0 disarms the switch. The refresh interval is derived as timeout / 4 (minimum 1 second).

transport_backend: TransportBackend

WebSocket transport backend (defaults to Tungstenite).

Implementations

impl BitmexExecutionClientConfig

pub fn builder() -> BitmexExecutionClientConfigBuilder

Create an instance of BitmexExecutionClientConfig using the builder syntax

impl BitmexExecutionClientConfig

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 (either explicitly set or resolvable from environment variables).

pub fn http_base_url(&self) -> String

Returns the REST base URL, considering overrides and the environment.

pub fn ws_url(&self) -> String

Returns the WebSocket URL, considering overrides and the environment.

Trait Implementations

impl ClientConfig for BitmexExecutionClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for BitmexExecutionClientConfig

fn clone(&self) -> BitmexExecutionClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitmexExecutionClientConfig

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

Formats the value using the given formatter.

impl Default for BitmexExecutionClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for BitmexExecutionClientConfig

impl<'de> Deserialize<'de> for BitmexExecutionClientConfig

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

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 BitmexExecutionClientConfig

type Target = BitmexExecutionClientConfig

The Python output type

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

const NAME: &str = "BitmexExecutionClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BitmexExecutionClientConfig

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

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

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 BitmexExecutionClientConfig

const TEXT_SIGNATURE: &'static str = "(api_key=None, api_secret=None, base_url_http=None, base_url_ws=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, active_only=None, environment=None, account_id=None, max_requests_per_second=None, max_requests_per_minute=None, submitter_pool_size=None, canceller_pool_size=None, submitter_proxy_urls=None, canceller_proxy_urls=None, deadmans_switch_timeout_secs=None, transport_backend=None)"

impl PyStubType for BitmexExecutionClientConfig

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 BitmexExecutionClientConfig

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 BitmexExecutionClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.