API Reference

---

API Reference / GlobalStocksOrders

Class: GlobalStocksOrders

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

Orders on the Global Stocks (US equities) book.

Note the domestic risk pipeline does not apply here: its checks resolve instruments from the Indian scrip master and encode NSE/BSE rules. Writes through the agent layer are still gated by scope and the live-trading flag.

Constructors

Constructor

new GlobalStocksOrders(httpClient): GlobalStocksOrders

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

Parameters

httpClient

HttpClient

Returns

GlobalStocksOrders

Methods

place()

place(request): Promise<OrderOperationResult<GlobalOrderResponse>>

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

Parameters

request

GlobalPlaceOrderRequest

Returns

Promise<OrderOperationResult<GlobalOrderResponse>>

---

modify()

modify(request): Promise<GlobalOrderResponse>

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

Parameters

request

GlobalModifyOrderRequest

Returns

Promise<GlobalOrderResponse>

---

cancel()

cancel(orderId): Promise<GlobalOrderResponse>

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

Parameters

orderId

string

Returns

Promise<GlobalOrderResponse>

---

list()

list(): Promise<GlobalOrderResponse[]>

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

Returns

Promise<GlobalOrderResponse[]>

---

getById()

getById(orderId): Promise<GlobalOrderResponse>

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

Parameters

orderId

string

Returns

Promise<GlobalOrderResponse>