Skip to main content

DeriveInstrument

nautilus_derive::http::models

Struct DeriveInstrument 

Source 
pub struct DeriveInstrument {
Show 20 fields
    pub amount_step: Decimal,
    pub base_asset_address: Ustr,
    pub base_asset_sub_id: Ustr,
    pub base_currency: Ustr,
    pub base_fee: Decimal,
    pub instrument_name: Ustr,
    pub instrument_type: DeriveInstrumentType,
    pub is_active: bool,
    pub maker_fee_rate: Decimal,
    pub mark_price_fee_rate_cap: Option<Decimal>,
    pub maximum_amount: Decimal,
    pub minimum_amount: Decimal,
    pub option_details: Option<DeriveOptionPublicDetails>,
    pub perp_details: Option<DerivePerpPublicDetails>,
    pub quote_currency: Ustr,
    pub scheduled_activation: i64,
    pub scheduled_deactivation: i64,
    pub taker_fee_rate: Decimal,
    pub tick_size: Decimal,
    pub raw: Option<Params>,

}
Expand description

Instrument definition returned by public/get_all_instruments.

Fields§

§amount_step: Decimal

Minimum increment of the amount field for orders.

§base_asset_address: Ustr

On-chain address of the base asset.

§base_asset_sub_id: Ustr

Sub-id of the base asset within the asset module (decimal string).

§base_currency: Ustr

Underlying currency (e.g. "ETH").

§base_fee: Decimal

Base flat fee in USD.

§instrument_name: Ustr

Canonical instrument name (e.g. "ETH-PERP", "ETH-20250627-3500-C").

§instrument_type: DeriveInstrumentType

Instrument category.

§is_active: bool

Whether the instrument is currently tradable.

§maker_fee_rate: Decimal

Maker fee rate (fraction).

§mark_price_fee_rate_cap: Option<Decimal>

Optional cap on the mark-price-derived fee rate.

§maximum_amount: Decimal

Maximum allowed order amount.

§minimum_amount: Decimal

Venue-reported minimum contracts or tokens per trade. Taker orders can fill below this value.

§option_details: Option<DeriveOptionPublicDetails>

Option-specific details (populated when instrument_type == option).

§perp_details: Option<DerivePerpPublicDetails>

Perp-specific details (populated when instrument_type == perp).

§quote_currency: Ustr

Quote currency (e.g. "USDC").

§scheduled_activation: i64

Scheduled activation timestamp (UNIX seconds).

§scheduled_deactivation: i64

Scheduled deactivation timestamp (UNIX seconds; i64::MAX if none).

§taker_fee_rate: Decimal

Taker fee rate (fraction).

§tick_size: Decimal

Minimum price increment.

§raw: Option<Params>

Original instrument response fields, before typed decoding or normalization.

Implementations§

Source§

impl DeriveInstrument

Source

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

Source§

impl<'de> DeriveInstrument

Source

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

Trait Implementations§

Source§

impl Clone for DeriveInstrument

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DeriveInstrument

Source§

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

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

impl<'de> Deserialize<'de> for DeriveInstrument

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

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

impl Serialize for DeriveInstrument

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

§

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

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
§

impl<'de, T> BorrowedRpcObject<'de> for T
where T: RpcBorrow<'de> + RpcSend,

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> PolicyExt for T
where T: ?Sized,

§

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

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

§

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<'de, T> RpcBorrow<'de> for T
where T: Deserialize<'de> + Debug + Send + Sync + Unpin,

§

impl<T> RpcObject for T
where T: RpcSend + RpcRecv,

§

impl<T> RpcRecv for T
where T: DeserializeOwned + Debug + Send + Sync + Unpin + 'static,

§

impl<T> RpcSend for T
where T: Serialize + Clone + Debug + Send + Sync + Unpin,

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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<T> Ungil for T
where T: Send,

§

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