Struct BinanceExecutionClientConfig 

pub struct BinanceExecutionClientConfig {

    pub account_id: AccountId,
    pub product_type: BinanceProductType,
    pub environment: BinanceEnvironment,
    pub base_url_http: Option<String>,
    pub base_url_ws: Option<String>,
    pub base_url_ws_trading: Option<String>,
    pub use_ws_trading: bool,
    pub ws_trading_setup_timeout_ms: u64,
    pub instrument_provider: BinanceInstrumentProviderConfig,
    pub instrument_refresh_interval_secs: u64,
    pub use_gtd: bool,
    pub use_position_ids: bool,
    pub oms_type: Option<OmsType>,
    pub default_taker_fee: Decimal,
    pub proxy_url: Option<String>,
    pub recv_window_ms: u64,
    pub us: bool,
    pub api_key: Option<String>,
    pub api_secret: Option<String>,
    pub futures_leverages: Option<HashMap<String, u32>>,
    pub futures_margin_types: Option<HashMap<String, BinanceMarginType>>,
    pub bnfcr_currency: Currency,
    pub treat_expired_as_canceled: bool,
    pub use_trade_lite: bool,
    pub transport_backend: TransportBackend,
}

Configuration for Binance execution client.

Global execution uses WebSocket API authentication with Ed25519 credentials. Binance US uses HMAC-signed HTTP requests and listen-key user data streams.

Fields

account_id: AccountId

Account ID for the client.

product_type: BinanceProductType

Product type to trade.

environment: BinanceEnvironment

Environment (live, testnet, or demo).

base_url_http: Option<String>

Optional base URL override for HTTP API.

base_url_ws: Option<String>

Optional base URL override for WebSocket user data stream.

Live USD-M Futures stream overrides are normalized onto the /private/ws route.

base_url_ws_trading: Option<String>

Optional base URL override for WebSocket trading API (Spot and USD-M Futures).

use_ws_trading: bool

Whether to use the WebSocket trading API for order operations (Spot and USD-M Futures).

ws_trading_setup_timeout_ms: u64

Timeout in milliseconds for each Binance Spot WS trading setup response.

instrument_provider: BinanceInstrumentProviderConfig

Instrument loading and fee configuration.

instrument_refresh_interval_secs: u64

Interval in seconds for refreshing the execution instrument cache.

Set to 0 to disable. Defaults to 3600 (60 minutes).

use_gtd: bool

Whether to use Binance-native GTD orders.

Set to false only when the strategy manages GTD expiry locally. The adapter then maps GTD to GTC and the strategy must enable manage_gtd_expiry.

use_position_ids: bool

Whether to use canonical Binance Futures position IDs.

When true, Futures hedge-mode order and fill reports include a venue_position_id derived from the instrument and Binance position side (e.g. ETHUSDT-PERP.BINANCE-LONG). Hedge-mode REST position reports use the same IDs. One-way BOTH reports remain unkeyed. When false, venue_position_id is None, allowing virtual positions with OmsType::Hedging.

oms_type: Option<OmsType>

Optional OMS type override for Binance Futures accounts.

Set to Hedging when the account uses dual-side position mode. When None, Binance Futures clients use Netting. Ignored for Spot clients.

default_taker_fee: Decimal

Default taker fee rate for commission estimation.

Used as a fallback when the venue omits commission fields in exchange-generated fills (liquidation, ADL, settlement). Standard Binance Futures taker fee is 0.0004 (0.04%).

proxy_url: Option<String>

Optional proxy URL for HTTP and WebSocket transports.

recv_window_ms: u64

Receive window in milliseconds for signed HTTP requests.

us: bool

Whether to route this Spot client to Binance US.

api_key: Option<String>

API key (uses an environment variable if not provided).

api_secret: Option<String>

API secret (Ed25519 for Global or HMAC for Binance US).

futures_leverages: Option<HashMap<String, u32>>

Initial leverage per Binance symbol (e.g. BTCUSDT -> 20), applied during connect.

futures_margin_types: Option<HashMap<String, BinanceMarginType>>

Margin type per Binance symbol (e.g. BTCUSDT -> Cross), applied during connect.

bnfcr_currency: Currency

Currency that Binance Futures Credits (BNFCR) balances and fees resolve to (defaults to USDT).

treat_expired_as_canceled: bool

If true, the EXPIRED execution type emits OrderCanceled instead of OrderExpired.

Binance uses EXPIRED for certain cancel scenarios depending on order type and time-in-force combination.

use_trade_lite: bool

If true, drive fills from the lower-latency TRADE_LITE user data event and dedup the matching fill portion of ORDER_TRADE_UPDATE. If false, TRADE_LITE events are ignored and fills come from ORDER_TRADE_UPDATE.

transport_backend: TransportBackend

WebSocket transport backend (defaults to Tungstenite).

Implementations

impl BinanceExecutionClientConfig

pub fn builder() -> BinanceExecutionClientConfigBuilder

Create an instance of BinanceExecutionClientConfig using the builder syntax

impl BinanceExecutionClientConfig

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

Validates Binance execution client configuration.

Errors

Returns an error for invalid receive-window, WS trading setup timeout, provider, or Binance US settings.

Trait Implementations

impl ClientConfig for BinanceExecutionClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for BinanceExecutionClientConfig

fn clone(&self) -> BinanceExecutionClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinanceExecutionClientConfig

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

Formats the value using the given formatter.

impl Default for BinanceExecutionClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for BinanceExecutionClientConfig

impl<'de> Deserialize<'de> for BinanceExecutionClientConfig

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

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 BinanceExecutionClientConfig

type Target = BinanceExecutionClientConfig

The Python output type

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

const NAME: &str = "BinanceExecutionClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BinanceExecutionClientConfig

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 Binance execution client. /// /// Global execution uses WebSocket API authentication with Ed25519 credentials. /// Binance US uses HMAC-signed HTTP requests and listen-key user data streams.

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

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

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 BinanceExecutionClientConfig

const TEXT_SIGNATURE: &'static str = "(account_id, product_type=None, environment=None, base_url_http=None, base_url_ws=None, base_url_ws_trading=None, use_ws_trading=True, ws_trading_setup_timeout_ms=None, instrument_provider=None, instrument_refresh_interval_secs=None, use_gtd=True, use_position_ids=True, oms_type=None, default_taker_fee=None, proxy_url=None, recv_window_ms=None, us=False, api_key=None, api_secret=None, futures_leverages=None, futures_margin_types=None, treat_expired_as_canceled=False, use_trade_lite=False, bnfcr_currency=None, transport_backend=None)"

impl PyStubType for BinanceExecutionClientConfig

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 BinanceExecutionClientConfig

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 BinanceExecutionClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.