Struct Instrument 

#[non_exhaustive]
pub struct Instrument {
    pub inst_type: InstType,
    pub inst_id: String,
    pub uly: String,
    pub inst_family: String,
    pub base_ccy: String,
    pub quote_ccy: String,
    pub settle_ccy: String,
    pub lot_sz: NumberString,
    pub tick_sz: NumberString,
    pub min_sz: NumberString,
    pub state: String,
}

A tradable instrument.

Only commonly used fields are modeled; the struct is #[non_exhaustive] and unknown JSON fields are ignored, so OKX additions are non-breaking.

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: InstType

Instrument type.

inst_id: String

Instrument ID, e.g. BTC-USDT.

uly: String

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

inst_family: String

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

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).

lot_sz: NumberString

Lot size (order size increment).

tick_sz: NumberString

Tick size (price increment).

min_sz: NumberString

Minimum order size.

state: String

Instrument lifecycle state, e.g. live, suspend.

Trait Implementations

impl Clone for Instrument

fn clone(&self) -> Instrument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instrument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Instrument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.