Class PortfolioContext

Portfolio analytics context — exchange rates and P&L analysis.

Index

Constructors

Methods

new exchangeRate profitAnalysis profitAnalysisDetail profitAnalysisByMarket profitAnalysisFlows

Constructors

constructor

new PortfolioContext(): PortfolioContext
Returns PortfolioContext

Methods

`Static`new

new(config: Config): PortfolioContext
Create a new PortfolioContext.
Parameters
- config: Config
Returns PortfolioContext

exchangeRate

exchangeRate(): Promise<ExchangeRates>
Get exchange rates for supported currencies.

Returns Promise<ExchangeRates>

profitAnalysis

profitAnalysis(
start?: string | null,
end?: string | null,
): Promise<ProfitAnalysis>
Get portfolio P&L analysis (summary + per-security breakdown).

start and end are optional date strings in YYYY-MM-DD format.
Parameters
- Optionalstart: string | null
- Optionalend: string | null
Returns Promise<ProfitAnalysis>

profitAnalysisDetail

profitAnalysisDetail(
    symbol: string,
    start?: string | null,
    end?: string | null,
): Promise<ProfitAnalysisDetail>
Get P&L detail for a specific security.

start and end are optional date strings in YYYY-MM-DD format.
Parameters
- symbol: string
- Optionalstart: string | null
- Optionalend: string | null
Returns Promise<ProfitAnalysisDetail>

profitAnalysisByMarket

profitAnalysisByMarket(
    market: string | null | undefined,
    start: string | null | undefined,
    end: string | null | undefined,
    currency: string | null | undefined,
    page: number,
    size: number,
): Promise<ProfitAnalysisByMarket>
Get paginated P&L analysis grouped by market.

All filter parameters are optional. page is 1-based (default 1); size controls the page size (default 20). start and end are optional date strings in YYYY-MM-DD format.
Parameters
- market: string | null | undefined
- start: string | null | undefined
- end: string | null | undefined
- currency: string | null | undefined
- page: number
- size: number
Returns Promise<ProfitAnalysisByMarket>

profitAnalysisFlows

profitAnalysisFlows(
    symbol: string,
    page: number,
    size: number,
    derivative: boolean,
    start?: string | null,
    end?: string | null,
): Promise<ProfitAnalysisFlows>
Get paginated P&L flow records for a security.

start and end are optional date strings in YYYY-MM-DD format.
Parameters
- symbol: string
- page: number
- size: number
- derivative: boolean
- Optionalstart: string | null
- Optionalend: string | null
Returns Promise<ProfitAnalysisFlows>