API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Orders

Place, monitor, and manage trading orders.

Get Orders

OrderGetOrdersResponse v1().orders().getOrders(OrderGetOrdersParamsparams = OrderGetOrdersParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/accounts/{account_id}/orders

Get Order By ID

OrderGetOrderByIdResponse v1().orders().getOrderById(OrderGetOrderByIdParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/accounts/{account_id}/orders/{order_id}

Submit Orders

OrderSubmitOrdersResponse v1().orders().submitOrders(OrderSubmitOrdersParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/accounts/{account_id}/orders

Replace Order

OrderReplaceOrderResponse v1().orders().replaceOrder(OrderReplaceOrderParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

PATCH/v1/accounts/{account_id}/orders/{order_id}

Cancel Open Order

OrderCancelOpenOrderResponse v1().orders().cancelOpenOrder(OrderCancelOpenOrderParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/accounts/{account_id}/orders/{order_id}

Cancel All Open Orders

OrderCancelAllOpenOrdersResponse v1().orders().cancelAllOpenOrders(OrderCancelAllOpenOrdersParamsparams = OrderCancelAllOpenOrdersParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/accounts/{account_id}/orders

ModelsExpand Collapse

class CancelOrderRequest:

Request to cancel an existing order

Note: In the API, order cancellation is done via DELETE request without a body. The order_id and account_id come from the URL path parameters.

long accountId

Account ID (from path parameter)

formatint64

String orderId

Order ID to cancel (from path parameter)

class NewOrderRequest:

Request to submit a new order (PlaceOrderRequest from spec)

SecurityType instrumentType

Type of security

One of the following:

COMMON_STOCK("COMMON_STOCK")

PREFERRED_STOCK("PREFERRED_STOCK")

OPTION("OPTION")

CASH("CASH")

OTHER("OTHER")

RequestOrderType orderType

Type of order

One of the following:

MARKET("MARKET")

LIMIT("LIMIT")

STOP("STOP")

STOP_LIMIT("STOP_LIMIT")

TRAILING_STOP("TRAILING_STOP")

TRAILING_STOP_LIMIT("TRAILING_STOP_LIMIT")

String quantity

Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer)

Side side

Side of the order

One of the following:

BUY("BUY")

SELL("SELL")

SELL_SHORT("SELL_SHORT")

OTHER("OTHER")

RequestTimeInForce timeInForce

Time in force

One of the following:

DAY("DAY")

GOOD_TILL_CANCEL("GOOD_TILL_CANCEL")

IMMEDIATE_OR_CANCEL("IMMEDIATE_OR_CANCEL")

FILL_OR_KILL("FILL_OR_KILL")

GOOD_TILL_DATE("GOOD_TILL_DATE")

AT_THE_OPENING("AT_THE_OPENING")

AT_THE_CLOSE("AT_THE_CLOSE")

GOOD_TILL_CROSSING("GOOD_TILL_CROSSING")

GOOD_THROUGH_CROSSING("GOOD_THROUGH_CROSSING")

AT_CROSSING("AT_CROSSING")

Optional<String> id

Optional client-provided unique ID (idempotency). Required to be unique per account.

maxLength64

Optional<LocalDateTime> expiresAt

The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.

formatdate-time

Optional<Boolean> extendedHours

Allow trading outside regular trading hours. Some brokers disallow options outside RTH.

Optional<String> instrumentId

OEMS instrument UUID

formatuuid

Optional<String> limitOffset

Limit offset for trailing stop-limit orders (signed)

Optional<String> limitPrice

Limit price (required for LIMIT and STOP_LIMIT orders)

Optional<PositionEffect> positionEffect

Required when instrument_type is OPTION. Specifies whether the order opens or closes a position.

One of the following:

OPEN("OPEN")

CLOSE("CLOSE")

Optional<String> stopPrice

Stop price (required for STOP and STOP_LIMIT orders)

Optional<String> symbol

Trading symbol. For equities, use the ticker symbol (e.g., “AAPL”). For options, use the OSI symbol (e.g., “AAPL 250117C00190000”). Either symbol or instrument_id must be provided.

Optional<String> trailingOffset

Trailing offset amount (required for trailing orders)

Optional<TrailingOffsetType> trailingOffsetType

Trailing offset type (PRICE or PERCENT_BPS)

One of the following:

PRICE("PRICE")

BPS("BPS")

class Order:

A trading order with its current state and execution details.

This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.

String id

Engine-assigned unique identifier for this order (UUID).

long accountId

Account placing the order

formatint64

String clientOrderId

Client-provided identifier echoed back (FIX tag 11).

LocalDateTime createdAt

Timestamp when order was created (UTC)

formatdate-time

String filledQuantity

Cumulative filled quantity

String instrumentId

OEMS instrument UUID for the traded instrument.

formatuuid

SecurityType instrumentType

Type of security

One of the following:

COMMON_STOCK("COMMON_STOCK")

PREFERRED_STOCK("PREFERRED_STOCK")

OPTION("OPTION")

CASH("CASH")

OTHER("OTHER")

String leavesQuantity

Remaining unfilled quantity

OrderType orderType

Type of order (MARKET, LIMIT, etc.)

One of the following:

MARKET("MARKET")

LIMIT("LIMIT")

STOP("STOP")

STOP_LIMIT("STOP_LIMIT")

TRAILING_STOP("TRAILING_STOP")

TRAILING_STOP_LIMIT("TRAILING_STOP_LIMIT")

OTHER("OTHER")

String quantity

Total order quantity

Side side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:

BUY("BUY")

SELL("SELL")

SELL_SHORT("SELL_SHORT")

OTHER("OTHER")

OrderStatus status

Current status of the order

One of the following:

PENDING_NEW("PENDING_NEW")

NEW("NEW")

PARTIALLY_FILLED("PARTIALLY_FILLED")

FILLED("FILLED")

CANCELED("CANCELED")

REJECTED("REJECTED")

EXPIRED("EXPIRED")

PENDING_CANCEL("PENDING_CANCEL")

PENDING_REPLACE("PENDING_REPLACE")

REPLACED("REPLACED")

DONE_FOR_DAY("DONE_FOR_DAY")

STOPPED("STOPPED")

SUSPENDED("SUSPENDED")

CALCULATED("CALCULATED")

OTHER("OTHER")

String symbol

Trading symbol

TimeInForce timeInForce

Time in force instruction

One of the following:

DAY("DAY")

GOOD_TILL_CANCEL("GOOD_TILL_CANCEL")

IMMEDIATE_OR_CANCEL("IMMEDIATE_OR_CANCEL")

FILL_OR_KILL("FILL_OR_KILL")

GOOD_TILL_DATE("GOOD_TILL_DATE")

AT_THE_OPENING("AT_THE_OPENING")

AT_THE_CLOSE("AT_THE_CLOSE")

GOOD_TILL_CROSSING("GOOD_TILL_CROSSING")

GOOD_THROUGH_CROSSING("GOOD_THROUGH_CROSSING")

AT_CROSSING("AT_CROSSING")

OTHER("OTHER")

LocalDateTime updatedAt

Timestamp of the most recent update (UTC)

formatdate-time

String venue

MIC code of the venue where the order is routed

Optional<String> averageFillPrice

Average fill price across all executions

Optional<List<String>> details

Contains execution, rejection or cancellation details, if any

Optional<LocalDateTime> expiresAt

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time

Optional<Boolean> extendedHours

Whether the order is eligible for extended-hours trading.

Optional<String> limitOffset

Limit offset for trailing stop-limit orders (signed)

Optional<String> limitPrice

Limit price (for LIMIT and STOP_LIMIT orders)

Optional<QueueState> queueState

Parent order queue state, present when the order is awaiting release or released.

One of the following:

AWAITING_RELEASE("AWAITING_RELEASE")

RELEASED("RELEASED")

Optional<LocalDateTime> releasesAt

Scheduled release time for orders awaiting release.

formatdate-time

Optional<String> stopPrice

Stop price (for STOP and STOP_LIMIT orders)

Optional<String> trailingLimitPx

Current trailing limit price computed by the trailing strategy

Optional<String> trailingOffset

Trailing offset amount for trailing orders

Optional<TrailingOffsetType> trailingOffsetType

Trailing offset type for trailing orders

One of the following:

PRICE("PRICE")

BPS("BPS")

Optional<String> trailingStopPx

Current trailing stop price computed by the trailing strategy

Optional<String> trailingWatermarkPx

Trailing watermark price for trailing orders

Optional<LocalDateTime> trailingWatermarkTs

Trailing watermark timestamp for trailing orders

formatdate-time

Optional<String> underlyingInstrumentId

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid

enum OrderStatus:

Order status

PENDING_NEW("PENDING_NEW")

NEW("NEW")

PARTIALLY_FILLED("PARTIALLY_FILLED")

FILLED("FILLED")

CANCELED("CANCELED")

REJECTED("REJECTED")

EXPIRED("EXPIRED")

PENDING_CANCEL("PENDING_CANCEL")

PENDING_REPLACE("PENDING_REPLACE")

REPLACED("REPLACED")

DONE_FOR_DAY("DONE_FOR_DAY")

STOPPED("STOPPED")

SUSPENDED("SUSPENDED")

CALCULATED("CALCULATED")

OTHER("OTHER")

enum OrderType:

Order type

MARKET("MARKET")

LIMIT("LIMIT")

STOP("STOP")

STOP_LIMIT("STOP_LIMIT")

TRAILING_STOP("TRAILING_STOP")

TRAILING_STOP_LIMIT("TRAILING_STOP_LIMIT")

OTHER("OTHER")

enum PositionEffect:

Position effect for options orders

OPEN("OPEN")

CLOSE("CLOSE")

enum QueueState:

Parent order queue or hold state.

AWAITING_RELEASE("AWAITING_RELEASE")

RELEASED("RELEASED")

enum RequestOrderType:

Strict order-type enum for order submission/replacement requests.

MARKET("MARKET")

LIMIT("LIMIT")

STOP("STOP")

STOP_LIMIT("STOP_LIMIT")

TRAILING_STOP("TRAILING_STOP")

TRAILING_STOP_LIMIT("TRAILING_STOP_LIMIT")

enum RequestTimeInForce:

Strict time-in-force enum for order submission/replacement requests.

DAY("DAY")

GOOD_TILL_CANCEL("GOOD_TILL_CANCEL")

IMMEDIATE_OR_CANCEL("IMMEDIATE_OR_CANCEL")

FILL_OR_KILL("FILL_OR_KILL")

GOOD_TILL_DATE("GOOD_TILL_DATE")

AT_THE_OPENING("AT_THE_OPENING")

AT_THE_CLOSE("AT_THE_CLOSE")

GOOD_TILL_CROSSING("GOOD_TILL_CROSSING")

GOOD_THROUGH_CROSSING("GOOD_THROUGH_CROSSING")

AT_CROSSING("AT_CROSSING")

enum Side:

Side of an order

BUY("BUY")

SELL("SELL")

SELL_SHORT("SELL_SHORT")

OTHER("OTHER")

enum TimeInForce:

Time in force

DAY("DAY")

GOOD_TILL_CANCEL("GOOD_TILL_CANCEL")

IMMEDIATE_OR_CANCEL("IMMEDIATE_OR_CANCEL")

FILL_OR_KILL("FILL_OR_KILL")

GOOD_TILL_DATE("GOOD_TILL_DATE")

AT_THE_OPENING("AT_THE_OPENING")

AT_THE_CLOSE("AT_THE_CLOSE")

GOOD_TILL_CROSSING("GOOD_TILL_CROSSING")

GOOD_THROUGH_CROSSING("GOOD_THROUGH_CROSSING")

AT_CROSSING("AT_CROSSING")

OTHER("OTHER")

enum TrailingOffsetType:

Trailing offset type for trailing stop orders.

PRICE("PRICE")

BPS("BPS")