Interface: InstrumentsClient
Properties
context
protectedreadonlycontext:ClientContext
Methods
deleteStockScreenerTabs()
deleteStockScreenerTabs(
signal?):Promise<unknown>
Parameters
signal?
AbortSignal
Returns
Promise<unknown>
getAllStockSectors()
getAllStockSectors(
signal?):Promise<readonlyStockSectorGroup[]>
Parameters
signal?
AbortSignal
Returns
Promise<readonly StockSectorGroup[]>
getCertificateFilterOptions()
getCertificateFilterOptions(
signal?):Promise<Readonly<Record<string, readonlyListedProductFilterOption[]>>>
Parameters
signal?
AbortSignal
Returns
Promise<Readonly<Record<string, readonly ListedProductFilterOption[]>>>
getEtfFilterOptions()
getEtfFilterOptions(
signal?):Promise<Readonly<Record<string, readonlyListedProductFilterOption[]>>>
Parameters
signal?
AbortSignal
Returns
Promise<Readonly<Record<string, readonly ListedProductFilterOption[]>>>
getGainersLosers()
getGainersLosers(
filter?,signal?):Promise<GainersLosersResponse>
Parameters
filter?
StockFilter = {}
signal?
AbortSignal
Returns
Promise<GainersLosersResponse>
getOptionFutureForwardFilterOptions()
getOptionFutureForwardFilterOptions(
signal?):Promise<Readonly<Record<string, readonlyListedProductFilterOption[]>>>
Parameters
signal?
AbortSignal
Returns
Promise<Readonly<Record<string, readonly ListedProductFilterOption[]>>>
getPopularStockSectors()
getPopularStockSectors(
signal?):Promise<readonlyPopularStockSector[]>
Parameters
signal?
AbortSignal
Returns
Promise<readonly PopularStockSector[]>
getSavedStockFilters()
getSavedStockFilters(
signal?):Promise<SavedStockFiltersResponse>
Parameters
signal?
AbortSignal
Returns
Promise<SavedStockFiltersResponse>
getStockFilterOptions()
getStockFilterOptions(
signal?):Promise<StockFilterOptions>
Parameters
signal?
AbortSignal
Returns
Promise<StockFilterOptions>
getStockScreenerMetadata()
getStockScreenerMetadata(
signal?):Promise<StockScreenerMetadataResponse>
Parameters
signal?
AbortSignal
Returns
Promise<StockScreenerMetadataResponse>
getStockScreenerTabs()
getStockScreenerTabs(
signal?):Promise<StockScreenerTabsResponse>
Parameters
signal?
AbortSignal
Returns
Promise<StockScreenerTabsResponse>
getThemeStocks()
getThemeStocks(
orderbookIds,sortBy,signal?):Promise<ThemeStocksResponse>
Parameters
orderbookIds
readonly string[]
sortBy
signal?
AbortSignal
Returns
Promise<ThemeStocksResponse>
getWarrantFilterOptions()
getWarrantFilterOptions(
signal?):Promise<Readonly<Record<string, readonlyListedProductFilterOption[]>>>
Parameters
signal?
AbortSignal
Returns
Promise<Readonly<Record<string, readonly ListedProductFilterOption[]>>>
saveStockFilters()
saveStockFilters(
filters,signal?):Promise<unknown>
Parameters
filters
readonly SavedStockFilter[]
signal?
AbortSignal
Returns
Promise<unknown>
saveStockScreenerTabs()
saveStockScreenerTabs(
tabs,signal?):Promise<unknown>
Parameters
tabs
readonly StockScreenerTab[]
signal?
AbortSignal
Returns
Promise<unknown>
screenCertificates()
screenCertificates(
options?):Promise<ScreenCertificatesResponse>
Parameters
options?
ScreenListedProductsOptions = {}
Returns
Promise<ScreenCertificatesResponse>
screenDerivatives()
screenDerivatives(
options?):Promise<ScreenDerivativesResponse>
Filter keys: underlyingInstruments, optionTypes, endDates, callIndicators.
Parameters
options?
ScreenListedProductsOptions = {}
Returns
Promise<ScreenDerivativesResponse>
screenEtfs()
screenEtfs(
options?):Promise<ScreenEtfsResponse>
Parameters
options?
ScreenListedProductsOptions = {}
Returns
Promise<ScreenEtfsResponse>
screenStocks()
screenStocks(
options?):Promise<ScreenStocksResponse>
Parameters
options?
ScreenStocksOptions = {}
Returns
Promise<ScreenStocksResponse>
screenWarrants()
screenWarrants(
options?):Promise<ScreenWarrantsResponse>
Parameters
options?
ScreenListedProductsOptions = {}
Returns
Promise<ScreenWarrantsResponse>