Skip to content

API Reference


API Reference / Orders

Class: Orders

Defined in: src/resources/Orders.ts:16

Constructors

Constructor

new Orders(httpClient): Orders

Defined in: src/resources/Orders.ts:17

Parameters

httpClient

HttpClient

Returns

Orders

Methods

place()

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

Defined in: src/resources/Orders.ts:19

Parameters

request

PlaceOrderRequest

Returns

Promise<OrderOperationResult<OrderResponse>>


list()

list(): Promise<OrderResponse[]>

Defined in: src/resources/Orders.ts:40

Returns

Promise<OrderResponse[]>


getById()

getById(orderId): Promise<OrderResponse>

Defined in: src/resources/Orders.ts:49

Parameters

orderId

string

Returns

Promise<OrderResponse>


getByCorrelationId()

getByCorrelationId(correlationId): Promise<OrderResponse>

Defined in: src/resources/Orders.ts:58

Parameters

correlationId

string

Returns

Promise<OrderResponse>


getTrades()

getTrades(orderId): Promise<TradeResponse[]>

Defined in: src/resources/Orders.ts:69

Parameters

orderId

string

Returns

Promise<TradeResponse[]>


listTrades()

listTrades(): Promise<TradeResponse[]>

Defined in: src/resources/Orders.ts:78

Returns

Promise<TradeResponse[]>


getTradeHistory()

getTradeHistory(request): Promise<TradeResponse[]>

Defined in: src/resources/Orders.ts:87

Parameters

request

TradeHistoryRequest

Returns

Promise<TradeResponse[]>


placeSlice()

placeSlice(request): Promise<OrderResponse[]>

Defined in: src/resources/Orders.ts:100

Parameters

request

PlaceOrderRequest

Returns

Promise<OrderResponse[]>


modify()

modify(request): Promise<OrderResponse>

Defined in: src/resources/Orders.ts:114

Parameters

request

ModifyOrderRequest

Returns

Promise<OrderResponse>


cancel()

cancel(orderId): Promise<OrderResponse>

Defined in: src/resources/Orders.ts:133

Parameters

orderId

string

Returns

Promise<OrderResponse>

Community project — not affiliated with Dhan. MIT License.