Skip to main content

GetPortfolioStatsResponse

Struct GetPortfolioStatsResponse 

Source
pub struct GetPortfolioStatsResponse {
Show 14 fields pub fees_paid: Option<String>, pub max_drawdown: Option<String>, pub period: Option<String>, pub perps_equity: Option<String>, pub pnl: Option<String>, pub pnl_breakdown: Option<PnlBreakdown>, pub spot_equity: Option<String>, pub total_equity: Option<String>, pub total_orders: Option<String>, pub total_pnl: Option<String>, pub total_trades: Option<String>, pub unrealized_pnl: Option<String>, pub volume: Option<String>, pub win_loss_ratio: Option<f64>,
}
Expand description

GetPortfolioStatsResponse

JSON schema
{
 "type": "object",
 "properties": {
   "feesPaid": {
     "description": "Total fees paid by user",
     "examples": [
       "0.12"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "maxDrawdown": {
     "description": "Maximum peak-to-trough drawdown on running PnL",
     "examples": [
       "0.00"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "period": {
     "description": "Period used for this query",
     "examples": [
       "30d"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "perpsEquity": {
     "description": "Perpetuals account equity",
     "examples": [
       "0.00"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "pnl": {
     "description": "Legacy realized PnL over the period, average-cost basis: gains/losses booked only when a position is reduced or closed, net of fees, with funding folded in. Excludes unrealized PnL on open positions. For the full PnL picture use totalPnl and pnlBreakdown, whose components follow the gross-of-fees convention instead.",
     "examples": [
       "-0.01"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "pnlBreakdown": {
     "$ref": "#/components/schemas/PnlBreakdown"
   },
   "spotEquity": {
     "description": "Spot account equity",
     "examples": [
       "280.93"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "totalEquity": {
     "description": "Total equity (sum of all balances)",
     "examples": [
       "280.93"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "totalOrders": {
     "description": "Number of orders in period",
     "examples": [
       "56"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "totalPnl": {
     "description": "Current lifetime total PnL: realized + unrealized - fundingPaid - fees, with realized components gross of fees. A live value, independent of the period parameter; the addends are in pnlBreakdown.",
     "examples": [
       "10.11"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "totalTrades": {
     "description": "Number of trades in period",
     "examples": [
       "42"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "unrealizedPnl": {
     "description": "Current unrealized PnL across open spot holdings (cost basis vs latest close) and open perp positions (entry vs mark). A live value, independent of the period parameter.",
     "examples": [
       "12.34"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "volume": {
     "description": "Total trade volume (sum of quoteVolume)",
     "examples": [
       "231.81"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "winLossRatio": {
     "description": "Ratio of profitable trades to total trades",
     "examples": [
       0.65
     ],
     "type": [
       "number",
       "null"
     ],
     "format": "double"
   }
 }
}

Fields§

§fees_paid: Option<String>

Total fees paid by user

§max_drawdown: Option<String>

Maximum peak-to-trough drawdown on running PnL

§period: Option<String>

Period used for this query

§perps_equity: Option<String>

Perpetuals account equity

§pnl: Option<String>

Legacy realized PnL over the period, average-cost basis: gains/losses booked only when a position is reduced or closed, net of fees, with funding folded in. Excludes unrealized PnL on open positions. For the full PnL picture use totalPnl and pnlBreakdown, whose components follow the gross-of-fees convention instead.

§pnl_breakdown: Option<PnlBreakdown>§spot_equity: Option<String>

Spot account equity

§total_equity: Option<String>

Total equity (sum of all balances)

§total_orders: Option<String>

Number of orders in period

§total_pnl: Option<String>

Current lifetime total PnL: realized + unrealized - fundingPaid - fees, with realized components gross of fees. A live value, independent of the period parameter; the addends are in pnlBreakdown.

§total_trades: Option<String>

Number of trades in period

§unrealized_pnl: Option<String>

Current unrealized PnL across open spot holdings (cost basis vs latest close) and open perp positions (entry vs mark). A live value, independent of the period parameter.

§volume: Option<String>

Total trade volume (sum of quoteVolume)

§win_loss_ratio: Option<f64>

Ratio of profitable trades to total trades

Trait Implementations§

Source§

impl Clone for GetPortfolioStatsResponse

Source§

fn clone(&self) -> GetPortfolioStatsResponse

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 GetPortfolioStatsResponse

Source§

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

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

impl Default for GetPortfolioStatsResponse

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for GetPortfolioStatsResponse

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 GetPortfolioStatsResponse

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