Struct BinanceBuilder 

pub struct BinanceBuilder { /* private fields */ }

Builder for creating Binance exchange instances.

Provides a fluent API for configuring all aspects of the Binance exchange, including authentication, connection settings, and Binance-specific options.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let binance = BinanceBuilder::new()
    .api_key("your-api-key")
    .secret("your-secret")
    .sandbox(true)
    .timeout(30)
    .build()
    .unwrap();

Implementations

impl BinanceBuilder

pub fn new() -> Self

Creates a new builder with default configuration.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new();

pub fn api_key(self, key: impl Into<String>) -> Self

Sets the API key for authentication.

Arguments

• key - The API key string.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new()
    .api_key("your-api-key");

pub fn secret(self, secret: impl Into<String>) -> Self

Sets the API secret for authentication.

Arguments

• secret - The API secret string.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new()
    .secret("your-secret");

pub fn sandbox(self, enabled: bool) -> Self

Enables or disables sandbox/testnet mode.

When enabled, the exchange will connect to Binance’s testnet instead of the production environment.

Arguments

• enabled - Whether to enable sandbox mode.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new()
    .sandbox(true);

pub fn timeout(self, timeout: Duration) -> Self

Sets the request timeout.

Arguments

• timeout - Timeout duration.

Example

use ccxt_exchanges::binance::BinanceBuilder;
use std::time::Duration;

let builder = BinanceBuilder::new()
    .timeout(Duration::from_secs(60));

pub fn timeout_secs(self, seconds: u64) -> Self

Sets the request timeout in seconds (convenience method).

Arguments

• seconds - Timeout duration in seconds.

pub fn connect_timeout(self, timeout: Duration) -> Self

Sets the TCP connection timeout.

Arguments

• timeout - Connection timeout duration.

Example

use ccxt_exchanges::binance::BinanceBuilder;
use std::time::Duration;

let builder = BinanceBuilder::new()
    .connect_timeout(Duration::from_secs(15));

pub fn connect_timeout_secs(self, seconds: u64) -> Self

Sets the TCP connection timeout in seconds (convenience method).

Arguments

• seconds - Connection timeout duration in seconds.

pub fn retry_policy(self, policy: RetryPolicy) -> Self

Sets the retry policy.

pub fn recv_window(self, millis: u64) -> Self

Sets the receive window for signed requests.

The receive window specifies how long a request is valid after the timestamp. Default is 5000 milliseconds.

Arguments

• millis - Receive window in milliseconds.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new()
    .recv_window(10000);

pub fn default_type(self, trading_type: impl Into<DefaultType>) -> Self

Sets the default trading type.

Accepts both DefaultType enum values and string values for backward compatibility. Valid string values: “spot”, “margin”, “swap”, “futures”, “option”. Legacy values “future” and “delivery” are also supported.

Arguments

• trading_type - The default trading type (DefaultType or string).

Example

use ccxt_exchanges::binance::BinanceBuilder;
use ccxt_core::types::default_type::DefaultType;

// Using DefaultType enum (recommended)
let builder = BinanceBuilder::new()
    .default_type(DefaultType::Swap);

// Using string (backward compatible)
let builder = BinanceBuilder::new()
    .default_type("swap");

pub fn default_sub_type(self, sub_type: DefaultSubType) -> Self

Sets the default sub-type for contract settlement.

• Linear: USDT-margined contracts (FAPI)
• Inverse: Coin-margined contracts (DAPI)

Only applicable when default_type is Swap, Futures, or Option.

Arguments

• sub_type - The default sub-type for contract settlement.

Example

use ccxt_exchanges::binance::BinanceBuilder;
use ccxt_core::types::default_type::{DefaultType, DefaultSubType};

let builder = BinanceBuilder::new()
    .default_type(DefaultType::Swap)
    .default_sub_type(DefaultSubType::Linear);

pub fn adjust_for_time_difference(self, enabled: bool) -> Self

Enables or disables time synchronization adjustment.

When enabled, the exchange will adjust for time differences between the local system and Binance servers.

Arguments

• enabled - Whether to enable time adjustment.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new()
    .adjust_for_time_difference(true);

pub fn time_sync_interval(self, seconds: u64) -> Self

Sets the time sync interval in seconds.

Controls how often the time offset is refreshed when auto sync is enabled. Default is 30 seconds.

Arguments

• seconds - Sync interval in seconds.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new()
    .time_sync_interval(60); // Sync every 60 seconds

pub fn auto_time_sync(self, enabled: bool) -> Self

Enables or disables automatic periodic time sync.

When enabled, the time offset will be automatically refreshed based on the configured sync interval. Default is true.

Arguments

• enabled - Whether to enable automatic time sync.

Example

use ccxt_exchanges::binance::BinanceBuilder;

// Disable automatic sync for manual control
let builder = BinanceBuilder::new()
    .auto_time_sync(false);

pub fn enable_rate_limit(self, enabled: bool) -> Self

Enables or disables rate limiting.

Arguments

• enabled - Whether to enable rate limiting.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new()
    .enable_rate_limit(true);

pub fn proxy(self, proxy: ProxyConfig) -> Self

Sets the HTTP proxy configuration.

Arguments

• proxy - The proxy configuration.

pub fn proxy_url(self, url: impl Into<String>) -> Self

Sets the HTTP proxy URL (convenience method).

Arguments

• url - The proxy server URL.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new()
    .proxy_url("http://proxy.example.com:8080");

pub fn verbose(self, enabled: bool) -> Self

Enables or disables verbose logging.

Arguments

• enabled - Whether to enable verbose logging.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new()
    .verbose(true);

pub fn option(self, key: impl Into<String>, value: Value) -> Self

Sets a custom option.

Arguments

• key - Option key.
• value - Option value as JSON.

Example

use ccxt_exchanges::binance::BinanceBuilder;
use serde_json::json;

let builder = BinanceBuilder::new()
    .option("customOption", json!("value"));

pub fn options(self, options: HashMap<String, Value>) -> Self

Sets multiple custom options.

Arguments

• options - HashMap of option key-value pairs.

Example

use ccxt_exchanges::binance::BinanceBuilder;
use serde_json::json;
use std::collections::HashMap;

let mut options = HashMap::new();
options.insert("option1".to_string(), json!("value1"));
options.insert("option2".to_string(), json!(42));

let builder = BinanceBuilder::new()
    .options(options);

pub fn build(self) -> Result<Binance>

Builds the Binance exchange instance.

Returns

Returns a Result containing the configured Binance instance.

Errors

Returns an error if the exchange cannot be initialized.

Example

use ccxt_exchanges::binance::BinanceBuilder;

let binance = BinanceBuilder::new()
    .api_key("your-api-key")
    .secret("your-secret")
    .build()
    .unwrap();

Trait Implementations

impl Clone for BinanceBuilder

fn clone(&self) -> BinanceBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinanceBuilder

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

Formats the value using the given formatter.

impl Default for BinanceBuilder

fn default() -> Self

Returns the “default value” for a type.