Skip to main content

OrderListPlaceOcoParams

Struct OrderListPlaceOcoParams 

Source
pub struct OrderListPlaceOcoParams {
Show 32 fields pub symbol: String, pub side: OrderListPlaceOcoSideEnum, pub quantity: Decimal, pub above_type: OrderListPlaceOcoAboveTypeEnum, pub below_type: OrderListPlaceOcoBelowTypeEnum, pub id: Option<String>, pub list_client_order_id: Option<String>, pub above_client_order_id: Option<String>, pub above_iceberg_qty: Option<i64>, pub above_price: Option<Decimal>, pub above_stop_price: Option<Decimal>, pub above_trailing_delta: Option<i64>, pub above_time_in_force: Option<OrderListPlaceOcoAboveTimeInForceEnum>, pub above_strategy_id: Option<i64>, pub above_strategy_type: Option<i32>, pub above_peg_price_type: Option<OrderListPlaceOcoAbovePegPriceTypeEnum>, pub above_peg_offset_type: Option<OrderListPlaceOcoAbovePegOffsetTypeEnum>, pub above_peg_offset_value: Option<i32>, pub below_client_order_id: Option<String>, pub below_iceberg_qty: Option<i64>, pub below_price: Option<Decimal>, pub below_stop_price: Option<Decimal>, pub below_trailing_delta: Option<i64>, pub below_time_in_force: Option<OrderListPlaceOcoBelowTimeInForceEnum>, pub below_strategy_id: Option<i64>, pub below_strategy_type: Option<i32>, pub below_peg_price_type: Option<OrderListPlaceOcoBelowPegPriceTypeEnum>, pub below_peg_offset_type: Option<OrderListPlaceOcoBelowPegOffsetTypeEnum>, pub below_peg_offset_value: Option<i32>, pub new_order_resp_type: Option<OrderListPlaceOcoNewOrderRespTypeEnum>, pub self_trade_prevention_mode: Option<OrderListPlaceOcoSelfTradePreventionModeEnum>, pub recv_window: Option<Decimal>,
}
Expand description

Request parameters for the [order_list_place_oco] operation.

This struct holds all of the inputs you can pass when calling order_list_place_oco.

Fields§

§symbol: String

The symbol parameter.

This field is **required.

§side: OrderListPlaceOcoSideEnum

The side parameter.

This field is **required.

§quantity: Decimal

The quantity parameter.

This field is **required.

§above_type: OrderListPlaceOcoAboveTypeEnum

The above_type parameter.

This field is **required.

§below_type: OrderListPlaceOcoBelowTypeEnum

The below_type parameter.

This field is **required.

§id: Option<String>

Unique WebSocket request ID.

This field is **optional.

§list_client_order_id: Option<String>

The list_client_order_id parameter.

This field is **optional.

§above_client_order_id: Option<String>

Arbitrary unique ID among open orders for the above order. Automatically generated if not sent

This field is **optional.

§above_iceberg_qty: Option<i64>

Note that this can only be used if aboveTimeInForce is GTC.

This field is **optional.

§above_price: Option<Decimal>

Can be used if aboveType is STOP_LOSS_LIMIT , LIMIT_MAKER, or TAKE_PROFIT_LIMIT to specify the limit price.

This field is **optional.

§above_stop_price: Option<Decimal>

Can be used if aboveType is STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT.
Either aboveStopPrice or aboveTrailingDelta or both, must be specified.

This field is **optional.

§above_trailing_delta: Option<i64>

See Trailing Stop order FAQ.

This field is **optional.

§above_time_in_force: Option<OrderListPlaceOcoAboveTimeInForceEnum>

The above_time_in_force parameter.

This field is **optional.

§above_strategy_id: Option<i64>

Arbitrary numeric value identifying the above order within an order strategy.

This field is **optional.

§above_strategy_type: Option<i32>

Arbitrary numeric value identifying the above order strategy.
Values smaller than 1000000 are reserved and cannot be used.

This field is **optional.

§above_peg_price_type: Option<OrderListPlaceOcoAbovePegPriceTypeEnum>

The above_peg_price_type parameter.

This field is **optional.

§above_peg_offset_type: Option<OrderListPlaceOcoAbovePegOffsetTypeEnum>

The above_peg_offset_type parameter.

This field is **optional.

§above_peg_offset_value: Option<i32>

The above_peg_offset_value parameter.

This field is **optional.

§below_client_order_id: Option<String>

The below_client_order_id parameter.

This field is **optional.

§below_iceberg_qty: Option<i64>

Note that this can only be used if belowTimeInForce is GTC.

This field is **optional.

§below_price: Option<Decimal>

Can be used if belowType is STOP_LOSS_LIMIT , LIMIT_MAKER, or TAKE_PROFIT_LIMIT to specify the limit price.

This field is **optional.

§below_stop_price: Option<Decimal>

Can be used if belowType is STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT or TAKE_PROFIT_LIMIT.
Either belowStopPrice or belowTrailingDelta or both, must be specified.

This field is **optional.

§below_trailing_delta: Option<i64>

See Trailing Stop order FAQ.

This field is **optional.

§below_time_in_force: Option<OrderListPlaceOcoBelowTimeInForceEnum>

The below_time_in_force parameter.

This field is **optional.

§below_strategy_id: Option<i64>

Arbitrary numeric value identifying the below order within an order strategy.

This field is **optional.

§below_strategy_type: Option<i32>

Arbitrary numeric value identifying the below order strategy.
Values smaller than 1000000 are reserved and cannot be used.

This field is **optional.

§below_peg_price_type: Option<OrderListPlaceOcoBelowPegPriceTypeEnum>

The below_peg_price_type parameter.

This field is **optional.

§below_peg_offset_type: Option<OrderListPlaceOcoBelowPegOffsetTypeEnum>

The below_peg_offset_type parameter.

This field is **optional.

§below_peg_offset_value: Option<i32>

The below_peg_offset_value parameter.

This field is **optional.

§new_order_resp_type: Option<OrderListPlaceOcoNewOrderRespTypeEnum>

The new_order_resp_type parameter.

This field is **optional.

§self_trade_prevention_mode: Option<OrderListPlaceOcoSelfTradePreventionModeEnum>

The self_trade_prevention_mode parameter.

This field is **optional.

§recv_window: Option<Decimal>

The value cannot be greater than 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.

This field is **optional.

Implementations§

Source§

impl OrderListPlaceOcoParams

Source

pub fn builder( symbol: String, side: OrderListPlaceOcoSideEnum, quantity: Decimal, above_type: OrderListPlaceOcoAboveTypeEnum, below_type: OrderListPlaceOcoBelowTypeEnum, ) -> OrderListPlaceOcoParamsBuilder

Create a builder for [order_list_place_oco].

Required parameters:

  • symbol — String
  • side — String
  • quantityrust_decimal::Decimal
  • above_type — String
  • below_type — String

Trait Implementations§

Source§

impl Clone for OrderListPlaceOcoParams

Source§

fn clone(&self) -> OrderListPlaceOcoParams

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 OrderListPlaceOcoParams

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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

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

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

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