Interface: TransactionsClient

Properties

context

protected readonly context: ClientContext

Methods

dividends()

dividends(options?, signal?): Promise<DividendsResponse>

Parameters

options?

DividendOptions = {}

signal?

AbortSignal

Returns

Promise<DividendsResponse>

---

list()

list(filter?, signal?): Promise<TransactionListResponse>

Parameters

filter?

TransactionListFilter = {}

signal?

AbortSignal

Returns

Promise<TransactionListResponse>

---

pending()

pending(signal?): Promise<PendingTransactionsResponse>

Parameters

signal?

AbortSignal

Returns

Promise<PendingTransactionsResponse>

---

transaction()

transaction(accountId, transactionId, signal?): Promise<Transaction>

accountId is an account ID or URL parameter ID.

Parameters

accountId

string

transactionId

string

signal?

AbortSignal

Returns

Promise<Transaction>

---

upcomingDividends()

upcomingDividends(accountId?, signal?): Promise<UpcomingDividendsResponse>

Upcoming dividends for held positions, optionally for one account URL parameter ID.

Parameters

accountId?

string

signal?

AbortSignal

Returns

Promise<UpcomingDividendsResponse>