Interface: MarketClient

Properties

context

protected readonly context: ClientContext

Methods

brokerTradeSummaries()

brokerTradeSummaries(orderbookId, signal?): Promise<readonly BrokerTradeSummary[]>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<readonly BrokerTradeSummary[]>

companyEvents()

companyEvents(orderbookId, period, signal?): Promise<readonly CompanyEvent[]>

Parameters

orderbookId

string

period

PriceChartPeriod

signal?

AbortSignal

Returns

Promise<readonly CompanyEvent[]>

etf()

etf(orderbookId, signal?): Promise<EtfResponse>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<EtfResponse>

etfDetails()

etfDetails(orderbookId, signal?): Promise<EtfDetailsResponse>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<EtfDetailsResponse>

headerIndices()

headerIndices(signal?): Promise<HeaderIndicesResponse>

Parameters

signal?

AbortSignal

Returns

Promise<HeaderIndicesResponse>

indexConstituents()

indexConstituents(orderbookId, signal?): Promise<readonly IndexConstituent[]>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<readonly IndexConstituent[]>

insiderTrades()

insiderTrades(orderbookId, signal?): Promise<InsiderTradesResponse>

Individual insider transactions with the reporting insider.

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<InsiderTradesResponse>

insiderTransactions()

insiderTransactions(orderbookId, period, signal?): Promise<readonly InsiderTransactionSummary[]>

Parameters

orderbookId

string

period

PriceChartPeriod

signal?

AbortSignal

Returns

Promise<readonly InsiderTransactionSummary[]>

instrument()

instrument(type, orderbookId, signal?): Promise<ListedInstrument>

Parameters

type

"certificate" | "warrant" | "futureforward" | "option"

orderbookId

string

signal?

AbortSignal

Returns

Promise<ListedInstrument>

instrumentByIsin()

instrumentByIsin(isin, signal?): Promise<InstrumentByIsinResponse>

Parameters

isin

string

signal?

AbortSignal

Returns

Promise<InstrumentByIsinResponse>

instrumentDetails()

instrumentDetails(type, orderbookId, signal?): Promise<ListedInstrumentDetails>

Issuer, documents, order depth, and trades for a listed product.

Parameters

type

"certificate" | "warrant" | "futureforward" | "option"

orderbookId

string

signal?

AbortSignal

Returns

Promise<ListedInstrumentDetails>

marketData()

marketData(orderbookId, signal?): Promise<MarketDataResponse>

Requires a session.

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<MarketDataResponse>

marketMakerChart()

marketMakerChart(orderbookId, period, options?, signal?): Promise<MarketMakerChartResponse>

Price chart with market maker bid and ask, for certificates and warrants.

Parameters

orderbookId

string

period

PriceChartPeriod

options?

PriceChartOptions = {}

signal?

AbortSignal

Returns

Promise<MarketMakerChartResponse>

marketplace()

marketplace(orderbookId, signal?): Promise<MarketplaceStatus>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<MarketplaceStatus>

news()

news(orderbookId, signal?): Promise<InstrumentNewsResponse>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<InstrumentNewsResponse>

numberOfOwners()

numberOfOwners(orderbookId, signal?): Promise<NumberOfOwnersResponse>

History of how many Avanza customers own the instrument.

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<NumberOfOwnersResponse>

orderDepth()

orderDepth(orderbookId, signal?): Promise<OrderDepth>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<OrderDepth>

overviewChart()

overviewChart(orderbookId, period, signal?): Promise<OverviewChartResponse>

Parameters

orderbookId

string

period

signal?

AbortSignal

Returns

Promise<OverviewChartResponse>

overviewChartPeriods()

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

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<readonly ChartPeriodChange[]>

overviews()

overviews(signal?): Promise<readonly MarketOverview[]>

Parameters

signal?

AbortSignal

Returns

Promise<readonly MarketOverview[]>

priceChart()

priceChart(orderbookId, period, options?, signal?): Promise<PriceChartResponse>

Parameters

orderbookId

string

period

PriceChartPeriod

options?

PriceChartOptions = {}

signal?

AbortSignal

Returns

Promise<PriceChartResponse>

quote()

quote(orderbookId, signal?): Promise<StockQuote>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<StockQuote>

search()

search(query, options?, signal?): Promise<SearchResponse>

Parameters

query

string

options?

SearchOptions = {}

signal?

AbortSignal

Returns

Promise<SearchResponse>

shortSelling()

shortSelling(orderbookId, signal?): Promise<ShortSellingResponse>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<ShortSellingResponse>

stock()

stock(orderbookId, signal?): Promise<StockInfo>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<StockInfo>

stockAnalysis()

stockAnalysis(orderbookId, signal?): Promise<StockAnalysis>

Key ratios, financials, and dividends by year and quarter.

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<StockAnalysis>

technicalAnalysisPoints()

technicalAnalysisPoints(orderbookId, period, points, options?, signal?): Promise<readonly Ohlc[]>

Returns points OHLC points before the period start, used as technical-analysis lookback.

Parameters

orderbookId

string

period

PriceChartPeriod

points

number

options?

PriceChartOptions = {}

signal?

AbortSignal

Returns

Promise<readonly Ohlc[]>

trades()

trades(orderbookId, signal?): Promise<readonly MarketTrade[]>

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<readonly MarketTrade[]>