Struct BinanceBuilder

Source

pub struct BinanceBuilder { /* private fields */ }

Expand description

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§

Source §

impl BinanceBuilder

Source

pub fn new() -> BinanceBuilder

Creates a new builder with default configuration.

§Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new();

Source

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

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");

Source

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

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");

Source

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

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);

Source

pub fn timeout(self, seconds: u64) -> BinanceBuilder

Sets the request timeout in seconds.

§Arguments

seconds - Timeout duration in seconds.

§Example

use ccxt_exchanges::binance::BinanceBuilder;

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

Source

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

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);

Source

pub fn default_type(self, trading_type: impl Into<String>) -> BinanceBuilder

Sets the default trading type.

Valid values: “spot”, “margin”, “future”, “delivery”, “option”.

§Arguments

trading_type - The default trading type.

§Example

use ccxt_exchanges::binance::BinanceBuilder;

let builder = BinanceBuilder::new()
    .default_type("future");

Source

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

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);

Source

pub fn demo(self, enabled: bool) -> BinanceBuilder

Enables or disables demo environment.

§Arguments

enabled - Whether to enable demo mode.

§Example

use ccxt_exchanges::binance::BinanceBuilder;

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

Source

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

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);

Source

pub fn proxy(self, proxy: impl Into<String>) -> BinanceBuilder

Sets the HTTP proxy server URL.

§Arguments

proxy - The proxy server URL.

§Example

use ccxt_exchanges::binance::BinanceBuilder;

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

Source

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

Enables or disables verbose logging.

§Arguments

enabled - Whether to enable verbose logging.

§Example

use ccxt_exchanges::binance::BinanceBuilder;

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

Source

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

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"));

Source

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

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);

Source

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

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();