Struct InstrumentUpdate 

#[non_exhaustive]
pub struct InstrumentUpdate {

    pub inst_type: String,
    pub series_id: String,
    pub inst_id: String,
    pub inst_id_code: NumberString,
    pub uly: String,
    pub inst_family: String,
    pub category: String,
    pub base_ccy: String,
    pub quote_ccy: String,
    pub settle_ccy: String,
    pub ct_val: NumberString,
    pub ct_mult: NumberString,
    pub ct_val_ccy: String,
    pub opt_type: String,
    pub stk: NumberString,
    pub list_time: NumberString,
    pub cont_td_sw_time: NumberString,
    pub pre_mkt_sw_time: NumberString,
    pub exp_time: NumberString,
    pub lever: NumberString,
    pub tick_sz: NumberString,
    pub lot_sz: NumberString,
    pub min_sz: NumberString,
    pub ct_type: String,
    pub alias: String,
    pub state: String,
    pub open_type: String,
    pub rule_type: String,
    pub max_lmt_sz: NumberString,
    pub max_lmt_amt: NumberString,
    pub max_mkt_sz: NumberString,
    pub max_mkt_amt: NumberString,
    pub max_twap_sz: NumberString,
    pub max_iceberg_sz: NumberString,
    pub max_trigger_sz: NumberString,
    pub max_stop_sz: NumberString,
    pub auction_end_time: NumberString,
    pub future_settlement: bool,
    pub trade_quote_ccy_list: Vec<String>,
    pub inst_category: String,
    pub pos_lmt_amt: NumberString,
    pub pos_lmt_pct: NumberString,
    pub long_pos_remaining_quota: NumberString,
    pub short_pos_remaining_quota: NumberString,
    pub max_plat_oi_lmt: NumberString,
    pub group_id: String,
    pub upc_chg: Vec<InstrumentUpcomingParamChange>,
    pub extra: ExtraFields,
}

Public-data instruments channel row.

OKX docs: https://www.okx.com/docs-v5/en/#order-book-trading-public-data-ws-instruments-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.

inst_type: String

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

series_id: String

Series ID (event contracts only).

inst_id: String

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

inst_id_code: NumberString

Internal numeric code for the instrument.

uly: String

Underlying index, e.g., BTC-USD (derivatives only).

inst_family: String

Instrument family, e.g., BTC-USD (derivatives only).

category: String

Fee schedule category.

base_ccy: String

Base currency, e.g., BTC (SPOT/MARGIN only).

quote_ccy: String

Quote currency, e.g., USDT (SPOT/MARGIN only).

settle_ccy: String

Settlement currency (derivatives only).

ct_val: NumberString

Contract value (derivatives only).

ct_mult: NumberString

Contract multiplier (derivatives only).

ct_val_ccy: String

Currency of the contract value (derivatives only).

opt_type: String

Option type: C (call) or P (put). Empty for non-option instruments.

stk: NumberString

Strike price (options only).

list_time: NumberString

Listing time (Unix milliseconds).

cont_td_sw_time: NumberString

Time at which the instrument transitions to continuous trading (Unix milliseconds).

pre_mkt_sw_time: NumberString

Pre-market trading start time (Unix milliseconds).

exp_time: NumberString

Expiry/delivery time (Unix milliseconds); empty for perpetuals.

lever: NumberString

Maximum leverage available.

tick_sz: NumberString

Tick size (minimum price increment).

lot_sz: NumberString

Lot size (minimum order size increment).

min_sz: NumberString

Minimum order size.

ct_type: String

Contract type: linear or inverse (derivatives only).

alias: String

Delivery alias: this_week, next_week, quarter, next_quarter.

state: String

Instrument state.

Documented values: live, suspend, preopen, settlement.

open_type: String

Open interest limit type.

Documented values: normal (no limit), limited.

rule_type: String

Applicable trading rules: normal, pre_market.

max_lmt_sz: NumberString

Maximum limit order size.

max_lmt_amt: NumberString

Maximum limit order amount in USD.

max_mkt_sz: NumberString

Maximum market order size.

max_mkt_amt: NumberString

Maximum market order amount in USD.

max_twap_sz: NumberString

Maximum TWAP order size.

max_iceberg_sz: NumberString

Maximum iceberg order size.

max_trigger_sz: NumberString

Maximum trigger order size.

max_stop_sz: NumberString

Maximum stop order size.

auction_end_time: NumberString

Call-auction end time (Unix milliseconds); empty when not in auction.

future_settlement: bool

Whether futures settlement is enabled for this instrument.

trade_quote_ccy_list: Vec<String>

List of supported quote currencies for this instrument.

inst_category: String

Instrument sub-category.

pos_lmt_amt: NumberString

Maximum total position size (USD amount).

pos_lmt_pct: NumberString

Maximum position size as a percentage of total open interest.

long_pos_remaining_quota: NumberString

Remaining long-position quota for this instrument.

short_pos_remaining_quota: NumberString

Remaining short-position quota for this instrument.

max_plat_oi_lmt: NumberString

Maximum platform-wide open-interest limit.

group_id: String

Instrument group ID.

upc_chg: Vec<InstrumentUpcomingParamChange>

Upcoming parameter changes scheduled for this instrument.

extra: ExtraFields

Unrecognized fields retained for forward compatibility.

Trait Implementations

impl Clone for InstrumentUpdate

fn clone(&self) -> InstrumentUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstrumentUpdate

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

Formats the value using the given formatter.

impl Default for InstrumentUpdate

fn default() -> InstrumentUpdate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InstrumentUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.