Interface: FundsClient

Properties

context

protected readonly context: ClientContext

Methods

chart()

chart(orderbookId, period, signal?): Promise<FundChartResponse>

Parameters

orderbookId

string

period

"today" | "one_week" | "one_month" | "three_months" | "this_year" | "one_year" | "three_years" | "five_years" | "infinity"

signal?

AbortSignal

Returns

Promise<FundChartResponse>

---

chartPeriods()

chartPeriods(orderbookId, signal?): Promise<readonly ChartPeriodChange[]>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<readonly ChartPeriodChange[]>

---

description()

description(orderbookId, signal?): Promise<FundDescription>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<FundDescription>

---

details()

details(orderbookId, signal?): Promise<FundOrderbookDetails>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<FundOrderbookDetails>

---

development()

development(orderbookId, signal?): Promise<FundDevelopment>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<FundDevelopment>

---

favourites()

favourites(signal?): Promise<readonly unknown[]>

Requires a session. The item shape is unverified; captures so far were empty.

Parameters

signal?

AbortSignal

Returns

Promise<readonly unknown[]>

---

guide()

guide(orderbookId, signal?): Promise<FundGuide>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<FundGuide>

---

holdings()

holdings(orderbookId, signal?): Promise<readonly FundPieChartPoint[]>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<readonly FundPieChartPoint[]>

---

instrumentSearch()

instrumentSearch(query, signal?): Promise<FundInstrumentSearchResponse>

Parameters

query

string

signal?

AbortSignal

Returns

Promise<FundInstrumentSearchResponse>

---

isFavourite()

isFavourite(orderbookId, signal?): Promise<boolean>

Requires a session.

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<boolean>

---

list()

list(options?, signal?): Promise<FundListResponse>

Parameters

options?

FundListOptions = {}

signal?

AbortSignal

Returns

Promise<FundListResponse>

---

orderbook()

orderbook(orderbookId, signal?): Promise<FundOrderbook>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<FundOrderbook>

---

portfolioData()

portfolioData(orderbookId, signal?): Promise<FundPortfolioData>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<FundPortfolioData>

---

reference()

reference(orderbookId, signal?): Promise<FundReference>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<FundReference>

---

regions()

regions(orderbookId, signal?): Promise<readonly FundPieChartPoint[]>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<readonly FundPieChartPoint[]>

---

search()

search(name, signal?): Promise<FundSearchResponse>

Parameters

name

string

signal?

AbortSignal

Returns

Promise<FundSearchResponse>

---

sectors()

sectors(orderbookId, signal?): Promise<readonly FundPieChartPoint[]>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<readonly FundPieChartPoint[]>

---

sustainability()

sustainability(orderbookId, signal?): Promise<FundSustainability>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<FundSustainability>

---

topTen()

topTen(options?, signal?): Promise<FundTopTenResponse>

Parameters

options?

FundTopTenOptions = {}

signal?

AbortSignal

Returns

Promise<FundTopTenResponse>