Struct BybitBuilder 

pub struct BybitBuilder { /* private fields */ }

Builder for creating Bybit exchange instances.

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

Example

use ccxt_exchanges::bybit::BybitBuilder;

let bybit = BybitBuilder::new()
    .api_key("your-api-key")
    .secret("your-secret")
    .testnet(true)
    .timeout(30)
    .build()
    .unwrap();

Implementations

impl BybitBuilder

pub fn new() -> BybitBuilder

Creates a new builder with default configuration.

Example

use ccxt_exchanges::bybit::BybitBuilder;

let builder = BybitBuilder::new();

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

Sets the API key for authentication.

Arguments

• key - The API key string.

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

Sets the API secret for authentication.

Arguments

• secret - The API secret string.

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

Enables or disables sandbox/testnet mode.

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

This method is equivalent to testnet() and is provided for consistency with other exchanges.

Arguments

• enabled - Whether to enable sandbox mode.

pub fn testnet(self, enabled: bool) -> BybitBuilder

Enables or disables testnet mode.

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

This method is equivalent to sandbox() and is provided for backward compatibility.

Arguments

• enabled - Whether to enable testnet mode.

pub fn account_type(self, account_type: impl Into<String>) -> BybitBuilder

Sets the account type for trading.

Valid values: “UNIFIED”, “CONTRACT”, “SPOT”.

Arguments

• account_type - The account type string.

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

Sets the default market type for trading.

This determines which category to use for API calls. Bybit uses a unified V5 API with category-based filtering:

• Spot -> category=spot
• Swap + Linear -> category=linear
• Swap + Inverse -> category=inverse
• Option -> category=option

Arguments

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

Example

use ccxt_exchanges::bybit::BybitBuilder;
use ccxt_core::types::default_type::DefaultType;

let bybit = BybitBuilder::new()
    .default_type(DefaultType::Swap)
    .build()
    .unwrap();

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

Sets the default sub-type for contract settlement.

• Linear: USDT-margined contracts (category=linear)
• Inverse: Coin-margined contracts (category=inverse)

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::bybit::BybitBuilder;
use ccxt_core::types::default_type::{DefaultType, DefaultSubType};

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

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

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 timeout(self, timeout: Duration) -> BybitBuilder

Sets the request timeout.

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

Sets the request timeout in seconds (convenience method).

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

Sets the TCP connection timeout.

Arguments

• timeout - Connection timeout duration.

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

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

Arguments

• seconds - Connection timeout duration in seconds.

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

Sets the retry policy.

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

Enables or disables rate limiting.

Arguments

• enabled - Whether to enable rate limiting.

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

Sets the HTTP proxy configuration.

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

Sets the HTTP proxy URL (convenience method).

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

Enables or disables verbose logging.

Arguments

• enabled - Whether to enable verbose logging.

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

Sets a custom option.

Arguments

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

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

Sets multiple custom options.

Arguments

• options - HashMap of option key-value pairs.

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

Builds the Bybit exchange instance.

Returns

Returns a Result containing the configured Bybit instance.

Errors

Returns an error if the exchange cannot be initialized.

Trait Implementations

impl Clone for BybitBuilder

fn clone(&self) -> BybitBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BybitBuilder

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

Formats the value using the given formatter.

impl Default for BybitBuilder

fn default() -> BybitBuilder

Returns the “default value” for a type.