Skip to main content

SimulateOrderRiskResponse

Struct SimulateOrderRiskResponse 

Source
pub struct SimulateOrderRiskResponse {
Show 13 fields pub accepted: Option<bool>, pub equity_after: Option<String>, pub estimated_fee: Option<String>, pub estimated_liquidation_price: Option<String>, pub free_collateral_after: Option<String>, pub initial_margin_required_after: Option<String>, pub maintenance_margin_required_after: Option<String>, pub margin_account_id: Option<String>, pub margin_mode: Option<String>, pub reject_reason: Option<String>, pub risk_bucket_id: Option<String>, pub selected_trading_pair_ids: Option<Vec<Uuid>>, pub strategy_key: Option<String>,
}
Expand description

SimulateOrderRiskResponse

JSON schema
{
 "type": "object",
 "properties": {
   "accepted": {
     "type": [
       "boolean",
       "null"
     ]
   },
   "equityAfter": {
     "type": [
       "string",
       "null"
     ]
   },
   "estimatedFee": {
     "type": [
       "string",
       "null"
     ]
   },
   "estimatedLiquidationPrice": {
     "description": "Estimated liquidation mark-price. In ISOLATED mode, this is the\n position/risk-bucket threshold. In CROSS mode, it is conditional: it varies\n only the target position's mark while all other marks in the cross risk\n bucket remain unchanged. Other position marks, funding, realized PnL,\n fees/reserves, and collateral can change it. Treat an absent or blank value\n as unavailable, never as zero.",
     "type": [
       "string",
       "null"
     ]
   },
   "freeCollateralAfter": {
     "type": [
       "string",
       "null"
     ]
   },
   "initialMarginRequiredAfter": {
     "type": [
       "string",
       "null"
     ]
   },
   "maintenanceMarginRequiredAfter": {
     "type": [
       "string",
       "null"
     ]
   },
   "marginAccountId": {
     "description": "The margin account the simulation was resolved against. Always populated;\n useful for auto-resolved buckets where the caller didn't supply the id.",
     "type": [
       "string",
       "null"
     ]
   },
   "marginMode": {
     "description": "Present when the simulation resolved against a risk bucket. Values: ISOLATED, CROSS.",
     "type": [
       "string",
       "null"
     ]
   },
   "rejectReason": {
     "type": [
       "string",
       "null"
     ]
   },
   "riskBucketId": {
     "description": "Present when the simulation resolved against a risk bucket.",
     "type": [
       "string",
       "null"
     ]
   },
   "selectedTradingPairIds": {
     "description": "Present for cross risk-bucket simulations.",
     "type": [
       "array",
       "null"
     ],
     "items": {
       "type": "string",
       "format": "uuid",
       "minLength": 1
     }
   },
   "strategyKey": {
     "description": "Populated when the simulated account is an auto-resolved bucket.",
     "type": [
       "string",
       "null"
     ]
   }
 }
}

Fields§

§accepted: Option<bool>§equity_after: Option<String>§estimated_fee: Option<String>§estimated_liquidation_price: Option<String>

Estimated liquidation mark-price. In ISOLATED mode, this is the position/risk-bucket threshold. In CROSS mode, it is conditional: it varies only the target position’s mark while all other marks in the cross risk bucket remain unchanged. Other position marks, funding, realized PnL, fees/reserves, and collateral can change it. Treat an absent or blank value as unavailable, never as zero.

§free_collateral_after: Option<String>§initial_margin_required_after: Option<String>§maintenance_margin_required_after: Option<String>§margin_account_id: Option<String>

The margin account the simulation was resolved against. Always populated; useful for auto-resolved buckets where the caller didn’t supply the id.

§margin_mode: Option<String>

Present when the simulation resolved against a risk bucket. Values: ISOLATED, CROSS.

§reject_reason: Option<String>§risk_bucket_id: Option<String>

Present when the simulation resolved against a risk bucket.

§selected_trading_pair_ids: Option<Vec<Uuid>>

Present for cross risk-bucket simulations.

§strategy_key: Option<String>

Populated when the simulated account is an auto-resolved bucket.

Trait Implementations§

Source§

impl Clone for SimulateOrderRiskResponse

Source§

fn clone(&self) -> SimulateOrderRiskResponse

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 SimulateOrderRiskResponse

Source§

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

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

impl Default for SimulateOrderRiskResponse

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for SimulateOrderRiskResponse

Source§

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

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

impl Serialize for SimulateOrderRiskResponse

Source§

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

Serialize this value into the given Serde serializer. 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> 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.

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