Struct BalanceAndPositionUpdate 

#[non_exhaustive]
pub struct BalanceAndPositionUpdate {
    pub p_time: NumberString,
    pub event_type: String,
    pub bal_data: Vec<BalData>,
    pub pos_data: Vec<PosData>,
    pub trades: Vec<Trade>,
    pub extra: ExtraFields,
}

A data row pushed by the private balance_and_position WebSocket channel.

This channel provides near-real-time updates for account cash balances and positions. Updates may be triggered by events such as:

• order fills;
• funding transfers;
• delivery or exercise;
• liquidation or ADL;
• funding-fee deductions;
• margin or leverage adjustments.

A push may contain only BalanceAndPositionUpdate::bal_data when only a balance changes, or only BalanceAndPositionUpdate::pos_data when only a position changes.

During the initial snapshot, OKX only pushes:

• currencies whose cash balance is non-zero;
• positions whose quantity is non-zero.

OKX docs: https://www.okx.com/docs-v5/en/#trading-account-websocket-balance-and-position-channel

Fields (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.

p_time: NumberString

Push time of the balance and position information.

Unix timestamp in milliseconds, for example 1597026383085.

event_type: String

Event that caused this update.

• Typical values include: delivered, exercised, transferred, filled, liquidation claw_back, adl, funding_fee, adjust_margin,set_leverage interest_deduction, settlement

bal_data: Vec<BalData>

Updated account cash-balance records.

This array may be empty when the push only contains position changes.

pos_data: Vec<PosData>

Updated position records.

This array may be empty when the push only contains balance changes.

trades: Vec<Trade>

Trades associated with the balance or position update.

extra: ExtraFields

Additional fields added by OKX that are not yet represented explicitly.

Trait Implementations

impl Clone for BalanceAndPositionUpdate

fn clone(&self) -> BalanceAndPositionUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BalanceAndPositionUpdate

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

Formats the value using the given formatter.

impl Default for BalanceAndPositionUpdate

fn default() -> BalanceAndPositionUpdate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BalanceAndPositionUpdate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.