Skip to main content

AdvancedAlgoOrderUpdate

Struct AdvancedAlgoOrderUpdate 

Source
#[non_exhaustive]
pub struct AdvancedAlgoOrderUpdate {
Show 44 fields pub inst_type: String, pub inst_id: String, pub ccy: String, pub ord_id: String, pub algo_id: String, pub cl_ord_id: String, pub algo_cl_ord_id: String, pub ord_type: String, pub side: String, pub pos_side: String, pub td_mode: String, pub tgt_ccy: String, pub sz: NumberString, pub lever: NumberString, pub state: String, pub tp_trigger_px: NumberString, pub tp_ord_px: NumberString, pub sl_trigger_px: NumberString, pub sl_ord_px: NumberString, pub trigger_px: NumberString, pub ord_px: NumberString, pub actual_sz: NumberString, pub actual_px: NumberString, pub notional_usd: NumberString, pub tag: String, pub actual_side: String, pub trigger_time: NumberString, pub px_var: NumberString, pub px_spread: NumberString, pub sz_limit: NumberString, pub px_limit: NumberString, pub time_interval: NumberString, pub count: NumberString, pub callback_ratio: NumberString, pub callback_spread: NumberString, pub active_px: NumberString, pub move_trigger_px: NumberString, pub fail_code: String, pub reduce_only: String, pub trade_quote_ccy: String, pub is_trade_borrow_mode: Value, pub c_time: NumberString, pub p_time: NumberString, pub extra: ExtraFields,
}
Expand description

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§inst_type: String

Instrument type, e.g., SPOT, SWAP, FUTURES.

§inst_id: String

Instrument ID, e.g., BTC-USDT.

§ccy: String

Margin currency.

§ord_id: String

OKX-assigned order ID of the associated regular order.

§algo_id: String

OKX-assigned algo order ID.

§cl_ord_id: String

Client-supplied order ID.

§algo_cl_ord_id: String

Client-supplied algo order ID.

§ord_type: String

Advanced algo order type: iceberg or twap.

§side: String

Order side: buy or sell.

§pos_side: String

Position side: long, short, or net.

§td_mode: String

Trade mode: cross, isolated, or cash.

§tgt_ccy: String

Target currency for quantity: base_ccy or quote_ccy (spot market orders only).

§sz: NumberString

Total order size.

§lever: NumberString

Leverage.

§state: String

Order state.

Documented values: live, pause, partially_effective, effective, canceled, order_failed.

§tp_trigger_px: NumberString

Take-profit trigger price.

§tp_ord_px: NumberString

Take-profit order price.

§sl_trigger_px: NumberString

Stop-loss trigger price.

§sl_ord_px: NumberString

Stop-loss order price.

§trigger_px: NumberString

Trigger price.

§ord_px: NumberString

Limit price for each child order placed by the algo.

§actual_sz: NumberString

Size executed so far.

§actual_px: NumberString

Average fill price of executed child orders.

§notional_usd: NumberString

Estimated notional value in USD.

§tag: String

Order tag.

§actual_side: String

Effective side of executed child orders.

§trigger_time: NumberString

Trigger time (Unix milliseconds).

§px_var: NumberString

Price ratio (iceberg / twap orders).

§px_spread: NumberString

Price variance (iceberg / twap orders).

§sz_limit: NumberString

Average amount per child order (iceberg / twap orders).

§px_limit: NumberString

Price limit (iceberg / twap orders).

§time_interval: NumberString

Time interval between child orders (twap orders).

§count: NumberString

Total number of child orders placed (iceberg / twap orders).

§callback_ratio: NumberString

Trailing callback ratio (move_order_stop orders).

§callback_spread: NumberString

Trailing callback spread (move_order_stop orders).

§active_px: NumberString

Activated tracking price (move_order_stop orders).

§move_trigger_px: NumberString

Price that activated the trailing move trigger.

§fail_code: String

Error code when state is order_failed; empty otherwise.

§reduce_only: String

Whether the order can only reduce the position size: "true" or "false".

§trade_quote_ccy: String

The quote currency used for trading.

§is_trade_borrow_mode: Value

Whether borrowing currency automatically.

OKX sends a JSON boolean (true/false) for applicable order types; uses Value to accommodate any future variation.

§c_time: NumberString

Algo order creation time (Unix milliseconds).

§p_time: NumberString

Push time (Unix milliseconds).

§extra: ExtraFields

Unrecognized fields retained for forward compatibility.

Trait Implementations§

Source§

impl Clone for AdvancedAlgoOrderUpdate

Source§

fn clone(&self) -> AdvancedAlgoOrderUpdate

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 AdvancedAlgoOrderUpdate

Source§

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

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

impl Default for AdvancedAlgoOrderUpdate

Source§

fn default() -> AdvancedAlgoOrderUpdate

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

impl<'de> Deserialize<'de> for AdvancedAlgoOrderUpdate

Source§

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

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

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

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

Source§

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.

Source§

impl<T> Instrument for T

Source§

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

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

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> PolicyExt for T
where T: ?Sized,

Source§

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

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

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

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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