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

client.V1.Orders.GetOrders(ctx, accountID, query) (*V1OrderGetOrdersResponse, error)

GET/v1/accounts/{account_id}/orders

Get Order By ID

client.V1.Orders.GetOrderByID(ctx, orderID, query) (*V1OrderGetOrderByIDResponse, error)

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

Submit Orders

client.V1.Orders.SubmitOrders(ctx, accountID, body) (*V1OrderSubmitOrdersResponse, error)

POST/v1/accounts/{account_id}/orders

Replace Order

client.V1.Orders.ReplaceOrder(ctx, orderID, params) (*V1OrderReplaceOrderResponse, error)

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

Cancel Open Order

client.V1.Orders.CancelOpenOrder(ctx, orderID, body) (*V1OrderCancelOpenOrderResponse, error)

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

Cancel All Open Orders

client.V1.Orders.CancelAllOpenOrders(ctx, accountID, body) (*V1OrderCancelAllOpenOrdersResponse, error)

DELETE/v1/accounts/{account_id}/orders

Get Executions

client.V1.Orders.GetExecutions(ctx, accountID, query) (*V1OrderGetExecutionsResponse, error)

GET/v1/accounts/{account_id}/executions

ModelsExpand Collapse

type CancelOrderRequest struct{…}

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.

AccountID int64

Account ID (from path parameter)

formatint64

OrderID string

Order ID to cancel (from path parameter)

type Execution struct{…}

Represents a single fill of an order for an account.

ID string

Unique identifier for this execution report.

formatuuid

InstrumentID string

Unique instrument identifier.

formatuuid

OrderID string

Identifier of the order this execution belongs to.

formatuuid

Price string

Fill price.

Quantity string

Filled quantity.

Side Side

Side of the fill.

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

const SideSellShort Side = "SELL_SHORT"

const SideOther Side = "OTHER"

Symbol string

Trading symbol.

TransactionTime Time

Transaction timestamp in nanosecond precision (UTC).

formatdate-time

type ExecutionList []Execution

ID string

Unique identifier for this execution report.

formatuuid

InstrumentID string

Unique instrument identifier.

formatuuid

OrderID string

Identifier of the order this execution belongs to.

formatuuid

Price string

Fill price.

Quantity string

Filled quantity.

Side Side

Side of the fill.

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

const SideSellShort Side = "SELL_SHORT"

const SideOther Side = "OTHER"

Symbol string

Trading symbol.

TransactionTime Time

Transaction timestamp in nanosecond precision (UTC).

formatdate-time

type InstrumentIDOrSymbol string

Instrument identifier

type NewOrderRequest struct{…}

Request to submit a new order (PlaceOrderRequest from spec)

OrderType RequestOrderType

Type of order

One of the following:

const RequestOrderTypeMarket RequestOrderType = "MARKET"

const RequestOrderTypeLimit RequestOrderType = "LIMIT"

const RequestOrderTypeStop RequestOrderType = "STOP"

const RequestOrderTypeStopLimit RequestOrderType = "STOP_LIMIT"

const RequestOrderTypeTrailingStop RequestOrderType = "TRAILING_STOP"

const RequestOrderTypeTrailingStopLimit RequestOrderType = "TRAILING_STOP_LIMIT"

Quantity string

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:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

const SideSellShort Side = "SELL_SHORT"

const SideOther Side = "OTHER"

TimeInForce RequestTimeInForce

Time in force

One of the following:

const RequestTimeInForceDay RequestTimeInForce = "DAY"

const RequestTimeInForceGoodTillCancel RequestTimeInForce = "GOOD_TILL_CANCEL"

const RequestTimeInForceImmediateOrCancel RequestTimeInForce = "IMMEDIATE_OR_CANCEL"

const RequestTimeInForceFillOrKill RequestTimeInForce = "FILL_OR_KILL"

const RequestTimeInForceGoodTillDate RequestTimeInForce = "GOOD_TILL_DATE"

const RequestTimeInForceAtTheOpening RequestTimeInForce = "AT_THE_OPENING"

const RequestTimeInForceAtTheClose RequestTimeInForce = "AT_THE_CLOSE"

const RequestTimeInForceGoodTillCrossing RequestTimeInForce = "GOOD_TILL_CROSSING"

const RequestTimeInForceGoodThroughCrossing RequestTimeInForce = "GOOD_THROUGH_CROSSING"

const RequestTimeInForceAtCrossing RequestTimeInForce = "AT_CROSSING"

ID stringOptional

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

maxLength64

ExpiresAt TimeOptional

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

formatdate-time

ExtendedHours boolOptional

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

InstrumentID InstrumentIDOrSymbolOptional

Instrument identifier

formatuuid

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

Limit price (required for LIMIT and STOP_LIMIT orders)

PositionEffect PositionEffectOptional

Required for options. Specifies whether the order opens or closes a position.

One of the following:

const PositionEffectOpen PositionEffect = "OPEN"

const PositionEffectClose PositionEffect = "CLOSE"

StopPrice stringOptional

Stop price (required for STOP and STOP_LIMIT orders)

Symbol stringOptional

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

TrailingOffset stringOptional

Trailing offset amount (required for trailing orders)

TrailingOffsetType TrailingOffsetTypeOptional

Trailing offset type (PRICE or PERCENT_BPS)

One of the following:

const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"

const TrailingOffsetTypeBps TrailingOffsetType = "BPS"

type Order struct{…}

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.

ID string

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

AccountID int64

Account placing the order

formatint64

ClientOrderID string

Client-provided identifier echoed back.

CreatedAt Time

Timestamp when order was created (UTC)

formatdate-time

FilledQuantity string

Cumulative filled quantity

InstrumentID string

Instrument identifier for the traded instrument.

formatuuid

InstrumentType SecurityType

Type of security

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

LeavesQuantity string

Remaining unfilled quantity

OrderType OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:

const OrderTypeMarket OrderType = "MARKET"

const OrderTypeLimit OrderType = "LIMIT"

const OrderTypeStop OrderType = "STOP"

const OrderTypeStopLimit OrderType = "STOP_LIMIT"

const OrderTypeTrailingStop OrderType = "TRAILING_STOP"

const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"

const OrderTypeOther OrderType = "OTHER"

Quantity string

Total order quantity

Side Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

const SideSellShort Side = "SELL_SHORT"

const SideOther Side = "OTHER"

Status OrderStatus

Current status of the order

One of the following:

const OrderStatusPendingNew OrderStatus = "PENDING_NEW"

const OrderStatusNew OrderStatus = "NEW"

const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"

const OrderStatusFilled OrderStatus = "FILLED"

const OrderStatusCanceled OrderStatus = "CANCELED"

const OrderStatusRejected OrderStatus = "REJECTED"

const OrderStatusExpired OrderStatus = "EXPIRED"

const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"

const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"

const OrderStatusReplaced OrderStatus = "REPLACED"

const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"

const OrderStatusStopped OrderStatus = "STOPPED"

const OrderStatusSuspended OrderStatus = "SUSPENDED"

const OrderStatusCalculated OrderStatus = "CALCULATED"

const OrderStatusOther OrderStatus = "OTHER"

Symbol string

Trading symbol

TimeInForce TimeInForce

Time in force instruction

One of the following:

const TimeInForceDay TimeInForce = "DAY"

const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"

const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"

const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"

const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"

const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"

const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"

const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"

const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"

const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"

const TimeInForceOther TimeInForce = "OTHER"

UpdatedAt Time

Timestamp of the most recent update (UTC)

formatdate-time

Venue string

MIC code of the venue where the order is routed

AverageFillPrice stringOptional

Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.

Details []stringOptional

Contains execution, rejection or cancellation details, if any

ExpiresAt TimeOptional

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

ExtendedHours boolOptional

Whether the order is eligible for extended-hours trading.

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.

LimitPrice stringOptional

Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

QueueState QueueStateOptional

Parent order queue state, present when the order is awaiting release or released. When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"

const QueueStateReleased QueueState = "RELEASED"

ReleasesAt TimeOptional

Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

StopPrice stringOptional

Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

TrailingLimitPx stringOptional

Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

TrailingOffset stringOptional

Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.

TrailingOffsetType TrailingOffsetTypeOptional

Trailing offset type for trailing orders When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"

const TrailingOffsetTypeBps TrailingOffsetType = "BPS"

TrailingStopPx stringOptional

Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

TrailingWatermarkPx stringOptional

Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.

TrailingWatermarkTs TimeOptional

Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

UnderlyingInstrumentID stringOptional

Instrument ID of the option’s underlying instrument. Populated only for options orders. A null means one of two things: the order is not an option, so the field does not apply; or the order is an option whose underlier has not yet been resolved. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

type OrderList []Order

ID string

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

AccountID int64

Account placing the order

formatint64

ClientOrderID string

Client-provided identifier echoed back.

CreatedAt Time

Timestamp when order was created (UTC)

formatdate-time

FilledQuantity string

Cumulative filled quantity

InstrumentID string

Instrument identifier for the traded instrument.

formatuuid

InstrumentType SecurityType

Type of security

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

LeavesQuantity string

Remaining unfilled quantity

OrderType OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:

const OrderTypeMarket OrderType = "MARKET"

const OrderTypeLimit OrderType = "LIMIT"

const OrderTypeStop OrderType = "STOP"

const OrderTypeStopLimit OrderType = "STOP_LIMIT"

const OrderTypeTrailingStop OrderType = "TRAILING_STOP"

const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"

const OrderTypeOther OrderType = "OTHER"

Quantity string

Total order quantity

Side Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

const SideSellShort Side = "SELL_SHORT"

const SideOther Side = "OTHER"

Status OrderStatus

Current status of the order

One of the following:

const OrderStatusPendingNew OrderStatus = "PENDING_NEW"

const OrderStatusNew OrderStatus = "NEW"

const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"

const OrderStatusFilled OrderStatus = "FILLED"

const OrderStatusCanceled OrderStatus = "CANCELED"

const OrderStatusRejected OrderStatus = "REJECTED"

const OrderStatusExpired OrderStatus = "EXPIRED"

const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"

const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"

const OrderStatusReplaced OrderStatus = "REPLACED"

const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"

const OrderStatusStopped OrderStatus = "STOPPED"

const OrderStatusSuspended OrderStatus = "SUSPENDED"

const OrderStatusCalculated OrderStatus = "CALCULATED"

const OrderStatusOther OrderStatus = "OTHER"

Symbol string

Trading symbol

TimeInForce TimeInForce

Time in force instruction

One of the following:

const TimeInForceDay TimeInForce = "DAY"

const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"

const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"

const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"

const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"

const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"

const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"

const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"

const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"

const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"

const TimeInForceOther TimeInForce = "OTHER"

UpdatedAt Time

Timestamp of the most recent update (UTC)

formatdate-time

Venue string

MIC code of the venue where the order is routed

AverageFillPrice stringOptional

Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.

Details []stringOptional

Contains execution, rejection or cancellation details, if any

ExpiresAt TimeOptional

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

ExtendedHours boolOptional

Whether the order is eligible for extended-hours trading.

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.

LimitPrice stringOptional

Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

QueueState QueueStateOptional

Parent order queue state, present when the order is awaiting release or released. When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"

const QueueStateReleased QueueState = "RELEASED"

ReleasesAt TimeOptional

Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

StopPrice stringOptional

Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

TrailingLimitPx stringOptional

Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

TrailingOffset stringOptional

Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.

TrailingOffsetType TrailingOffsetTypeOptional

Trailing offset type for trailing orders When a null/undefined value is observed, it indicates it does not apply.

One of the following:

const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"

const TrailingOffsetTypeBps TrailingOffsetType = "BPS"

TrailingStopPx stringOptional

Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

TrailingWatermarkPx stringOptional

Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.

TrailingWatermarkTs TimeOptional

Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

UnderlyingInstrumentID stringOptional

Instrument ID of the option’s underlying instrument. Populated only for options orders. A null means one of two things: the order is not an option, so the field does not apply; or the order is an option whose underlier has not yet been resolved. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

type OrderStatus string

Order status

One of the following:

const OrderStatusPendingNew OrderStatus = "PENDING_NEW"

const OrderStatusNew OrderStatus = "NEW"

const OrderStatusPartiallyFilled OrderStatus = "PARTIALLY_FILLED"

const OrderStatusFilled OrderStatus = "FILLED"

const OrderStatusCanceled OrderStatus = "CANCELED"

const OrderStatusRejected OrderStatus = "REJECTED"

const OrderStatusExpired OrderStatus = "EXPIRED"

const OrderStatusPendingCancel OrderStatus = "PENDING_CANCEL"

const OrderStatusPendingReplace OrderStatus = "PENDING_REPLACE"

const OrderStatusReplaced OrderStatus = "REPLACED"

const OrderStatusDoneForDay OrderStatus = "DONE_FOR_DAY"

const OrderStatusStopped OrderStatus = "STOPPED"

const OrderStatusSuspended OrderStatus = "SUSPENDED"

const OrderStatusCalculated OrderStatus = "CALCULATED"

const OrderStatusOther OrderStatus = "OTHER"

type OrderType string

Order type

One of the following:

const OrderTypeMarket OrderType = "MARKET"

const OrderTypeLimit OrderType = "LIMIT"

const OrderTypeStop OrderType = "STOP"

const OrderTypeStopLimit OrderType = "STOP_LIMIT"

const OrderTypeTrailingStop OrderType = "TRAILING_STOP"

const OrderTypeTrailingStopLimit OrderType = "TRAILING_STOP_LIMIT"

const OrderTypeOther OrderType = "OTHER"

type PositionEffect string

Position effect for options orders

One of the following:

const PositionEffectOpen PositionEffect = "OPEN"

const PositionEffectClose PositionEffect = "CLOSE"

type QueueState string

Parent order queue or hold state.

One of the following:

const QueueStateAwaitingRelease QueueState = "AWAITING_RELEASE"

const QueueStateReleased QueueState = "RELEASED"

type RequestOrderType string

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

One of the following:

const RequestOrderTypeMarket RequestOrderType = "MARKET"

const RequestOrderTypeLimit RequestOrderType = "LIMIT"

const RequestOrderTypeStop RequestOrderType = "STOP"

const RequestOrderTypeStopLimit RequestOrderType = "STOP_LIMIT"

const RequestOrderTypeTrailingStop RequestOrderType = "TRAILING_STOP"

const RequestOrderTypeTrailingStopLimit RequestOrderType = "TRAILING_STOP_LIMIT"

type RequestTimeInForce string

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

One of the following:

const RequestTimeInForceDay RequestTimeInForce = "DAY"

const RequestTimeInForceGoodTillCancel RequestTimeInForce = "GOOD_TILL_CANCEL"

const RequestTimeInForceImmediateOrCancel RequestTimeInForce = "IMMEDIATE_OR_CANCEL"

const RequestTimeInForceFillOrKill RequestTimeInForce = "FILL_OR_KILL"

const RequestTimeInForceGoodTillDate RequestTimeInForce = "GOOD_TILL_DATE"

const RequestTimeInForceAtTheOpening RequestTimeInForce = "AT_THE_OPENING"

const RequestTimeInForceAtTheClose RequestTimeInForce = "AT_THE_CLOSE"

const RequestTimeInForceGoodTillCrossing RequestTimeInForce = "GOOD_TILL_CROSSING"

const RequestTimeInForceGoodThroughCrossing RequestTimeInForce = "GOOD_THROUGH_CROSSING"

const RequestTimeInForceAtCrossing RequestTimeInForce = "AT_CROSSING"

type Side string

Side of an order

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

const SideSellShort Side = "SELL_SHORT"

const SideOther Side = "OTHER"

type TimeInForce string

Time in force

One of the following:

const TimeInForceDay TimeInForce = "DAY"

const TimeInForceGoodTillCancel TimeInForce = "GOOD_TILL_CANCEL"

const TimeInForceImmediateOrCancel TimeInForce = "IMMEDIATE_OR_CANCEL"

const TimeInForceFillOrKill TimeInForce = "FILL_OR_KILL"

const TimeInForceGoodTillDate TimeInForce = "GOOD_TILL_DATE"

const TimeInForceAtTheOpening TimeInForce = "AT_THE_OPENING"

const TimeInForceAtTheClose TimeInForce = "AT_THE_CLOSE"

const TimeInForceGoodTillCrossing TimeInForce = "GOOD_TILL_CROSSING"

const TimeInForceGoodThroughCrossing TimeInForce = "GOOD_THROUGH_CROSSING"

const TimeInForceAtCrossing TimeInForce = "AT_CROSSING"

const TimeInForceOther TimeInForce = "OTHER"

type TrailingOffsetType string

Trailing offset type for trailing stop orders.

One of the following:

const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"

const TrailingOffsetTypeBps TrailingOffsetType = "BPS"