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 proxy_url: Option<String>,
    pub environment: OKXEnvironment,
    pub http_timeout_secs: u64,
    pub max_retries: u32,
    pub retry_delay_initial_ms: u64,
    pub retry_delay_max_ms: u64,
    pub update_instruments_interval_mins: u64,
    pub vip_level: Option<OKXVipLevel>,
    pub transport_backend: TransportBackend,
}

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.

proxy_url: Option<String>

Optional proxy URL for HTTP and WebSocket transports.

environment: OKXEnvironment

The API environment (live or demo).

http_timeout_secs: u64

HTTP timeout in seconds.

max_retries: u32

Maximum retry attempts for requests.

retry_delay_initial_ms: u64

Initial retry delay in milliseconds.

retry_delay_max_ms: u64

Maximum retry delay in milliseconds.

update_instruments_interval_mins: u64

Interval for refreshing instruments in minutes.

vip_level: Option<OKXVipLevel>

Optional VIP level that unlocks additional subscriptions.

transport_backend: TransportBackend

WebSocket transport backend (defaults to Tungstenite).

Implementations

impl OKXDataClientConfig

pub fn builder() -> OKXDataClientConfigBuilder

Create an instance of OKXDataClientConfig using the builder syntax

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 available (in config or env vars).

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 environment and overrides.

pub fn ws_business_url(&self) -> String

Returns the business WebSocket URL, respecting the environment and overrides.

pub fn requires_business_ws(&self) -> bool

Returns true when the business WebSocket should be instantiated.

The business WebSocket carries public candle data and does not require authentication, so it is always needed.

Trait Implementations

impl ClientConfig for OKXDataClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

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.

impl<'a, 'py> FromPyObject<'a, 'py> for OKXDataClientConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for OKXDataClientConfig

type Target = OKXDataClientConfig

The Python output type

type Output = Bound<'py, <OKXDataClientConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for OKXDataClientConfig

const NAME: &str = "OKXDataClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for OKXDataClientConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Configuration for the OKX data client.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<OKXDataClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<OKXDataClientConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForOKXDataClientConfig

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for OKXDataClientConfig

const TEXT_SIGNATURE: &'static str = "(instrument_types=None, environment=None, api_key=None, api_secret=None, api_passphrase=None, base_url_http=None, base_url_ws_public=None, base_url_ws_business=None, proxy_url=None, http_timeout_secs=None, max_retries=None, retry_delay_initial_ms=None, retry_delay_max_ms=None, update_instruments_interval_mins=None, vip_level=None)"

impl PyStubType for OKXDataClientConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for OKXDataClientConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for OKXDataClientConfig