Struct BitgetBuilder 

pub struct BitgetBuilder { /* private fields */ }

Builder for creating Bitget exchange instances.

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

Example

use ccxt_exchanges::bitget::BitgetBuilder;

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

Implementations

impl BitgetBuilder

pub fn new() -> BitgetBuilder

Creates a new builder with default configuration.

Example

use ccxt_exchanges::bitget::BitgetBuilder;

let builder = BitgetBuilder::new();

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

Sets the API key for authentication.

Arguments

• key - The API key string.

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

Sets the API secret for authentication.

Arguments

• secret - The API secret string.

pub fn passphrase(self, passphrase: impl Into<String>) -> BitgetBuilder

Sets the passphrase for authentication.

Bitget requires a passphrase in addition to API key and secret.

Arguments

• passphrase - The passphrase string.

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

Enables or disables sandbox/demo mode.

When enabled, the exchange will connect to Bitget’s demo environment instead of the production environment.

Arguments

• enabled - Whether to enable sandbox mode.

pub fn product_type(self, product_type: impl Into<String>) -> BitgetBuilder

Sets the product type for trading.

Valid values: “spot”, “umcbl” (USDT-M futures), “dmcbl” (Coin-M futures).

Note: Consider using default_type() and default_sub_type() instead for a more type-safe configuration.

Arguments

• product_type - The product type string.

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

Sets the default market type for trading.

This determines which product type to use for API calls. Bitget uses product_type-based filtering:

• Spot -> product_type=spot
• Swap + Linear -> product_type=umcbl (USDT-M)
• Swap + Inverse -> product_type=dmcbl (Coin-M)
• Futures + Linear -> product_type=umcbl (USDT-M futures)
• Futures + Inverse -> product_type=dmcbl (Coin-M futures)

Arguments

• default_type - The default market type (spot, swap, futures, margin, option).

Example

use ccxt_exchanges::bitget::BitgetBuilder;
use ccxt_core::types::default_type::DefaultType;

let bitget = BitgetBuilder::new()
    .default_type(DefaultType::Swap)
    .build()
    .unwrap();

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

Sets the default sub-type for contract settlement.

• Linear: USDT-margined contracts (product_type=umcbl)
• Inverse: Coin-margined contracts (product_type=dmcbl)

Only applicable when default_type is Swap or Futures. Ignored for Spot and Option types.

Arguments

• sub_type - The contract settlement type (linear or inverse).

Example

use ccxt_exchanges::bitget::BitgetBuilder;
use ccxt_core::types::default_type::{DefaultType, DefaultSubType};

let bitget = BitgetBuilder::new()
    .default_type(DefaultType::Swap)
    .default_sub_type(DefaultSubType::Linear)
    .build()
    .unwrap();

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

Sets the request timeout.

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

Sets the request timeout in seconds (convenience method).

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

Sets the TCP connection timeout.

Arguments

• timeout - Connection timeout duration.

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

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

Arguments

• seconds - Connection timeout duration in seconds.

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

Sets the retry policy.

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

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.

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

Enables or disables rate limiting.

Arguments

• enabled - Whether to enable rate limiting.

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

Sets the HTTP proxy configuration.

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

Sets the HTTP proxy URL (convenience method).

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

Enables or disables verbose logging.

Arguments

• enabled - Whether to enable verbose logging.

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

Sets a custom option.

Arguments

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

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

Sets multiple custom options.

Arguments

• options - HashMap of option key-value pairs.

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

Builds the Bitget exchange instance.

Returns

Returns a Result containing the configured Bitget instance.

Errors

Returns an error if the exchange cannot be initialized.

Trait Implementations

impl Clone for BitgetBuilder

fn clone(&self) -> BitgetBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitgetBuilder

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

Formats the value using the given formatter.

impl Default for BitgetBuilder

fn default() -> BitgetBuilder

Returns the “default value” for a type.