Struct OkxBuilder 

pub struct OkxBuilder { /* private fields */ }

Builder for creating OKX exchange instances.

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

Example

use ccxt_exchanges::okx::OkxBuilder;

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

Implementations

impl OkxBuilder

pub fn new() -> OkxBuilder

Creates a new builder with default configuration.

Example

use ccxt_exchanges::okx::OkxBuilder;

let builder = OkxBuilder::new();

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

Sets the API key for authentication.

Arguments

• key - The API key string.

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

Sets the API secret for authentication.

Arguments

• secret - The API secret string.

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

Sets the passphrase for authentication.

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

Arguments

• passphrase - The passphrase string.

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

Enables or disables sandbox/demo mode.

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

Arguments

• enabled - Whether to enable sandbox mode.

pub fn account_mode(self, mode: impl Into<String>) -> OkxBuilder

Sets the account mode for trading.

Valid values: “cash” (spot), “cross” (cross margin), “isolated” (isolated margin).

Arguments

• mode - The account mode string.

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

Sets the default market type for trading.

This determines which instrument type (instType) to use for API calls. OKX uses a unified V5 API, so this primarily affects market filtering.

Arguments

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

Example

use ccxt_exchanges::okx::OkxBuilder;
use ccxt_core::types::default_type::DefaultType;

let okx = OkxBuilder::new()
    .default_type(DefaultType::Swap)
    .build()
    .unwrap();

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

Sets the default sub-type for contract settlement.

• Linear: USDT-margined contracts
• Inverse: Coin-margined contracts

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

Arguments

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

Example

use ccxt_exchanges::okx::OkxBuilder;
use ccxt_core::types::default_type::{DefaultType, DefaultSubType};

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

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

Sets the request timeout.

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

Sets the request timeout in seconds (convenience method).

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

Sets the TCP connection timeout.

Arguments

• timeout - Connection timeout duration.

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

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

Arguments

• seconds - Connection timeout duration in seconds.

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

Sets the retry policy.

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

Enables or disables rate limiting.

Arguments

• enabled - Whether to enable rate limiting.

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

Sets the HTTP proxy configuration.

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

Sets the HTTP proxy URL (convenience method).

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

Enables or disables verbose logging.

Arguments

• enabled - Whether to enable verbose logging.

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

Sets a custom option.

Arguments

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

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

Sets multiple custom options.

Arguments

• options - HashMap of option key-value pairs.

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

Builds the OKX exchange instance.

Returns

Returns a Result containing the configured Okx instance.

Errors

Returns an error if the exchange cannot be initialized.

Trait Implementations

impl Clone for OkxBuilder

fn clone(&self) -> OkxBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OkxBuilder

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

Formats the value using the given formatter.

impl Default for OkxBuilder

fn default() -> OkxBuilder

Returns the “default value” for a type.