Struct AlgoOrderRequest 

pub struct AlgoOrderRequest { /* private fields */ }

Request body for POST /api/v5/trade/order-algo.

Implementations

impl AlgoOrderRequest

pub fn new( inst_id: impl Into<String>, td_mode: impl Into<String>, side: impl Into<String>, ord_type: impl Into<String>, sz: impl Into<String>, ) -> Self

Create an algo-order request with a quantity.

pub fn full_close(self) -> Self

Replace sz with the only currently supported full-close fraction, 1.

pub fn currency(self, value: impl Into<String>) -> Self

Set the margin currency.

pub fn position_side(self, value: impl Into<String>) -> Self

Set the position side (long, short, or net).

pub fn reduce_only(self, value: bool) -> Self

Set the reduce-only flag.

pub fn client_algo_order_id(self, value: impl Into<String>) -> Self

Set the client-supplied algo ID.

pub fn target_currency(self, value: impl Into<String>) -> Self

Set the Spot quantity unit (base_ccy or quote_ccy).

pub fn trade_quote_currency(self, value: impl Into<String>) -> Self

Set the quote currency used for Spot trading.

pub fn trigger(self, px: impl Into<String>, order_px: impl Into<String>) -> Self

Configure a trigger order’s trigger and execution prices.

pub fn advance_order_type(self, value: impl Into<String>) -> Self

Set trigger execution type (fok or ioc).

pub fn trigger_price_type(self, value: impl Into<String>) -> Self

Set trigger price type (last, index, or mark).

pub fn take_profit( self, trigger_px: impl Into<String>, order_px: impl Into<String>, ) -> Self

Configure take-profit trigger and order prices.

pub fn limit_take_profit(self, order_px: impl Into<String>) -> Self

Configure a limit take-profit order that does not require a trigger price.

pub fn take_profit_price_type(self, value: impl Into<String>) -> Self

Set the take-profit trigger source.

pub fn stop_loss( self, trigger_px: impl Into<String>, order_px: impl Into<String>, ) -> Self

Configure stop-loss trigger and order prices.

pub fn stop_loss_price_type(self, value: impl Into<String>) -> Self

Set the stop-loss trigger source.

pub fn cancel_on_close_position(self, value: bool) -> Self

Associate TP/SL cancellation with a fully closed position.

pub fn attached_algo_orders(self, values: Vec<AttachedAlgoOrderRequest>) -> Self

Attach TP/SL definitions to the triggered order.

pub fn callback_ratio(self, value: impl Into<String>) -> Self

Set a trailing-order callback ratio.

pub fn callback_spread(self, value: impl Into<String>) -> Self

Set a trailing-order callback spread.

pub fn active_price(self, value: impl Into<String>) -> Self

Set a trailing-order activation price.

pub fn chase( self, chase_type: impl Into<String>, chase_val: impl Into<String>, ) -> Self

Configure chase type and value.

pub fn maximum_chase( self, chase_type: impl Into<String>, chase_val: impl Into<String>, ) -> Self

Configure the optional maximum chase type and value.

pub fn twap_by_variance( self, px_var: impl Into<String>, sz_limit: impl Into<String>, px_limit: impl Into<String>, time_interval: impl Into<String>, ) -> Self

Configure TWAP strategy fields using a percentage variance.

pub fn twap_by_spread( self, px_spread: impl Into<String>, sz_limit: impl Into<String>, px_limit: impl Into<String>, time_interval: impl Into<String>, ) -> Self

Configure TWAP strategy fields using an absolute price spread.

pub fn smart_iceberg( self, sz_limit: impl Into<String>, lmt_order_number: impl Into<String>, aggressiveness: impl Into<String>, ) -> Self

Configure required Smart Iceberg execution fields.

pub fn price_limit(self, value: impl Into<String>) -> Self

Set an optional Smart Iceberg price limit.

pub fn smart_iceberg_triggers( self, values: Vec<SmartIcebergTriggerRequest>, ) -> Self

Set Smart Iceberg trigger parameters.

pub fn tag(self, value: impl Into<String>) -> Self

Set an order tag of at most 16 ASCII alphanumeric characters.

Trait Implementations

impl Clone for AlgoOrderRequest

fn clone(&self) -> AlgoOrderRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlgoOrderRequest

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

Formats the value using the given formatter.

impl Serialize for AlgoOrderRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ValidateRequest for AlgoOrderRequest

fn validate(&self) -> Result<(), RequestValidationError>

Validate all constraints represented by this SDK version.