Chartbreaker
    Preparing search index...

    Type Alias PortfolioValueHistoryBreakdownPosition

    One open position on a given day, with the price inputs used to value it.

    type PortfolioValueHistoryBreakdownPosition = {
        buyFxRate?: NumericString;
        buyPriceCurrency?: string;
        buyPriceFromBroker: boolean;
        buyPricePerUnit?: NumericString;
        buyValue?: Amount;
        closePrice?: NumericString;
        fxRate?: NumericString;
        instrument?: Instrument;
        instrumentId?: InstrumentId;
        isin?: string;
        name?: string;
        positionIds?: string[];
        priceCurrency?: string;
        priceMultiplier: NumericString;
        size: NumericString;
        usedFallback: boolean;
        value: Amount;
    }
    Index
    buyFxRate?: NumericString

    The multiplier that has been applied to convert buyPriceCurrency into the currency of buyValue. Missing if no conversion was needed.

    buyPriceCurrency?: string

    The currency buyPricePerUnit is quoted in (ISO). This is missing if buyPricePerUnit is missing or if no currency has been stated.

    buyPriceFromBroker: boolean

    If this is true, buyPricePerUnit is the purchase price the broker reports for the current position instead of one derived from the order executions. This is the case for positions that were already held before the order archive begins, so the buy value can be off if the size has changed since then.

    buyPricePerUnit?: NumericString

    The average buy price per unit, quoted in buyPriceCurrency and excluding fees and taxes. This is missing if it could not be determined, i.e. if there is neither a buy execution in the order archive nor a purchase price reported by the broker, or if the buys are quoted in mixed currencies.

    buyValue?: Amount

    This position's contribution to the day's buy value. This is missing if buyPricePerUnit is missing.

    closePrice?: NumericString

    The end-of-day close per unit, quoted in priceCurrency. This is missing if the last-known-price fallback has been used (see usedFallback).

    fxRate?: NumericString

    The multiplier that has been applied to convert priceCurrency into the currency of value. Missing if no conversion was needed.

    instrument?: Instrument

    The stock3 instrument the security has been mapped to, as the positions and orders of this library carry it. Missing if it could not be mapped - a client should then fall back to name / isin.

    instrumentId?: InstrumentId

    The id of instrument, for clients that only need to link the row.

    isin?: string

    The ISIN of the security. Missing for an instrument that is identified by a crypto pair alone, i.e. one the broker reports no ISIN for.

    name?: string

    The security's name as the broker reports it. Missing if it reports none - a client should then fall back to isin.

    positionIds?: string[]

    The ids of the depot positions this row stands for, so that a client can look up their live values (e.g. through RealtimeCalculator.createPositionQuotesObservable) and show the same numbers as its depot view.

    This is only set when the breakdown is the one of the current day (isToday), because only then are the positions of the day the ones the broker reports now. It is a list and not a single id because one row aggregates a security across depot positions - the same ISIN held in two custody currencies is two positions at some brokers.

    priceCurrency?: string

    The currency the price is quoted in (ISO). This is also set when usedFallback is true, since the last known price is converted the same way. It is missing if no currency has been stated.

    priceMultiplier: NumericString

    0.01 for percentage-quoted bonds, otherwise 1.

    The size that was held at the end of the day.

    usedFallback: boolean

    If this is true, no end-of-day quote was available and the last known price has been used instead.

    value: Amount

    This position's contribution to the day's value.