Struct OKXInstrument 

pub struct OKXInstrument {

    pub inst_type: OKXInstrumentType,
    pub inst_id: Ustr,
    pub inst_id_code: Option<u64>,
    pub uly: Ustr,
    pub inst_family: Ustr,
    pub base_ccy: Ustr,
    pub quote_ccy: Ustr,
    pub settle_ccy: Ustr,
    pub ct_val: String,
    pub ct_mult: String,
    pub ct_val_ccy: String,
    pub opt_type: OKXOptionType,
    pub stk: String,
    pub list_time: Option<u64>,
    pub exp_time: Option<u64>,
    pub lever: String,
    pub tick_sz: String,
    pub lot_sz: String,
    pub min_sz: String,
    pub ct_type: OKXContractType,
    pub state: OKXInstrumentStatus,
    pub rule_type: String,
    pub max_lmt_sz: String,
    pub max_mkt_sz: String,
    pub max_lmt_amt: String,
    pub max_mkt_amt: String,
    pub max_twap_sz: String,
    pub max_iceberg_sz: String,
    pub max_trigger_sz: String,
    pub max_stop_sz: String,
}

Represents an instrument on the OKX exchange.

Fields

inst_type: OKXInstrumentType

Product type (SPOT, MARGIN, SWAP, FUTURES, OPTION).

inst_id: Ustr

Instrument ID, e.g. “BTC-USD-SWAP”.

inst_id_code: Option<u64>

Instrument ID code (numeric). Required for WebSocket order operations. E.g., 10458 for BTC-USD-SWAP. May not be present for SPOT instruments.

uly: Ustr

Underlying of the instrument, e.g. “BTC-USD”. Only applicable to FUTURES/SWAP/OPTION.

inst_family: Ustr

Instrument family, e.g. “BTC-USD”. Only applicable to FUTURES/SWAP/OPTION.

base_ccy: Ustr

Base currency, e.g. “BTC” in BTC-USDT. Applicable to SPOT/MARGIN.

quote_ccy: Ustr

Quote currency, e.g. “USDT” in BTC-USDT.

settle_ccy: Ustr

Settlement currency, e.g. “BTC” for BTC-USD-SWAP.

ct_val: String

Contract value. Only applicable to FUTURES/SWAP/OPTION.

ct_mult: String

Contract multiplier. Only applicable to FUTURES/SWAP/OPTION.

ct_val_ccy: String

Contract value currency. Only applicable to FUTURES/SWAP/OPTION.

opt_type: OKXOptionType

Option type, “C” for call options, “P” for put options. Only applicable to OPTION.

stk: String

Strike price. Only applicable to OPTION.

list_time: Option<u64>

Listing time, Unix timestamp format in milliseconds, e.g. “1597026383085”.

exp_time: Option<u64>

Expiry time, Unix timestamp format in milliseconds, e.g. “1597026383085”.

lever: String

Leverage. Not applicable to SPOT.

tick_sz: String

Tick size, e.g. “0.1”.

lot_sz: String

Lot size, e.g. “1”.

min_sz: String

Minimum order size.

ct_type: OKXContractType

Contract type. linear: “linear”, inverse: “inverse”. Only applicable to FUTURES/SWAP.

state: OKXInstrumentStatus

Instrument status.

rule_type: String

Rule type, e.g. “DynamicPL”, “CT”, etc.

max_lmt_sz: String

Maximum limit order size.

max_mkt_sz: String

Maximum market order size.

max_lmt_amt: String

Maximum limit order amount.

max_mkt_amt: String

Maximum market order amount.

max_twap_sz: String

Maximum TWAP order size.

max_iceberg_sz: String

Maximum iceberg order size.

max_trigger_sz: String

Maximum trigger order size.

max_stop_sz: String

Maximum stop order size.

Trait Implementations

impl Clone for OKXInstrument

fn clone(&self) -> OKXInstrument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OKXInstrument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OKXInstrument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OKXInstrument

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.