Chartbreaker
    Preparing search index...

    Interface Position

    interface Position {
        ask?: Amount;
        availableSize: string;
        bid?: Amount;
        brokerExchangeId?: string;
        comment?: string;
        commentIsEditable?: boolean;
        commission?: string;
        currentValuation?: PositionValuation;
        direction?: Direction;
        exchangeId?: string;
        fallbackInstrument?: Partial<
            { isin: string; name: string; symbol: string; wkn: string },
        >;
        fallbackIsin?: string;
        fallbackName?: string;
        fallbackSymbol?: string;
        fallbackWkn?: string;
        id: string;
        instrument?: Instrument;
        instrumentId?: string;
        prevCloseValuation?: PositionValuation;
        profitLossAbs?: Amount;
        profitLossAbsPrevClose?: Amount;
        profitLossAbsWithDividends?: Amount;
        profitLossRel?: string;
        profitLossRelPrevClose?: string;
        profitLossRelWithDividends?: string;
        purchaseDate?: string;
        purchaseDateTime?: Date;
        purchaseValuation?: PositionValuation;
        realtimeModeNotSupported?: boolean;
        size: string;
        sizeDecimals?: number;
        sizeUnit?: string;
        stopLoss?: Amount;
        subPositions?: Position[];
        swaps?: string;
        takeProfit?: Amount;
        totalDividends?: Amount;
    }
    Index

    Properties

    ask? availableSize bid? brokerExchangeId? comment? commentIsEditable? commission? currentValuation? direction? exchangeId? fallbackInstrument? fallbackIsin? fallbackName? fallbackSymbol? fallbackWkn? id instrument? instrumentId? prevCloseValuation? profitLossAbs? profitLossAbsPrevClose? profitLossAbsWithDividends? profitLossRel? profitLossRelPrevClose? profitLossRelWithDividends? purchaseDate? purchaseDateTime? purchaseValuation? realtimeModeNotSupported? size sizeDecimals? sizeUnit? stopLoss? subPositions? swaps? takeProfit? totalDividends?

    Properties

    ask?: Amount

    Position's ask (CFD only)

    availableSize: string

    How much of the position can be sold currently.

    bid?: Amount

    Position's bid (CFD only)

    brokerExchangeId?: string

    The brokerExchangeId to use for this position. (Used by CFDFX broker for the calculator to determine profit/loss)

    comment?: string

    Textual comment for the position.

    commentIsEditable?: boolean

    True if the user may edit a comment for this position.

    commission?: string

    Position's commission (CFD only)

    currentValuation?: PositionValuation

    Current position quote and value.

    direction?: Direction

    Position's direction (CFD only)

    exchangeId?: string

    The exchangeId to use for this position. If not present, no exchange preference is known.

    fallbackInstrument?: Partial<
        { isin: string; name: string; symbol: string; wkn: string },
    >

    If no mapping to an instrument is available, this contains the instrument identification data as provided by the broker.

    fallbackIsin?: string

    The instrument's ISIN, if instrument cannot be mapped, but ISIN is provided by broker

    use fallbackInstrument.isin instead

    fallbackName?: string

    The instrument's name, if it cannot be mapped to an InstrumentId

    use fallbackInstrument.name instead

    fallbackSymbol?: string

    The instrument's symbol, if instrument cannot be mapped, but symbol is provided by broker

    use fallbackInstrument.symbol instead

    fallbackWkn?: string

    The instrument's WKN, if instrument cannot be mapped, but WKN is provided by broker

    use fallbackInstrument.wkn instead

    id: string
    instrument?: Instrument

    Set if it was possible to map the instrument.

    instrumentId?: string

    Note this may get deprecated in favor of instrument.id in the future.

    prevCloseValuation?: PositionValuation

    "prevClose" position quote and value. May also be today, if it was purchased today.

    profitLossAbs?: Amount

    Absolute P/L of the entire position, since acquisition.

    profitLossAbsPrevClose?: Amount

    Absolute P/L of the entire position, since acquisition.

    profitLossAbsWithDividends?: Amount

    Absolute P/L of the entire position, since acquisition, but including the dividends booked for this position (see totalDividends).

    profitLossRel?: string

    Relative P/L of the entire posiiton, since acquisition. 1 means +100%

    profitLossRelPrevClose?: string

    Relative P/L of the entire posiiton, since "prevClose". 1 means +100%

    profitLossRelWithDividends?: string

    Relative P/L of the entire position, since acquisition, but including the dividends booked for this position (see totalDividends). 1 means +100%

    purchaseDate?: string

    Date of position purchase.

    purchaseDateTime?: Date

    Date and time of position purchase. If not set, purchaseDate may at least contain the date.

    purchaseValuation?: PositionValuation

    Position quote and value at acquisition.

    realtimeModeNotSupported?: boolean

    If true, do not offer RT mode for this position.

    size: string
    sizeDecimals?: number

    If present, the position size should be displayed with this number of fractional digits. Otherwise, it should be read from size or some UI defaults should be applied. Note that size may be more precise. In thise case, if a position size should be carried over to an order form or similar, the original size value should be used.

    sizeUnit?: string
    stopLoss?: Amount

    Position's stoploss (CFD only)

    subPositions?: Position[]

    If this is an aggregated position, it may have a list of sub positions. In UIs, they can be displayed as expandable.

    swaps?: string

    Position's swaps (CFD only)

    takeProfit?: Amount

    Position's takeprofit (CFD only)

    totalDividends?: Amount

    If set, the total amount of booked dividends that apply to this position. This affects the profitLoss

    Settings

    Member Visibility

    On This Page

    Properties