Skip to main content

OKXExecutionClientConfig

Struct OKXExecutionClientConfig 

Source
pub struct OKXExecutionClientConfig {
Show 26 fields pub account_id: AccountId, pub oms_type: Option<OmsType>, pub api_key: Option<SecretString>, pub api_secret: Option<SecretString>, pub api_passphrase: Option<SecretString>, pub instrument_types: Vec<OKXInstrumentType>, pub contract_types: Option<Vec<OKXContractType>>, pub instrument_families: Option<Vec<String>>, pub environment: OKXEnvironment, pub region: OKXRegion, pub base_url_http: Option<String>, pub base_url_ws_private: Option<String>, pub base_url_ws_business: Option<String>, pub proxy_url: Option<SecretString>, pub http_timeout_secs: u64, pub load_spreads: 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 spot_trade_quote_ccy: Option<String>, pub auth_timeout_secs: Option<u64>, pub transport_backend: TransportBackend, pub max_reconciliation_history_pages: Option<u32>,
}
Expand description

Configuration for the OKX execution client.

Fields§

§account_id: AccountId

The account ID for the client.

§oms_type: Option<OmsType>

Optional OMS override for the client. Defaults to netting with any derivative instrument type, otherwise hedging.

§api_key: Option<SecretString>

Optional API key for authenticated endpoints.

§api_secret: Option<SecretString>

Optional API secret for authenticated endpoints.

§api_passphrase: Option<SecretString>

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 instrument discovery.

§instrument_families: Option<Vec<String>>

Instrument families to load (e.g., “BTC-USD”, “ETH-USD”). Required for OPTION; optional for FUTURES/SWAP. For EVENTS, values are series IDs. Filtered EVENTS and derivatives require separate clients. Ignored for SPOT/MARGIN.

§environment: OKXEnvironment

The API environment (live or demo).

§region: OKXRegion

The API region (global, EEA, or US).

§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<SecretString>

Optional proxy URL for HTTP and WebSocket transports.

§http_timeout_secs: u64

Timeout per HTTP attempt in seconds. The retry budget is the greater of this timeout and 180 seconds.

§load_spreads: bool

Whether to subscribe to spread order updates from the separate spread channel.

§use_mm_mass_cancel: bool

Selects MMP-only family cancellation, which is unsupported for ordinary orders. Must remain false; true fails validation.

§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. Selecting MARGIN in instrument_types also enables spot margin.

§spot_trade_quote_ccy: Option<String>

Optional SPOT tradeQuoteCcy override sent on order payloads.

Unset omits the field so OKX uses the quote currency in instId (USDC on Crypto-USDC instruments). Set to "USD" to keep trading in USD after the USD-to-USDC spot migration. The value must appear in that instrument’s tradeQuoteCcyList.

§auth_timeout_secs: Option<u64>

Optional WebSocket authentication timeout (seconds), defaulting to AUTHENTICATION_TIMEOUT_SECS when unset.

§transport_backend: TransportBackend

WebSocket transport backend (defaults to Sockudo).

§max_reconciliation_history_pages: Option<u32>

Maximum pages per startup reconciliation history query, capped at 50.

None keeps the default cap; Some(0) skips history. Pending orders, live algo orders, and positions are unaffected. Skipped or truncated history marks reports incomplete and reduces recovery coverage.

Implementations§

Source§

impl OKXExecutionClientConfig

Source

pub fn builder() -> OKXExecutionClientConfigBuilder

Create an instance of OKXExecutionClientConfig using the builder syntax

Source§

impl OKXExecutionClientConfig

Source

pub fn new() -> Self

Creates a new configuration with default settings.

Source

pub fn validate(&self) -> ConfigResult<()>

Validates instrument selections, cancellation support, and retry delays.

§Errors

Returns an error if selections are duplicated, blank, or conflicting, required settings are missing, retry delays are invalid, or MMP cancellation is enabled.

Source

pub fn has_api_credentials(&self) -> bool

Returns whether all credential fields have non-blank config or environment values. Explicit blank values do not fall back to environment variables.

Source

pub fn http_base_url(&self) -> String

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

Source

pub fn ws_private_url(&self) -> String

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

Source

pub fn ws_business_url(&self) -> String

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

Trait Implementations§

Source§

impl ClientConfig for OKXExecutionClientConfig

Source§

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.
Source§

impl Clone for OKXExecutionClientConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OKXExecutionClientConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OKXExecutionClientConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl DerefToPyAny for OKXExecutionClientConfig

Source§

impl<'de> Deserialize<'de> for OKXExecutionClientConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'a, 'py> FromPyObject<'a, 'py> for OKXExecutionClientConfig
where Self: Clone,

Source§

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error. Read more
Source§

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

Extracts Self from the bound smart pointer obj. Read more
Source§

impl<'py> IntoPyObject<'py> for OKXExecutionClientConfig

Source§

type Target = OKXExecutionClientConfig

The Python output type
Source§

type Output = Bound<'py, OKXExecutionClientConfig>

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

fn into_pyobject(self, py: Python<'py>) -> PyResult<Bound<'py, Self>>

Performs the conversion.
Source§

impl PyClass for OKXExecutionClientConfig

Source§

const NAME: &str = "OKXExecutionClientConfig"

Name of the class. Read more
Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for OKXExecutionClientConfig

Source§

const MODULE: Option<&str>

Module which the class will be associated with. Read more
Source§

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

Docstring for the class provided on the struct or enum. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

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

Description of how this class is laid out in memory
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = NoopThreadChecker

This handles following two situations: Read more
Source§

type Inventory = Pyo3MethodsInventoryForOKXExecutionClientConfig

Source§

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

Immutable or mutable
Source§

type Dict = PyClassDummySlot

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

type WeakRef = PyClassDummySlot

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

type BaseNativeType = PyAny

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

fn items_iter() -> PyClassItemsIter

Source§

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

Source§

fn __traverse__(&self, visit: PyVisit<'_>) -> Result<(), PyTraverseError>

§

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)]
§

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
Source§

impl PyClassNewTextSignature for OKXExecutionClientConfig

Source§

const TEXT_SIGNATURE: &'static str = "(account_id, instrument_types=None, environment=None, region=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, load_spreads=False, auth_timeout_secs=None, transport_backend=None, spot_trade_quote_ccy=None, oms_type=None, max_reconciliation_history_pages=None, instrument_families=None, contract_types=None, use_spot_margin=False)"

Source§

impl PyStubType for OKXExecutionClientConfig

Source§

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. Read more
Source§

impl PyTypeInfo for OKXExecutionClientConfig

Source§

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.
Source§

impl Serialize for OKXExecutionClientConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<'py, T> FromPyObjectOwned<'py> for T
where T: for<'a> FromPyObject<'a, 'py>,

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
§

impl<'py, T> IntoPyObjectNautilusExt<'py> for T
where T: IntoPyObjectExt<'py>,

§

fn into_py_any_unwrap(self, py: Python<'py>) -> Py<PyAny>
where Self: IntoPyObject<'py, Error = !>,

Converts self into a [Py<PyAny>] when the underlying conversion is infallible.
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

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

Checks if object is an instance of Self, which may include a subtype. Read more
§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more