Class OrderApi

API for managing orders - place, cancel, modify, and search.

Example

// Place a market order
const result = await client.orders.place({
  accountId: 123,
  contractId: 'CON.F.US.ENQ.M25',
  type: OrderType.Market,
  side: OrderSide.Buy,
  size: 1,
});

// Cancel an order
await client.orders.cancel({ accountId: 123, orderId: result.orderId });

Index

Methods

cancel modify place search searchOpen

Methods

cancel

cancel(request: CancelOrderRequest): Promise<CancelOrderResponse>
Cancel an existing order.
Parameters
- request: CancelOrderRequest
  Request containing accountId and orderId to cancel
Returns Promise<CancelOrderResponse>
Response indicating success or failure
- Defined in src/rest/order/order.api.ts:104

modify

modify(request: ModifyOrderRequest): Promise<ModifyOrderResponse>
Modify an existing order's size or price.
Parameters
- request: ModifyOrderRequest
  Request containing orderId and fields to modify
Returns Promise<ModifyOrderResponse>
Response indicating success or failure
- Defined in src/rest/order/order.api.ts:116

place

place(request: PlaceOrderRequest): Promise<PlaceOrderResponse>

Place a new order.

Parameters

request: PlaceOrderRequest
Order details including type, side, size, and prices

Returns Promise<PlaceOrderResponse>

Response containing the new orderId

Example

// Market order
await client.orders.place({
  accountId: 123,
  contractId: 'CON.F.US.ENQ.M25',
  type: OrderType.Market,
  side: OrderSide.Buy,
  size: 1,
});

// Limit order
await client.orders.place({
  accountId: 123,
  contractId: 'CON.F.US.ENQ.M25',
  type: OrderType.Limit,
  side: OrderSide.Buy,
  size: 1,
  limitPrice: 5000.00,
});

search

search(request: SearchOrdersRequest): Promise<Order[]>
Search historical orders within a date range.
Parameters
- request: SearchOrdersRequest
  Search parameters including accountId and optional date range
Returns Promise<Order[]>
Array of orders matching the search criteria
- Defined in src/rest/order/order.api.ts:44

searchOpen

searchOpen(request: SearchOpenOrdersRequest): Promise<Order[]>
Get all currently open (working) orders for an account.
Parameters
- request: SearchOpenOrdersRequest
  Request containing the accountId
Returns Promise<Order[]>
Array of open orders
- Defined in src/rest/order/order.api.ts:57

Class OrderApi

Example

Index

Methods

Methods

cancel

Parameters

Returns Promise<CancelOrderResponse>

modify

Parameters

Returns Promise<ModifyOrderResponse>

place

Parameters

Returns Promise<PlaceOrderResponse>

Example

search

Parameters

Returns Promise<Order[]>

searchOpen

Parameters

Returns Promise<Order[]>

Settings

On This Page