Struct OKXExecClientConfig 

pub struct OKXExecClientConfig {

    pub trader_id: TraderId,
    pub account_id: AccountId,
    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_private: Option<String>,
    pub base_url_ws_business: Option<String>,
    pub proxy_url: Option<String>,
    pub environment: OKXEnvironment,
    pub http_timeout_secs: u64,
    pub use_fills_channel: bool,
    pub use_mm_mass_cancel: bool,
    pub max_retries: u32,
    pub retry_delay_initial_ms: u64,
    pub retry_delay_max_ms: u64,
    pub margin_mode: Option<OKXMarginMode>,
    pub use_spot_margin: bool,
    pub transport_backend: TransportBackend,
}

Configuration for the OKX execution client.

Fields

trader_id: TraderId

The trader ID for the client.

account_id: AccountId

The account ID for the client.

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 the execution client should support.

contract_types: Option<Vec<OKXContractType>>

Contract type filter applied to operations.

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_private: Option<String>

Optional override for the private 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.

use_fills_channel: bool

Enables consumption of the fills WebSocket channel when true.

use_mm_mass_cancel: bool

Enables mass-cancel support when true.

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.

margin_mode: Option<OKXMarginMode>

Optional margin mode (CROSS or ISOLATED) for margin/derivative accounts.

use_spot_margin: bool

Enables margin/leverage for SPOT trading when true.

transport_backend: TransportBackend

WebSocket transport backend (defaults to Tungstenite).

Implementations

impl OKXExecClientConfig

pub fn builder() -> OKXExecClientConfigBuilder

Create an instance of OKXExecClientConfig using the builder syntax

impl OKXExecClientConfig

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_private_url(&self) -> String

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

pub fn ws_business_url(&self) -> String

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

Trait Implementations

impl ClientConfig for OKXExecClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for OKXExecClientConfig

fn clone(&self) -> OKXExecClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OKXExecClientConfig

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

Formats the value using the given formatter.

impl Default for OKXExecClientConfig

fn default() -> Self

Returns the “default value” for a type.

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

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 OKXExecClientConfig

type Target = OKXExecClientConfig

The Python output type

type Output = Bound<'py, <OKXExecClientConfig 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 OKXExecClientConfig

const NAME: &str = "OKXExecClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for OKXExecClientConfig

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 execution 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 = <<OKXExecClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<OKXExecClientConfig>

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 = Pyo3MethodsInventoryForOKXExecClientConfig

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 OKXExecClientConfig

const TEXT_SIGNATURE: &'static str = "(trader_id, account_id, instrument_types=None, environment=None, api_key=None, api_secret=None, api_passphrase=None, base_url_http=None, base_url_ws_private=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, margin_mode=None)"

impl PyStubType for OKXExecClientConfig

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 OKXExecClientConfig

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 OKXExecClientConfig