Interface: CollectionsClient

Read-only watchlists, alerts, and instrument notes. All require a session.

Properties

context

protected readonly context: ClientContext

Methods

alerts()

alerts(signal?): Promise<AlertsResponse>

Parameters

signal?

AbortSignal

Returns

Promise<AlertsResponse>

---

noteOrderbooks()

noteOrderbooks(signal?): Promise<readonly NoteOrderbook[]>

Orderbooks that have at least one note.

Parameters

signal?

AbortSignal

Returns

Promise<readonly NoteOrderbook[]>

---

notes()

notes(orderbookId?, signal?): Promise<readonly Note[]>

Parameters

orderbookId?

string

signal?

AbortSignal

Returns

Promise<readonly Note[]>

---

triggeredAlerts()

triggeredAlerts(signal?): Promise<readonly Alert[]>

Parameters

signal?

AbortSignal

Returns

Promise<readonly Alert[]>

---

watchlistData()

watchlistData(watchListId, orderbookIds, dataPoints?, signal?): Promise<readonly WatchlistRow[]>

Queries rows for orderbookIds in a watchlist; dataPoints select the returned fields.

Parameters

watchListId

string

orderbookIds

readonly string[]

dataPoints?

readonly ("ABSOLUTE_PERFORMANCE_SINCE_ADDED" | "BETA" | "BUY_OR_SELL" | "BUY_PRICE" | "CATEGORY" | "CHANGE" | "CHANGE_PERCENTAGE" | "COLLATERAL_FACTOR" | "CURRENCY" | "DATE_WHEN_ADDED" | "DIRECTION" | "DIVIDENDS_AMOUNT_12_MONTHS" | "DIVIDENDS_PER_YEAR" | "EARNINGS_PER_SHARE" | "END_DATE" | "ETF_ORDINARY_DIRECT_YIELD" | "ETF_RISK" | "EV_EBIT_RATIO" | "FIVE_YEARS_PERFORMANCE" | "FLAG_CODE" | "FUND_RATING" | "FUND_RISK" | "FUND_TOTAL_MARKET_VALUE" | "HIGHEST_PRICE" | "INSTRUMENT_TYPE" | "LAST_PRICE" | "LEVERAGE" | "LOWEST_PRICE" | "MANAGEMENT_FEE" | "MARGIN_REQUIREMENT" | "MARKET_CAP" | "MAX_PERFORMANCE" | "NAME" | "NAV" | "NET_DEBT_TO_EBITDA_RATIO" | "NEXT_DIVIDEND_AMOUNT" | "NEXT_DIVIDEND_DATE" | "NEXT_REPORT_DATE" | "NUMBER_OF_OWNERS" | "ONE_MONTH_PERFORMANCE" | "ONE_WEEK_PERFORMANCE" | "ONE_YEAR_PERFORMANCE" | "OPTION_TYPE" | "ORDINARY_DIRECT_YIELD" | "PRICE_BOOK_RATIO" | "PRICE_EARNINGS_RATIO" | "PRICE_LAST_UPDATED_DATE" | "PRICE_LAST_UPDATED_TIME" | "PRICE_SALES_RATIO" | "PRICE_WHEN_ADDED" | "PRODUCT_FEE" | "RELATIVE_PERFORMANCE_SINCE_ADDED" | "RETURN_ON_EQUITY" | "SELL_PRICE" | "SHARPE_RATIO" | "SHORT_SELLING_ALLOWED" | "SIX_MONTHS_PERFORMANCE" | "SPREAD" | "STANDARD_DEVIATION_PERCENT" | "STRIKE_PRICE" | "SUPER_INTEREST_APPROVED" | "TEN_YEARS_PERFORMANCE" | "THIS_YEAR_PERFORMANCE" | "THREE_MONTHS_PERFORMANCE" | "THREE_YEARS_PERFORMANCE" | "TOTAL_FEE" | "UNDERLYING_INSTRUMENT_NAME" | "VALUE_TRADED" | "VOLATILITY" | "VOLUME_TRADED" | "WARRANT_LEVERAGE" | "WARRANT_TYPE")[] = ...

signal?

AbortSignal

Returns

Promise<readonly WatchlistRow[]>

---

watchlistNews()

watchlistNews(orderbookIds, options?, signal?): Promise<WatchlistNewsResponse>

Parameters

orderbookIds

readonly string[]

options?

WatchlistNewsOptions = {}

signal?

AbortSignal

Returns

Promise<WatchlistNewsResponse>

---

watchlists()

watchlists(signal?): Promise<readonly Watchlist[]>

Parameters

signal?

AbortSignal

Returns

Promise<readonly Watchlist[]>