API Reference

---

API Reference / GlobalStocks

Class: GlobalStocks

Defined in: src/resources/GlobalStocks.ts:223

The Global Stocks book, hung off client.globalStocks.

Kept in its own namespace so an agent asked for "my holdings" cannot silently blend USD positions into the INR book.

Constructors

Constructor

new GlobalStocks(httpClient): GlobalStocks

Defined in: src/resources/GlobalStocks.ts:231

Parameters

httpClient

HttpClient

Returns

GlobalStocks

Properties

orders

readonly orders: GlobalStocksOrders

Defined in: src/resources/GlobalStocks.ts:224

---

holdings

readonly holdings: GlobalStocksHoldings

Defined in: src/resources/GlobalStocks.ts:225

---

trades

readonly trades: GlobalStocksTrades

Defined in: src/resources/GlobalStocks.ts:226

---

funds

readonly funds: GlobalStocksFunds

Defined in: src/resources/GlobalStocks.ts:227

---

marketStatus

readonly marketStatus: GlobalStocksMarketStatus

Defined in: src/resources/GlobalStocks.ts:228

---

margin

readonly margin: GlobalStocksMarginCalculator

Defined in: src/resources/GlobalStocks.ts:229

Methods

costSummary()

costSummary(request): Promise<GlobalOrderCostSummary>

Defined in: src/resources/GlobalStocks.ts:244

Charges and margin together, so a caller can decide affordability in one step rather than reconciling two responses.

Parameters

request

GlobalEstimateRequest

Returns

Promise<GlobalOrderCostSummary>