Skip to main content

AccountBalanceUpdate

rust_okx::ws::model::account

Struct AccountBalanceUpdate 

Source 
#[non_exhaustive]
pub struct AccountBalanceUpdate {
Show 49 fields
    pub auto_lend_status: String,
    pub auto_lend_mt_amt: NumberString,
    pub avail_bal: NumberString,
    pub avail_eq: NumberString,
    pub borrow_froz: NumberString,
    pub cash_bal: NumberString,
    pub ccy: String,
    pub coin_usd_price: NumberString,
    pub cross_liab: NumberString,
    pub col_res: String,
    pub collateral_enabled: bool,
    pub col_borr_auto_conversion: String,
    pub dis_eq: NumberString,
    pub eq: NumberString,
    pub eq_usd: NumberString,
    pub smt_sync_eq: NumberString,
    pub spot_copy_trading_eq: NumberString,
    pub fixed_bal: NumberString,
    pub frozen_bal: NumberString,
    pub frp_type: String,
    pub imr: NumberString,
    pub interest: NumberString,
    pub iso_eq: NumberString,
    pub iso_liab: NumberString,
    pub iso_upl: NumberString,
    pub liab: NumberString,
    pub max_loan: NumberString,
    pub mgn_ratio: NumberString,
    pub mmr: NumberString,
    pub notional_lever: NumberString,
    pub ord_frozen: NumberString,
    pub reward_bal: NumberString,
    pub spot_in_use_amt: NumberString,
    pub cl_spot_in_use_amt: NumberString,
    pub max_spot_in_use_amt: NumberString,
    pub spot_iso_bal: NumberString,
    pub stgy_eq: NumberString,
    pub twap: NumberString,
    pub u_time: NumberString,
    pub upl: NumberString,
    pub upl_liab: NumberString,
    pub spot_bal: NumberString,
    pub open_avg_px: NumberString,
    pub acc_avg_px: NumberString,
    pub spot_upl: NumberString,
    pub spot_upl_ratio: NumberString,
    pub total_pnl: NumberString,
    pub total_pnl_ratio: NumberString,
    pub extra: ExtraFields,

}
Expand description

Per-currency account data contained in AccountUpdate::details.

Fields that do not apply to the current account mode are commonly returned by OKX as empty strings.

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

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.
§auto_lend_status: String

Auto-lending status for this currency.

Documented values:

  • unsupported: auto lending is unsupported;
  • off: supported but disabled;
  • pending: enabled and waiting for matching;
  • active: enabled and matched.
§auto_lend_mt_amt: NumberString

Amount of the currency currently matched for auto lending.

Returns zero when Self::auto_lend_status is unsupported, off, or pending.

§avail_bal: NumberString

Available balance of the currency.

§avail_eq: NumberString

Available equity of the currency.

Applicable to Futures mode, Multi-currency margin mode and Portfolio margin mode.

§borrow_froz: NumberString

Potential borrowing initial margin requirement for this currency in USD.

§cash_bal: NumberString

Cash balance of the currency.

§ccy: String

Currency code, for example BTC or USDT.

§coin_usd_price: NumberString

USD price index of the currency.

§cross_liab: NumberString

Cross-margin liabilities of the currency.

§col_res: String

Platform-level collateral restriction status.

Documented values:

  • "0": no restriction;
  • "1": close to the platform collateral limit;
  • "2": restriction enabled; the currency cannot provide margin for new orders.
§collateral_enabled: bool

Whether this currency is enabled as collateral.

Primarily applicable to Multi-currency margin mode.

§col_borr_auto_conversion: String

Auto-conversion risk indicator.

Documented levels range from "0" through "5":

  • "0": no current auto-conversion risk;
  • "1" to "3": increasing risk;
  • "4": auto conversion may occur soon;
  • "5": auto conversion is in progress.
§dis_eq: NumberString

Discounted equity of the currency in USD.

§eq: NumberString

Total equity of the currency.

§eq_usd: NumberString

Equity of the currency denominated in USD.

§smt_sync_eq: NumberString

Smart-sync equity.

The default is zero and the field is only applicable to copy traders.

§spot_copy_trading_eq: NumberString

Spot smart-sync copy-trading equity.

The default is zero and the field is only applicable to copy traders.

§fixed_bal: NumberString

Balance frozen for Dip Sniper and Peak Sniper products.

§frozen_bal: NumberString

Frozen balance of the currency.

§frp_type: String

Forced-repayment type.

Documented values:

  • "0": no forced repayment;
  • "1": user-based forced repayment;
  • "2": platform-based forced repayment.
§imr: NumberString

Currency-level cross initial margin requirement.

§interest: NumberString

Accrued interest for this currency.

§iso_eq: NumberString

Isolated-margin equity of the currency.

§iso_liab: NumberString

Isolated liabilities of the currency.

§iso_upl: NumberString

Isolated unrealized profit and loss of the currency.

§liab: NumberString

Total liabilities of the currency.

OKX represents liabilities as a positive value.

§max_loan: NumberString

Maximum amount of this currency that can currently be borrowed.

§mgn_ratio: NumberString

Cross-maintenance-margin ratio of the currency.

§mmr: NumberString

Currency-level cross maintenance margin requirement.

§notional_lever: NumberString

Leverage calculated at the currency level.

Applicable to Futures mode.

§ord_frozen: NumberString

Margin frozen by open orders for this currency.

§reward_bal: NumberString

Trial-fund balance.

§spot_in_use_amt: NumberString

Actual spot-hedging amount currently in use.

Applicable to Portfolio margin mode.

§cl_spot_in_use_amt: NumberString

User-defined spot-hedging amount.

Applicable to Portfolio margin mode.

§max_spot_in_use_amt: NumberString

Maximum spot-hedging amount calculated by OKX.

Applicable to Portfolio margin mode.

The exact JSON field is maxSpotInUseAmt.

§spot_iso_bal: NumberString

Spot balance obtained through copy trading.

This includes amounts currently frozen by copy-trading open orders.

§stgy_eq: NumberString

Total equity assigned to trading-bot strategies for this currency.

§twap: NumberString

Forced-repayment risk indicator.

Values range from zero through five. A larger value indicates a higher probability that forced repayment will be triggered.

§u_time: NumberString

Time when this currency entry was last updated.

Unix timestamp in milliseconds.

§upl: NumberString

Unrealized profit and loss for margin and derivative positions of this currency.

§upl_liab: NumberString

Liabilities caused by unrealized losses of this currency.

§spot_bal: NumberString

Spot balance.

The unit is the currency itself, for example BTC.

§open_avg_px: NumberString

Average acquisition price of the current spot balance in USD.

This is a single JSON string, not an array.

§acc_avg_px: NumberString

Accumulated average acquisition price of the spot balance in USD.

This is a single JSON string, not an array.

§spot_upl: NumberString

Spot unrealized profit and loss in USD.

§spot_upl_ratio: NumberString

Spot unrealized profit and loss ratio.

§total_pnl: NumberString

Accumulated spot profit and loss in USD.

§total_pnl_ratio: NumberString

Accumulated spot profit and loss ratio.

§extra: ExtraFields

Additional per-currency fields introduced by OKX that are not yet represented explicitly.

Trait Implementations§

Source§

impl Clone for AccountBalanceUpdate

Source§

fn clone(&self) -> AccountBalanceUpdate

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 AccountBalanceUpdate

Source§

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

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

impl Default for AccountBalanceUpdate

Source§

fn default() -> AccountBalanceUpdate

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

impl<'de> Deserialize<'de> for AccountBalanceUpdate

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