Class FundContext

Fund (mutual fund) channel context.

Constructors

constructor

new FundContext(): FundContext

Returns FundContext

Methods

`Static`new

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

hotFunds

hotFunds(): Promise<HotFund[]>

Get the hot-selling fund list.

Returns Promise<HotFund[]>

funds

funds(opts?: GetFundsOptions | null): Promise<FundBrief[]>
Get the fund list.
Parameters
- Optionalopts: GetFundsOptions | null
Returns Promise<FundBrief[]>

filters

filters(): Promise<FundFilters>

Get the fund list filter options.

Returns Promise<FundFilters>

detail

detail(counterId: string): Promise<FundDetail>
Get fund detail.
Parameters
- counterId: string
Returns Promise<FundDetail>

analysis

analysis(
counterId: string,
opts?: GetFundAnalysisOptions | null,
): Promise<FundAnalysis>
Get fund analysis (level 1).
Parameters
- counterId: string
- Optionalopts: GetFundAnalysisOptions | null
Returns Promise<FundAnalysis>

analysisDetail

analysisDetail(
counterId: string,
opts?: GetFundAnalysisOptions | null,
): Promise<FundAnalysisDetail>
Get fund analysis detail (level 2).
Parameters
- counterId: string
- Optionalopts: GetFundAnalysisOptions | null
Returns Promise<FundAnalysisDetail>

trend

trend(
counterId: string,
opts?: GetFundAnalysisOptions | null,
): Promise<FundTrend>
Get fund trend chart.
Parameters
- counterId: string
- Optionalopts: GetFundAnalysisOptions | null
Returns Promise<FundTrend>

annualReturns

annualReturns(
counterId: string,
opts?: FundPageOptions | null,
): Promise<FundAnnualReturn[]>
Get fund annual returns.
Parameters
- counterId: string
- Optionalopts: FundPageOptions | null
Returns Promise<FundAnnualReturn[]>

quarterlyReturns

quarterlyReturns(
counterId: string,
opts?: FundPageOptions | null,
): Promise<FundQuarterlyReturn[]>
Get fund quarterly returns.
Parameters
- counterId: string
- Optionalopts: FundPageOptions | null
Returns Promise<FundQuarterlyReturn[]>

performance

performance(counterId: string): Promise<FundPerformance[]>
Get fund performance figures.
Parameters
- counterId: string
Returns Promise<FundPerformance[]>

performanceComparison

performanceComparison(
counterId: string,
opts?: GetFundAnalysisOptions | null,
): Promise<FundPerformanceComparison>
Get fund performance comparison.
Parameters
- counterId: string
- Optionalopts: GetFundAnalysisOptions | null
Returns Promise<FundPerformanceComparison>

nav

nav(counterId: string): Promise<FundNavValue[]>
Get fund latest net value.
Parameters
- counterId: string
Returns Promise<FundNavValue[]>

navHistory

navHistory(
counterId: string,
opts?: FundPageOptions | null,
): Promise<FundNavValue[]>
Get fund historical net value (paged).
Parameters
- counterId: string
- Optionalopts: FundPageOptions | null
Returns Promise<FundNavValue[]>

navRange

navRange(
counterId: string,
opts?: FundNavRangeOptions | null,
): Promise<FundNavValue[]>
Get fund historical net value by relative time range.
Parameters
- counterId: string
- Optionalopts: FundNavRangeOptions | null
Returns Promise<FundNavValue[]>

holdings

holdings(
counterId: string,
opts?: GetFundHoldingsOptions | null,
): Promise<FundHoldings>
Get a fund's top-10 holdings.
Parameters
- counterId: string
- Optionalopts: GetFundHoldingsOptions | null
Returns Promise<FundHoldings>

stockHoldings

stockHoldings(
counterId: string,
opts?: GetFundStockHoldingsOptions | null,
): Promise<FundStockHolding[]>
Get the stocks held by a fund (reverse lookup).
Parameters
- counterId: string
- Optionalopts: GetFundStockHoldingsOptions | null
Returns Promise<FundStockHolding[]>

positions

positions(opts?: GetFundPositionsOptions | null): Promise<FundPositions>
Get the user's fund positions overview.
Parameters
- Optionalopts: GetFundPositionsOptions | null
Returns Promise<FundPositions>

position

position(
counterId: string,
opts?: GetFundPositionOptions | null,
): Promise<FundPositionDetail>
Get the user's single fund position detail.
Parameters
- counterId: string
- Optionalopts: GetFundPositionOptions | null
Returns Promise<FundPositionDetail>

positionPerformance

positionPerformance(counterId: string): Promise<FundPositionPerformance[]>
Get the performance figures of a held fund.
Parameters
- counterId: string
Returns Promise<FundPositionPerformance[]>

positionProfits

positionProfits(
counterId: string,
opts?: GetFundPositionProfitsOptions | null,
): Promise<FundPositionProfits>
Get the cumulative-profit series of a held fund.
Parameters
- counterId: string
- Optionalopts: GetFundPositionProfitsOptions | null
Returns Promise<FundPositionProfits>

positionNav

positionNav(
counterId: string,
opts?: FundNavRangeOptions | null,
): Promise<FundPositionNav[]>
Get the net-value history of a held fund.
Parameters
- counterId: string
- Optionalopts: FundNavRangeOptions | null
Returns Promise<FundPositionNav[]>

positionDividends

positionDividends(
counterId: string,
opts?: GetFundPositionDividendsOptions | null,
): Promise<FundDividends>
Get the dividend records of a held fund.
Parameters
- counterId: string
- Optionalopts: GetFundPositionDividendsOptions | null
Returns Promise<FundDividends>

orders

orders(opts?: GetFundOrdersOptions | null): Promise<FundOrder[]>
Get the user's fund orders (also serves as the trade/execution record).
Parameters
- Optionalopts: GetFundOrdersOptions | null
Returns Promise<FundOrder[]>

order

order(orderId: number): Promise<FundOrderDetail>
Get a fund order detail.
Parameters
- orderId: number
Returns Promise<FundOrderDetail>

transactions

transactions(
opts?: GetFundTransactionsOptions | null,
): Promise<FundTransaction[]>
Get the user's fund transactions (cash-flow records).
Parameters
- Optionalopts: GetFundTransactionsOptions | null
Returns Promise<FundTransaction[]>

validateOrder

validateOrder(opts: ValidateFundOrderOptions): Promise<FundOrderValidation>
Validate a fund order before submitting.
Parameters
- opts: ValidateFundOrderOptions
Returns Promise<FundOrderValidation>

submitOrder

submitOrder(opts: SubmitFundOrderOptions): Promise<FundOrderSubmitResponse>
Submit a fund order (buy / sell).
Parameters
- opts: SubmitFundOrderOptions
Returns Promise<FundOrderSubmitResponse>

cancelOrder

cancelOrder(orderId: number): Promise<void>
Cancel (withdraw) a fund order.
Parameters
- orderId: number
Returns Promise<void>