Skip to main content

WsPortfolioPosition

Struct WsPortfolioPosition 

Source
pub struct WsPortfolioPosition {
Show 38 fields pub position_type: String, pub ticker: Option<String>, pub display_name: Option<String>, pub base_asset_ticker: Option<String>, pub currency: Option<String>, pub exchange: Option<String>, pub account: Option<String>, pub upper_type: Option<String>, pub instrument_type: Option<String>, pub term: Option<String>, pub quantity: Option<Decimal>, pub locked: Option<Decimal>, pub balance_price: Option<Decimal>, pub current_price: Option<Decimal>, pub balance_value: Option<Decimal>, pub balance_value_rub: Option<Decimal>, pub balance_value_usd: Option<Decimal>, pub balance_value_eur: Option<Decimal>, pub current_value: Option<Decimal>, pub current_value_rub: Option<Decimal>, pub current_value_usd: Option<Decimal>, pub current_value_eur: Option<Decimal>, pub unrealized_pl: Option<Decimal>, pub unrealized_percent_pl: Option<f64>, pub daily_pl: Option<Decimal>, pub daily_percent_pl: Option<f64>, pub portfolio_share: Option<f64>, pub scale: Option<u32>, pub minimum_step: Option<Decimal>, pub board: Option<String>, pub price_unit: Option<String>, pub face_value: Option<Decimal>, pub accrued_income: Option<Decimal>, pub is_blocked: Option<bool>, pub is_blocked_trade_account: Option<bool>, pub locked_for_futures: Option<Decimal>, pub ratio_quantity: Option<Decimal>, pub expire_date: Option<String>,
}
Expand description

One position or balance of a portfolio frame.

The same fields as crate::http::models::PortfolioPosition, without the deprecated ones the docs mark (sub-account, agreement, logo). All but type are optional.

§Examples

use brokapi_bcs_protocol::ws::models::WsPortfolioPosition;

let p: WsPortfolioPosition = serde_json::from_str(
    r#"{"type":"depoLimit","ticker":"SBER","quantity":10,"unrealizedPL":40.0}"#,
)?;
assert_eq!(p.unrealized_pl, Some(dec!(40.0)));

Fields§

§position_type: String

Kind of the record (JSON field type), for example depoLimit for a securities position and moneyLimit for a currency balance.

§ticker: Option<String>

Ticker.

§display_name: Option<String>

Name of the instrument for display.

§base_asset_ticker: Option<String>

Ticker of the base asset, for derivatives.

§currency: Option<String>

Price currency.

§exchange: Option<String>

Exchange code.

§account: Option<String>

Trading account.

§upper_type: Option<String>

Top-level instrument type, as text. The broker docs list no values.

§instrument_type: Option<String>

Instrument type, as text.

§term: Option<String>

Settlement term code.

§quantity: Option<Decimal>

Quantity in pieces.

§locked: Option<Decimal>

Quantity held by active orders or by collateral (initial margin).

§balance_price: Option<Decimal>

Balance price (the price the position was opened at), in the price currency.

§current_price: Option<Decimal>

Current price.

§balance_value: Option<Decimal>

Balance value (at the opening price), in the price currency.

§balance_value_rub: Option<Decimal>

Balance value in roubles.

§balance_value_usd: Option<Decimal>

Balance value in dollars.

§balance_value_eur: Option<Decimal>

Balance value in euros.

§current_value: Option<Decimal>

Current value in the price currency.

§current_value_rub: Option<Decimal>

Current value in roubles.

§current_value_usd: Option<Decimal>

Current value in dollars.

§current_value_eur: Option<Decimal>

Current value in euros.

§unrealized_pl: Option<Decimal>

Price change since the position was opened (JSON field unrealizedPL, with capital letters).

§unrealized_percent_pl: Option<f64>

The same change in percent (JSON field unrealizedPercentPL).

§daily_pl: Option<Decimal>

Price change over the day (JSON field dailyPL). The broker docs word it as “daily change of the price since the position was opened”.

§daily_percent_pl: Option<f64>

The same change in percent (JSON field dailyPercentPL).

§portfolio_share: Option<f64>

Share of the portfolio in percent, of its value in roubles.

§scale: Option<u32>

Number of decimal places of the price.

§minimum_step: Option<Decimal>

Minimum price step.

§board: Option<String>

Class code (board) of the instrument.

§price_unit: Option<String>

Unit of the price.

§face_value: Option<Decimal>

Face value, for bonds.

§accrued_income: Option<Decimal>

Accrued coupon income, for bonds.

§is_blocked: Option<bool>

true if the class is blocked.

§is_blocked_trade_account: Option<bool>

true if the trading account is blocked.

§locked_for_futures: Option<Decimal>

Amount reserved as collateral (initial margin) on futures.

§ratio_quantity: Option<Decimal>

Quantity in a lot.

§expire_date: Option<String>

Expiration date, kept as text.

Trait Implementations§

Source§

impl Clone for WsPortfolioPosition

Source§

fn clone(&self) -> WsPortfolioPosition

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 WsPortfolioPosition

Source§

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

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

impl<'de> Deserialize<'de> for WsPortfolioPosition

Source§

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

Deserialize this value from the given Serde deserializer. 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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

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

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

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
§

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
§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more