nautilus_tardis::http::models

Struct InstrumentInfo

Source 
pub struct InstrumentInfo {
Show 21 fields
    pub id: Ustr,
    pub exchange: Exchange,
    pub base_currency: Ustr,
    pub quote_currency: Ustr,
    pub instrument_type: InstrumentType,
    pub active: bool,
    pub available_since: DateTime<Utc>,
    pub available_to: Option<DateTime<Utc>>,
    pub expiry: Option<DateTime<Utc>>,
    pub price_increment: f64,
    pub amount_increment: f64,
    pub min_trade_amount: f64,
    pub maker_fee: f64,
    pub taker_fee: f64,
    pub inverse: Option<bool>,
    pub contract_multiplier: Option<f64>,
    pub quanto: Option<bool>,
    pub settlement_currency: Option<Ustr>,
    pub strike_price: Option<f64>,
    pub option_type: Option<OptionType>,
    pub changes: Option<Vec<InstrumentChanges>>,

}
Expand description

The metadata of a particular instrument. See https://docs.tardis.dev/api/instruments-metadata-api.

Fields§

§id: Ustr

The instrument symbol.

§exchange: Exchange

The instrument exchange.

§base_currency: Ustr

The instrument base currency (normalized, e.g., BTC for BitMEX, not XBT).

§quote_currency: Ustr

The instrument quote currency (normalized, e.g., BTC for BitMEX, not XBT).

§instrument_type: InstrumentType

The instrument type e.g., spot, perpetual, future, option.

§active: bool

If the instrument is actively listed.

§available_since: DateTime<Utc>

The available from date in ISO format.

§available_to: Option<DateTime<Utc>>

The available to date in ISO format.

§expiry: Option<DateTime<Utc>>

The contract expiry date in ISO format (applicable to futures and options).

§price_increment: f64

The instrument price increment.

§amount_increment: f64

The instrument size increment.

§min_trade_amount: f64

The minimum tradeable size for the instrument.

§maker_fee: f64

The instrument maker fee: consider it as illustrative only, as it depends in practice on account traded volume levels, different categories, VIP levels, owning exchange currency etc.

§taker_fee: f64

The instrument taker fee: consider it as illustrative only, as it depends in practice on account traded volume levels, different categories, VIP levels, owning exchange currency etc.

§inverse: Option<bool>

If the instrument is inverse (only for derivatives such as futures and perpetual swaps).

§contract_multiplier: Option<f64>

The instrument contract multiplier (only for derivatives).

§quanto: Option<bool>

If the instrument is quanto (only for quanto instruments).

§settlement_currency: Option<Ustr>

The instrument settlement currency (only for Quanto instruments where settlement currency is different both base and quote currency).

§strike_price: Option<f64>

The instrument strike price (only for options).

§option_type: Option<OptionType>

The option type (only for options).

§changes: Option<Vec<InstrumentChanges>>

The changes for the instrument (best-effort basis from Tardis).

Trait Implementations§

Source§

impl Clone for InstrumentInfo

Source§

fn clone(&self) -> InstrumentInfo

Returns a copy 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 InstrumentInfo

Source§

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

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

impl<'de> Deserialize<'de> for InstrumentInfo

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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
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
§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

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

§

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

§

impl<T> MaybeSendSync for T

§

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