Struct OrderRequest 

pub struct OrderRequest {
    pub symbol: Symbol,
    pub side: OrderSide,
    pub order_type: OrderType,
    pub quantity: Decimal,
    pub price: Option<Decimal>,
    pub stop_price: Option<Decimal>,
    pub time_in_force: TimeInForce,
    pub client_order_id: Option<String>,
    pub reduce_only: bool,
    pub post_only: bool,
    pub stp: SelfTradePrevention,
}

A request to place an order. Built with the convenience constructors and refined with the builder methods; quantities and prices are exact Decimals.

Fields

symbol: Symbol

The market to trade.

side: OrderSide

Buy or sell.

order_type: OrderType

Order type.

quantity: Decimal

Order quantity in base units.

price: Option<Decimal>

Limit price (required for limit / stop-limit orders).

stop_price: Option<Decimal>

Trigger price (required for stop orders).

time_in_force: TimeInForce

Time-in-force policy.

client_order_id: Option<String>

Optional client-supplied id for idempotent placement and reconciliation.

reduce_only: bool

Only reduce an existing position; never open or increase one.

post_only: bool

Only rest as a maker; reject if it would take liquidity.

stp: SelfTradePrevention

Self-trade-prevention policy (defaults to SelfTradePrevention::None).

Implementations

impl OrderRequest

pub fn market_buy(symbol: Symbol, quantity: Decimal) -> OrderRequest

A market buy of quantity base units.

pub fn market_sell(symbol: Symbol, quantity: Decimal) -> OrderRequest

A market sell of quantity base units.

pub fn limit_buy( symbol: Symbol, quantity: Decimal, price: Decimal, ) -> OrderRequest

A limit buy of quantity base units at price.

pub fn limit_sell( symbol: Symbol, quantity: Decimal, price: Decimal, ) -> OrderRequest

A limit sell of quantity base units at price.

pub fn with_time_in_force(self, tif: TimeInForce) -> OrderRequest

Set the time-in-force policy.

pub fn with_client_order_id(self, id: impl Into<String>) -> OrderRequest

Attach a client order id.

pub fn reduce_only(self) -> OrderRequest

Mark the order reduce-only.

pub fn post_only(self) -> OrderRequest

Mark the order post-only.

pub fn with_stop_price(self, stop_price: Decimal) -> OrderRequest

Turn this into a trigger order that rests until the market reaches stop_price: a market order becomes a OrderType::StopMarket, a limit order a OrderType::StopLimit.

A stop price is what makes an order a trigger order, so setting one promotes the type rather than leaving a stop_price that the type says to ignore. Without this the only way to build a stop was a struct literal, which is why no binding could place one.

pub fn with_stp(self, stp: SelfTradePrevention) -> OrderRequest

Set the self-trade-prevention policy.

pub fn validate(&self) -> Result<(), Error>

Validate the request’s internal consistency, before any venue filter is applied: a strictly positive quantity, a price where the type needs one, and a stop price for stop orders.

Errors

Returns Error::InvalidOrder when an invariant is violated.

Trait Implementations

impl Clone for OrderRequest

fn clone(&self) -> OrderRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrderRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OrderRequest

impl PartialEq for OrderRequest

fn eq(&self, other: &OrderRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for OrderRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OrderRequest