Skip to main content

TradeHistoryRequest

Struct TradeHistoryRequest 

Source
pub struct TradeHistoryRequest<'a> {
    pub category: Category,
    pub symbol: Option<Cow<'a, str>>,
    pub order_id: Option<Cow<'a, str>>,
    pub order_link_id: Option<Cow<'a, str>>,
    pub base_coin: Option<Cow<'a, str>>,
    pub start_time: Option<u64>,
    pub end_time: Option<u64>,
    pub exec_type: Option<Cow<'a, str>>,
    pub limit: Option<u64>,
}
Expand description

Parameters for requesting trade history data.

Used to construct a request to the /v5/execution/list endpoint to retrieve historical trade executions. Bots use this to analyze past trades, calculate performance metrics, and refine trading strategies for perpetual futures.

Fields§

§category: Category

The product category (e.g., Linear, Inverse).

Specifies the instrument type. Bots must set this to fetch trade history for the correct contract type (e.g., Linear for USDT-margined perpetuals).

§symbol: Option<Cow<'a, str>>

The trading pair symbol (e.g., “BTCUSDT”).

Optionally filters trades by symbol. If unset, trades for all symbols in the category are returned. Bots should specify this for targeted analysis.

§order_id: Option<Cow<'a, str>>

The order ID.

Optionally filters trades by a specific order ID. Useful for bots tracking executions for a particular order.

§order_link_id: Option<Cow<'a, str>>

The user-defined order link ID.

Optionally filters trades by a custom order identifier. Bots can use this to correlate trades with specific strategies.

§base_coin: Option<Cow<'a, str>>

The base coin (e.g., “BTC”).

Optionally filters trades by the base asset. Useful for bots analyzing trades across multiple pairs of the same asset.

§start_time: Option<u64>

The start time for the trade history (Unix timestamp in milliseconds).

Defines the beginning of the time range. Bots should set this for historical trade analysis, such as performance over a specific period.

§end_time: Option<u64>

The end time for the trade history (Unix timestamp in milliseconds).

Defines the end of the time range. Bots should set this to limit data to a specific period, optimizing performance.

§exec_type: Option<Cow<'a, str>>

The execution type (e.g., “Trade”, “Funding”).

Optionally filters trades by execution type. Bots can use this to focus on specific trade events, such as excluding funding fee executions.

§limit: Option<u64>

The maximum number of records to return (1-50, default: 50).

Controls the number of trade records returned. Bots should set a reasonable limit to balance data completeness with performance.

Implementations§

Source§

impl<'a> TradeHistoryRequest<'a>

Source

pub fn default() -> TradeHistoryRequest<'a>

Creates a default TradeHistory request.

Returns a request with category set to Linear and all other fields unset. Suitable for broad queries but should be customized for specific analysis needs.

Source

pub fn new( category: Category, symbol: Option<&'a str>, order_id: Option<&'a str>, order_link_id: Option<&'a str>, base_coin: Option<&'a str>, start_time: Option<u64>, end_time: Option<u64>, exec_type: Option<&'a str>, limit: Option<u64>, ) -> TradeHistoryRequest<'a>

Constructs a new TradeHistory request with specified parameters.

Allows full customization. Bots should use this to specify the exact symbol, time range, and filters to align with their analysis requirements.

Trait Implementations§

Source§

impl<'a> Clone for TradeHistoryRequest<'a>

Source§

fn clone(&self) -> TradeHistoryRequest<'a>

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<'a> Default for TradeHistoryRequest<'a>

Source§

fn default() -> TradeHistoryRequest<'a>

Returns the “default value” for a type. 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.

Source§

impl<T> Instrument for T

Source§

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

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

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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