OKXInstrument

nautilus_okx::common::models

Struct OKXInstrument 

Source 
pub struct OKXInstrument {
Show 29 fields
    pub inst_type: OKXInstrumentType,
    pub inst_id: Ustr,
    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,

}
Expand description

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

§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§

Source§

impl Clone for OKXInstrument

Source§

fn clone(&self) -> OKXInstrument

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OKXInstrument

Source§

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

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

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for OKXInstrument

Source§

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

Serialize this value into the given Serde serializer. 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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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> 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Ungil for T
where T: Send,