Struct OKXDataClientConfig 

pub struct OKXDataClientConfig {

    pub api_key: Option<String>,
    pub api_secret: Option<String>,
    pub api_passphrase: Option<String>,
    pub instrument_types: Vec<OKXInstrumentType>,
    pub contract_types: Option<Vec<OKXContractType>>,
    pub instrument_families: Option<Vec<String>>,
    pub base_url_http: Option<String>,
    pub base_url_ws_public: Option<String>,
    pub base_url_ws_business: Option<String>,
    pub is_demo: bool,
    pub http_timeout_secs: Option<u64>,
    pub max_retries: Option<u32>,
    pub retry_delay_initial_ms: Option<u64>,
    pub retry_delay_max_ms: Option<u64>,
    pub update_instruments_interval_mins: Option<u64>,
    pub vip_level: Option<OKXVipLevel>,
}

Configuration for the OKX data client.

Fields

api_key: Option<String>

Optional API key for authenticated endpoints.

api_secret: Option<String>

Optional API secret for authenticated endpoints.

api_passphrase: Option<String>

Optional API passphrase for authenticated endpoints.

instrument_types: Vec<OKXInstrumentType>

Instrument types to load and subscribe to.

contract_types: Option<Vec<OKXContractType>>

Contract type filter applied to loaded instruments.

instrument_families: Option<Vec<String>>

Instrument families to load (e.g., “BTC-USD”, “ETH-USD”). Required for OPTIONS. Optional for FUTURES/SWAP. Not applicable for SPOT/MARGIN.

base_url_http: Option<String>

Optional override for the HTTP base URL.

base_url_ws_public: Option<String>

Optional override for the public WebSocket URL.

base_url_ws_business: Option<String>

Optional override for the business WebSocket URL.

is_demo: bool

When true the client will use OKX demo endpoints.

http_timeout_secs: Option<u64>

Optional HTTP timeout in seconds.

max_retries: Option<u32>

Optional maximum retry attempts for requests.

retry_delay_initial_ms: Option<u64>

Optional initial retry delay in milliseconds.

retry_delay_max_ms: Option<u64>

Optional maximum retry delay in milliseconds.

update_instruments_interval_mins: Option<u64>

Optional interval for refreshing instruments.

vip_level: Option<OKXVipLevel>

Optional VIP level that unlocks additional subscriptions.

Implementations

impl OKXDataClientConfig

pub fn new() -> Self

Creates a new configuration with default settings.

pub fn has_api_credentials(&self) -> bool

Returns true when all API credential fields are populated.

pub fn http_base_url(&self) -> String

Returns the HTTP base URL, falling back to the default when unset.

pub fn ws_public_url(&self) -> String

Returns the public WebSocket URL, respecting the demo flag and overrides.

pub fn ws_business_url(&self) -> String

Returns the business WebSocket URL, respecting the demo flag and overrides.

pub fn requires_business_ws(&self) -> bool

Returns true when the business WebSocket should be instantiated.

Trait Implementations

impl Clone for OKXDataClientConfig

fn clone(&self) -> OKXDataClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OKXDataClientConfig

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

Formats the value using the given formatter.

impl Default for OKXDataClientConfig

fn default() -> Self

Returns the “default value” for a type.