Interface: OrdersClient

Read-only order and trading status endpoints. All require a session.

Properties

context

protected readonly context: ClientContext

Methods

activeOrderIds()

activeOrderIds(signal?): Promise<readonly string[]>

Parameters

signal?

AbortSignal

Returns

Promise<readonly string[]>

---

bulkOrder()

bulkOrder(bulkOrderId, signal?): Promise<BulkOrder>

Parameters

bulkOrderId

string

signal?

AbortSignal

Returns

Promise<BulkOrder>

---

bulkOrders()

bulkOrders(options?, signal?): Promise<BulkOrdersResponse>

Saved bulk (multi-instrument) orders.

Parameters

options?

BulkOrderOptions = {}

signal?

AbortSignal

Returns

Promise<BulkOrdersResponse>

---

deals()

deals(signal?): Promise<DealsResponse>

Today's executed deals, including fund deals.

Parameters

signal?

AbortSignal

Returns

Promise<DealsResponse>

---

exchangeRates()

exchangeRates(signal?): Promise<readonly ExchangeRate[]>

Parameters

signal?

AbortSignal

Returns

Promise<readonly ExchangeRate[]>

---

marketStatus()

marketStatus(countryCode, date?, signal?): Promise<string>

countryCode is for example SE or US; date is yyyy-MM-dd and defaults to today (UTC).

Parameters

countryCode

string

date?

string = ...

signal?

AbortSignal

Returns

Promise<string>

---

orderbook()

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

Trading rules for an orderbook: tick sizes, validity range, and supported order features.

Parameters

orderbookId

string

signal?

AbortSignal

Returns

Promise<TradingOrderbook>

---

orderCount()

orderCount(signal?): Promise<OrderCount>

Parameters

signal?

AbortSignal

Returns

Promise<OrderCount>

---

orders()

orders(signal?): Promise<OrdersResponse>

Open, fund, and cancelled orders.

Parameters

signal?

AbortSignal

Returns

Promise<OrdersResponse>

---

stopLoss()

stopLoss(accountId, stopLossId, signal?): Promise<StopLoss>

accountId is an account URL parameter ID.

Parameters

accountId

string

stopLossId

string

signal?

AbortSignal

Returns

Promise<StopLoss>

---

stopLosses()

stopLosses(options?, signal?): Promise<readonly StopLoss[]>

Parameters

options?

StopLossOptions = {}

signal?

AbortSignal

Returns

Promise<readonly StopLoss[]>