Skip to content
Start Trading

Orders

Place, monitor, and manage trading orders.

Get Orders
v1.orders.get_orders(intaccount_id, OrderGetOrdersParams**kwargs) -> OrderGetOrdersResponse
GET/v1/accounts/{account_id}/orders
Get Order By ID
v1.orders.get_order_by_id(strorder_id, OrderGetOrderByIDParams**kwargs) -> OrderGetOrderByIDResponse
GET/v1/accounts/{account_id}/orders/{order_id}
Submit Orders
v1.orders.submit_orders(intaccount_id, OrderSubmitOrdersParams**kwargs) -> OrderSubmitOrdersResponse
POST/v1/accounts/{account_id}/orders
Replace Order
v1.orders.replace_order(strorder_id, OrderReplaceOrderParams**kwargs) -> OrderReplaceOrderResponse
PATCH/v1/accounts/{account_id}/orders/{order_id}
Cancel Open Order
v1.orders.cancel_open_order(strorder_id, OrderCancelOpenOrderParams**kwargs) -> OrderCancelOpenOrderResponse
DELETE/v1/accounts/{account_id}/orders/{order_id}
Cancel All Open Orders
v1.orders.cancel_all_open_orders(intaccount_id, OrderCancelAllOpenOrdersParams**kwargs) -> OrderCancelAllOpenOrdersResponse
DELETE/v1/accounts/{account_id}/orders
Get Executions
v1.orders.get_executions(intaccount_id, OrderGetExecutionsParams**kwargs) -> OrderGetExecutionsResponse
GET/v1/accounts/{account_id}/executions
Preview Orders
v1.orders.preview_orders(intaccount_id, OrderPreviewOrdersParams**kwargs) -> OrderPreviewOrdersResponse
POST/v1/accounts/{account_id}/orders/preview
ModelsExpand Collapse
class Execution: …

Represents a single fill of an order for an account.

id: str

Unique identifier for this execution report.

formatuuid
order_id: str

Identifier of the order this execution belongs to.

formatuuid
quantity: str

Filled quantity. For a strategy-level multileg fill this is the net strategy quantity, not a per-leg quantity.

side: Side

Side of the fill.

One of the following:
"BUY"
"SELL"
transaction_time: datetime

Transaction timestamp in nanosecond precision (UTC).

formatdate-time
instrument_id: Optional[str]

Unique instrument identifier. null when this is a strategy-level multileg fill whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
price: Optional[str]

Fill price. null for multileg fills, whose price lives only at the leg level. When a null/undefined value is observed, it indicates it does not apply.

symbol: Optional[str]

Trading symbol. null when this is a strategy-level multileg fill whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

underlying_instrument_id: Optional[str]

Underlying instrument identifier for an option fill. Omitted for a non-derivative fill, when the underlier could not be resolved, or for a multileg fill (per-leg underliers live in legs[]). When a null/undefined value is observed, it indicates it does not apply.

formatuuid
underlying_instrument_type: Optional[SecurityType]

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
venue: Optional[str]

Venue where this fill occurred, as reported by that venue. Distinct from an order’s venue, which is the routing destination. Codes are not normalized, so the format varies by venue. When a null/undefined value is observed, it indicates that there is no available data.

List[Execution]
id: str

Unique identifier for this execution report.

formatuuid
order_id: str

Identifier of the order this execution belongs to.

formatuuid
quantity: str

Filled quantity. For a strategy-level multileg fill this is the net strategy quantity, not a per-leg quantity.

side: Side

Side of the fill.

One of the following:
"BUY"
"SELL"
transaction_time: datetime

Transaction timestamp in nanosecond precision (UTC).

formatdate-time
instrument_id: Optional[str]

Unique instrument identifier. null when this is a strategy-level multileg fill whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
price: Optional[str]

Fill price. null for multileg fills, whose price lives only at the leg level. When a null/undefined value is observed, it indicates it does not apply.

symbol: Optional[str]

Trading symbol. null when this is a strategy-level multileg fill whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

underlying_instrument_id: Optional[str]

Underlying instrument identifier for an option fill. Omitted for a non-derivative fill, when the underlier could not be resolved, or for a multileg fill (per-leg underliers live in legs[]). When a null/undefined value is observed, it indicates it does not apply.

formatuuid
underlying_instrument_type: Optional[SecurityType]

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
venue: Optional[str]

Venue where this fill occurred, as reported by that venue. Distinct from an order’s venue, which is the routing destination. Codes are not normalized, so the format varies by venue. When a null/undefined value is observed, it indicates that there is no available data.

str

Instrument identifier: either an instrument UUID or a symbol (symbol for equities, OSI for options). Non-UUID inputs are resolved server-side.

class NewOrderRequest: …

Request to submit a new order

order_type: RequestOrderType

Type of order

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
quantity: str

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"
"SELL"
time_in_force: RequestTimeInForce

Time in force

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_OPEN"
"AT_CLOSE"
id: Optional[str]

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

maxLength64
expires_at: Optional[datetime]

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

formatdate-time
extended_hours: Optional[bool]

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

instrument_id: Optional[InstrumentIDOrSymbol]

Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.

minLength1
limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

Limit price (required for LIMIT and STOP_LIMIT orders)

position_intent: Optional[RequestPositionEffect]

Optional open/close intent for this order. When omitted, the platform determines the position effect.

One of the following:
"OPEN"
"CLOSE"
stop_price: Optional[str]

Stop price (required for STOP and STOP_LIMIT orders)

strategy: Optional[OrderStrategy]

Optional execution strategy. One of SOR, VWAP, TWAP, or DMA. Defaults to SOR, the only strategy OTC common-stock orders support. VWAP and TWAP are supported only on MARKET and LIMIT orders, and DMA only on LIMIT orders; all three require DAY time-in-force. VWAP, TWAP, and DMA do not support extended_hours.

One of the following:
class Type: …

Smart Order Router. Routes the order to the best available venue(s).

type: Literal["SOR"]

Execution strategy type.

class UnionMember1: …

Volume-Weighted Average Price. Works the order to track the volume-weighted average price over the execution window.

type: Literal["VWAP"]

Execution strategy type.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time
class UnionMember2: …

Time-Weighted Average Price. Spreads execution evenly across the execution window.

type: Literal["TWAP"]

Execution strategy type.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time
class UnionMember3: …

Direct Market Access. Routes the order straight to the named venue.

destination: str

Venue code the order is routed to.

type: Literal["DMA"]

Execution strategy type.

symbol: Optional[str]

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.

trailing_offset: Optional[str]

Trailing offset amount (required for trailing orders)

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type (PRICE or PERCENT_BPS)

One of the following:
"PRICE"
"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.

id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

Client-provided identifier echoed back.

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

leaves_quantity: str

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: str

Total order quantity

side: Side

Side of the order (BUY or SELL)

One of the following:
"BUY"
"SELL"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"QUEUED"
"PENDING_TRIGGER"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_OPEN"
"AT_CLOSE"
"OTHER"
updated_at: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. When a null/undefined value is observed, it indicates that there is no available data.

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

instrument_id: Optional[str]

Instrument identifier for the traded instrument. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
instrument_type: Optional[SecurityType]

Type of security. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
limit_offset: Optional[str]

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

limit_price: Optional[str]

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

releases_at: Optional[datetime]

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

formatdate-time
stop_price: Optional[str]

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

strategy: Optional[Strategy]

The execution strategy the order was submitted with, if any.

type: Literal["SOR", "VWAP", "TWAP", "DMA"]

Execution strategy type.

One of the following:
"SOR"
"VWAP"
"TWAP"
"DMA"
destination: Optional[str]

Venue code the order is routed to. DMA only.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution ends.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution begins.

formatdate-time
symbol: Optional[str]

Trading symbol. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

trailing_limit_px: Optional[str]

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

trailing_offset: Optional[str]

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

trailing_offset_type: Optional[TrailingOffsetType]

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

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

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

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time
underlying_instrument_id: Optional[str]

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
underlying_instrument_type: Optional[SecurityType]

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
List[Order]
id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

Client-provided identifier echoed back.

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

leaves_quantity: str

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: str

Total order quantity

side: Side

Side of the order (BUY or SELL)

One of the following:
"BUY"
"SELL"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"QUEUED"
"PENDING_TRIGGER"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_OPEN"
"AT_CLOSE"
"OTHER"
updated_at: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. When a null/undefined value is observed, it indicates that there is no available data.

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

instrument_id: Optional[str]

Instrument identifier for the traded instrument. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
instrument_type: Optional[SecurityType]

Type of security. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
limit_offset: Optional[str]

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

limit_price: Optional[str]

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

releases_at: Optional[datetime]

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

formatdate-time
stop_price: Optional[str]

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

strategy: Optional[Strategy]

The execution strategy the order was submitted with, if any.

type: Literal["SOR", "VWAP", "TWAP", "DMA"]

Execution strategy type.

One of the following:
"SOR"
"VWAP"
"TWAP"
"DMA"
destination: Optional[str]

Venue code the order is routed to. DMA only.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution ends.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution begins.

formatdate-time
symbol: Optional[str]

Trading symbol. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

trailing_limit_px: Optional[str]

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

trailing_offset: Optional[str]

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

trailing_offset_type: Optional[TrailingOffsetType]

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

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

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

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time
underlying_instrument_id: Optional[str]

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
underlying_instrument_type: Optional[SecurityType]

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
class OrderPreview: …

The projected impact of an order, as if it were submitted and fully filled.

account_id: int

The account the order was previewed for.

formatint64

Monetary size of the previewed order.

gross_amount: str

Total cash impact of the order before estimated fees and commissions.

net_amount: str

Total cash impact of the order after estimated fees and commissions.

buying_power: OrderPreviewDelta

Buying power before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

currency: str

Currency for all monetary values.

Account equity before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

errors: List[OrderPreviewError]

Risk-check errors that would prevent the order from being accepted. Empty when the order would pass every pre-trade risk check.

description: str

Human-readable description of the error.

metadata: Dict[str, str]

Structured details for the error (stringified values), e.g. required and available amounts, and leg_index/leg_symbol for multileg leg errors.

type: str

Stable error code.

Margin requirements and excess before and after the order.

initial_margin_excess: OrderPreviewDelta

Initial margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

initial_margin_requirement: OrderPreviewDelta

Initial margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_excess: OrderPreviewDelta

Maintenance margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_requirement: OrderPreviewDelta

Maintenance margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_excess: OrderPreviewDelta

Overnight margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_requirement: OrderPreviewDelta

Overnight margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

positions: List[OrderPreviewPosition]

Positions in the traded instruments before and after the order.

instrument_id: str

The instrument’s identifier.

formatuuid

Net position quantity before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

symbol: str

The instrument’s symbol.

class OrderPreviewAmount: …

Monetary size of the previewed order.

gross_amount: str

Total cash impact of the order before estimated fees and commissions.

net_amount: str

Total cash impact of the order after estimated fees and commissions.

class OrderPreviewDelta: …

Before/after values for one metric, as if the previewed order fully filled.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

One requested order’s entry in the batch response.

One of the following:
class UnionMember0: …

The order was previewed successfully.

preview: OrderPreview

The projected impact of the order.

account_id: int

The account the order was previewed for.

formatint64

Monetary size of the previewed order.

gross_amount: str

Total cash impact of the order before estimated fees and commissions.

net_amount: str

Total cash impact of the order after estimated fees and commissions.

buying_power: OrderPreviewDelta

Buying power before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

currency: str

Currency for all monetary values.

Account equity before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

errors: List[OrderPreviewError]

Risk-check errors that would prevent the order from being accepted. Empty when the order would pass every pre-trade risk check.

description: str

Human-readable description of the error.

metadata: Dict[str, str]

Structured details for the error (stringified values), e.g. required and available amounts, and leg_index/leg_symbol for multileg leg errors.

type: str

Stable error code.

Margin requirements and excess before and after the order.

initial_margin_excess: OrderPreviewDelta

Initial margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

initial_margin_requirement: OrderPreviewDelta

Initial margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_excess: OrderPreviewDelta

Maintenance margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_requirement: OrderPreviewDelta

Maintenance margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_excess: OrderPreviewDelta

Overnight margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_requirement: OrderPreviewDelta

Overnight margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

positions: List[OrderPreviewPosition]

Positions in the traded instruments before and after the order.

instrument_id: str

The instrument’s identifier.

formatuuid

Net position quantity before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

symbol: str

The instrument’s symbol.

id: Optional[str]

The client-provided id of the order this entry belongs to, echoed from the request. Always present when the request contains more than one order, since ids are required there.

class UnionMember1: …

The order could not be previewed. Shaped exactly like the top-level error object on rejected submissions.

error: APIError

Why this order’s preview failed.

code: int

The error code is used to identify the nature of the error. It corresponds to an HTTP status code.

formatint32
minimum0
message: str

A human-readable message providing more details about the error.

details: Optional[List[Dict[str, object]]]

Additional error details, if any. This can include structured information such as field violations or error metadata.

id: Optional[str]

The client-provided id of the order this entry belongs to, echoed from the request. Always present when the request contains more than one order, since ids are required there.

One of the following:
class UnionMember0: …

The order was previewed successfully.

preview: OrderPreview

The projected impact of the order.

account_id: int

The account the order was previewed for.

formatint64

Monetary size of the previewed order.

gross_amount: str

Total cash impact of the order before estimated fees and commissions.

net_amount: str

Total cash impact of the order after estimated fees and commissions.

buying_power: OrderPreviewDelta

Buying power before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

currency: str

Currency for all monetary values.

Account equity before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

errors: List[OrderPreviewError]

Risk-check errors that would prevent the order from being accepted. Empty when the order would pass every pre-trade risk check.

description: str

Human-readable description of the error.

metadata: Dict[str, str]

Structured details for the error (stringified values), e.g. required and available amounts, and leg_index/leg_symbol for multileg leg errors.

type: str

Stable error code.

Margin requirements and excess before and after the order.

initial_margin_excess: OrderPreviewDelta

Initial margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

initial_margin_requirement: OrderPreviewDelta

Initial margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_excess: OrderPreviewDelta

Maintenance margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_requirement: OrderPreviewDelta

Maintenance margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_excess: OrderPreviewDelta

Overnight margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_requirement: OrderPreviewDelta

Overnight margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

positions: List[OrderPreviewPosition]

Positions in the traded instruments before and after the order.

instrument_id: str

The instrument’s identifier.

formatuuid

Net position quantity before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

symbol: str

The instrument’s symbol.

id: Optional[str]

The client-provided id of the order this entry belongs to, echoed from the request. Always present when the request contains more than one order, since ids are required there.

class UnionMember1: …

The order could not be previewed. Shaped exactly like the top-level error object on rejected submissions.

error: APIError

Why this order’s preview failed.

code: int

The error code is used to identify the nature of the error. It corresponds to an HTTP status code.

formatint32
minimum0
message: str

A human-readable message providing more details about the error.

details: Optional[List[Dict[str, object]]]

Additional error details, if any. This can include structured information such as field violations or error metadata.

id: Optional[str]

The client-provided id of the order this entry belongs to, echoed from the request. Always present when the request contains more than one order, since ids are required there.

class OrderPreviewError: …

One pre-trade risk-check error the order would trigger, shaped like the violation entries in ApiError.details[] on rejected submissions.

description: str

Human-readable description of the error.

metadata: Dict[str, str]

Structured details for the error (stringified values), e.g. required and available amounts, and leg_index/leg_symbol for multileg leg errors.

type: str

Stable error code.

class OrderPreviewMarginDetails: …

Margin requirements and excess before and after the previewed order.

initial_margin_excess: OrderPreviewDelta

Initial margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

initial_margin_requirement: OrderPreviewDelta

Initial margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_excess: OrderPreviewDelta

Maintenance margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_requirement: OrderPreviewDelta

Maintenance margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_excess: OrderPreviewDelta

Overnight margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_requirement: OrderPreviewDelta

Overnight margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

Either a successful preview or the error that prevented one, for a single order in the batch.

One of the following:
class Preview: …

The order was previewed successfully.

preview: OrderPreview

The projected impact of the order.

account_id: int

The account the order was previewed for.

formatint64

Monetary size of the previewed order.

gross_amount: str

Total cash impact of the order before estimated fees and commissions.

net_amount: str

Total cash impact of the order after estimated fees and commissions.

buying_power: OrderPreviewDelta

Buying power before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

currency: str

Currency for all monetary values.

Account equity before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

errors: List[OrderPreviewError]

Risk-check errors that would prevent the order from being accepted. Empty when the order would pass every pre-trade risk check.

description: str

Human-readable description of the error.

metadata: Dict[str, str]

Structured details for the error (stringified values), e.g. required and available amounts, and leg_index/leg_symbol for multileg leg errors.

type: str

Stable error code.

Margin requirements and excess before and after the order.

initial_margin_excess: OrderPreviewDelta

Initial margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

initial_margin_requirement: OrderPreviewDelta

Initial margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_excess: OrderPreviewDelta

Maintenance margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_requirement: OrderPreviewDelta

Maintenance margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_excess: OrderPreviewDelta

Overnight margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_requirement: OrderPreviewDelta

Overnight margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

positions: List[OrderPreviewPosition]

Positions in the traded instruments before and after the order.

instrument_id: str

The instrument’s identifier.

formatuuid

Net position quantity before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

symbol: str

The instrument’s symbol.

class Error: …

The order could not be previewed. Shaped exactly like the top-level error object on rejected submissions.

error: APIError

Why this order’s preview failed.

code: int

The error code is used to identify the nature of the error. It corresponds to an HTTP status code.

formatint32
minimum0
message: str

A human-readable message providing more details about the error.

details: Optional[List[Dict[str, object]]]

Additional error details, if any. This can include structured information such as field violations or error metadata.

class OrderPreviewPosition: …

One instrument’s position before and after the previewed order. Only the traded instruments appear; cash effects are carried by the monetary fields.

instrument_id: str

The instrument’s identifier.

formatuuid

Net position quantity before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

symbol: str

The instrument’s symbol.

Literal["PENDING_NEW", "QUEUED", "PENDING_TRIGGER", 14 more]

Order status

One of the following:
"PENDING_NEW"
"QUEUED"
"PENDING_TRIGGER"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"

Optional execution strategy controlling how the order is worked in the market. Omit to use standard routing. One of SOR, VWAP, TWAP, or DMA.

One of the following:
class Type: …

Smart Order Router. Routes the order to the best available venue(s).

type: Literal["SOR"]

Execution strategy type.

class UnionMember1: …

Volume-Weighted Average Price. Works the order to track the volume-weighted average price over the execution window.

type: Literal["VWAP"]

Execution strategy type.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time
class UnionMember2: …

Time-Weighted Average Price. Spreads execution evenly across the execution window.

type: Literal["TWAP"]

Execution strategy type.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) by which to finish working the order. Defaults to market close.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which to begin working the order. Defaults to the time the order is received.

formatdate-time
class UnionMember3: …

Direct Market Access. Routes the order straight to the named venue.

destination: str

Venue code the order is routed to.

type: Literal["DMA"]

Execution strategy type.

Literal["MARKET", "LIMIT", "STOP", 4 more]

Order type

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
class ReplaceOrderRequest: …

Request to replace (modify) an existing order

At least one field must be provided.

limit_offset: Optional[str]

New limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

New limit price for the order

quantity: Optional[str]

New quantity for the order

stop_price: Optional[str]

New stop price for the order

trailing_offset: Optional[str]

New trailing offset for trailing orders

trailing_offset_type: Optional[TrailingOffsetType]

New trailing offset type (PRICE or BPS)

One of the following:
"PRICE"
"BPS"
Literal["MARKET", "LIMIT", "STOP", 3 more]

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

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
Literal["OPEN", "CLOSE"]

Client-attested open/close intent for an order.

One of the following:
"OPEN"
"CLOSE"
Literal["DAY", "GOOD_TILL_CANCEL", "IMMEDIATE_OR_CANCEL", 4 more]

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

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_OPEN"
"AT_CLOSE"
Literal["BUY", "SELL"]

Side of the order (BUY or SELL).

One of the following:
"BUY"
"SELL"
Literal["DAY", "GOOD_TILL_CANCEL", "IMMEDIATE_OR_CANCEL", 5 more]

Time in force

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_OPEN"
"AT_CLOSE"
"OTHER"
Literal["PRICE", "BPS"]

Trailing offset type for trailing stop orders.

One of the following:
"PRICE"
"BPS"
class OrderGetOrdersResponse: …
data: OrderList
id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

Client-provided identifier echoed back.

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

leaves_quantity: str

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: str

Total order quantity

side: Side

Side of the order (BUY or SELL)

One of the following:
"BUY"
"SELL"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"QUEUED"
"PENDING_TRIGGER"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_OPEN"
"AT_CLOSE"
"OTHER"
updated_at: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. When a null/undefined value is observed, it indicates that there is no available data.

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

instrument_id: Optional[str]

Instrument identifier for the traded instrument. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
instrument_type: Optional[SecurityType]

Type of security. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
limit_offset: Optional[str]

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

limit_price: Optional[str]

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

releases_at: Optional[datetime]

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

formatdate-time
stop_price: Optional[str]

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

strategy: Optional[Strategy]

The execution strategy the order was submitted with, if any.

type: Literal["SOR", "VWAP", "TWAP", "DMA"]

Execution strategy type.

One of the following:
"SOR"
"VWAP"
"TWAP"
"DMA"
destination: Optional[str]

Venue code the order is routed to. DMA only.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution ends.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution begins.

formatdate-time
symbol: Optional[str]

Trading symbol. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

trailing_limit_px: Optional[str]

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

trailing_offset: Optional[str]

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

trailing_offset_type: Optional[TrailingOffsetType]

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

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

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

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time
underlying_instrument_id: Optional[str]

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
underlying_instrument_type: Optional[SecurityType]

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
class OrderGetOrderByIDResponse: …
data: 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.

id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

Client-provided identifier echoed back.

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

leaves_quantity: str

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: str

Total order quantity

side: Side

Side of the order (BUY or SELL)

One of the following:
"BUY"
"SELL"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"QUEUED"
"PENDING_TRIGGER"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_OPEN"
"AT_CLOSE"
"OTHER"
updated_at: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. When a null/undefined value is observed, it indicates that there is no available data.

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

instrument_id: Optional[str]

Instrument identifier for the traded instrument. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
instrument_type: Optional[SecurityType]

Type of security. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
limit_offset: Optional[str]

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

limit_price: Optional[str]

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

releases_at: Optional[datetime]

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

formatdate-time
stop_price: Optional[str]

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

strategy: Optional[Strategy]

The execution strategy the order was submitted with, if any.

type: Literal["SOR", "VWAP", "TWAP", "DMA"]

Execution strategy type.

One of the following:
"SOR"
"VWAP"
"TWAP"
"DMA"
destination: Optional[str]

Venue code the order is routed to. DMA only.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution ends.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution begins.

formatdate-time
symbol: Optional[str]

Trading symbol. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

trailing_limit_px: Optional[str]

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

trailing_offset: Optional[str]

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

trailing_offset_type: Optional[TrailingOffsetType]

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

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

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

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time
underlying_instrument_id: Optional[str]

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
underlying_instrument_type: Optional[SecurityType]

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
class OrderSubmitOrdersResponse: …
data: OrderList
id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

Client-provided identifier echoed back.

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

leaves_quantity: str

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: str

Total order quantity

side: Side

Side of the order (BUY or SELL)

One of the following:
"BUY"
"SELL"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"QUEUED"
"PENDING_TRIGGER"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_OPEN"
"AT_CLOSE"
"OTHER"
updated_at: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. When a null/undefined value is observed, it indicates that there is no available data.

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

instrument_id: Optional[str]

Instrument identifier for the traded instrument. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
instrument_type: Optional[SecurityType]

Type of security. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
limit_offset: Optional[str]

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

limit_price: Optional[str]

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

releases_at: Optional[datetime]

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

formatdate-time
stop_price: Optional[str]

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

strategy: Optional[Strategy]

The execution strategy the order was submitted with, if any.

type: Literal["SOR", "VWAP", "TWAP", "DMA"]

Execution strategy type.

One of the following:
"SOR"
"VWAP"
"TWAP"
"DMA"
destination: Optional[str]

Venue code the order is routed to. DMA only.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution ends.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution begins.

formatdate-time
symbol: Optional[str]

Trading symbol. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

trailing_limit_px: Optional[str]

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

trailing_offset: Optional[str]

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

trailing_offset_type: Optional[TrailingOffsetType]

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

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

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

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time
underlying_instrument_id: Optional[str]

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
underlying_instrument_type: Optional[SecurityType]

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
class OrderReplaceOrderResponse: …
data: 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.

id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

Client-provided identifier echoed back.

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

leaves_quantity: str

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: str

Total order quantity

side: Side

Side of the order (BUY or SELL)

One of the following:
"BUY"
"SELL"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"QUEUED"
"PENDING_TRIGGER"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_OPEN"
"AT_CLOSE"
"OTHER"
updated_at: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. When a null/undefined value is observed, it indicates that there is no available data.

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

instrument_id: Optional[str]

Instrument identifier for the traded instrument. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
instrument_type: Optional[SecurityType]

Type of security. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
limit_offset: Optional[str]

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

limit_price: Optional[str]

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

releases_at: Optional[datetime]

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

formatdate-time
stop_price: Optional[str]

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

strategy: Optional[Strategy]

The execution strategy the order was submitted with, if any.

type: Literal["SOR", "VWAP", "TWAP", "DMA"]

Execution strategy type.

One of the following:
"SOR"
"VWAP"
"TWAP"
"DMA"
destination: Optional[str]

Venue code the order is routed to. DMA only.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution ends.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution begins.

formatdate-time
symbol: Optional[str]

Trading symbol. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

trailing_limit_px: Optional[str]

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

trailing_offset: Optional[str]

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

trailing_offset_type: Optional[TrailingOffsetType]

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

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

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

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time
underlying_instrument_id: Optional[str]

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
underlying_instrument_type: Optional[SecurityType]

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
class OrderCancelOpenOrderResponse: …
data: 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.

id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

Client-provided identifier echoed back.

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

leaves_quantity: str

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: str

Total order quantity

side: Side

Side of the order (BUY or SELL)

One of the following:
"BUY"
"SELL"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"QUEUED"
"PENDING_TRIGGER"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_OPEN"
"AT_CLOSE"
"OTHER"
updated_at: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. When a null/undefined value is observed, it indicates that there is no available data.

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

instrument_id: Optional[str]

Instrument identifier for the traded instrument. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
instrument_type: Optional[SecurityType]

Type of security. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
limit_offset: Optional[str]

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

limit_price: Optional[str]

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

releases_at: Optional[datetime]

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

formatdate-time
stop_price: Optional[str]

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

strategy: Optional[Strategy]

The execution strategy the order was submitted with, if any.

type: Literal["SOR", "VWAP", "TWAP", "DMA"]

Execution strategy type.

One of the following:
"SOR"
"VWAP"
"TWAP"
"DMA"
destination: Optional[str]

Venue code the order is routed to. DMA only.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution ends.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution begins.

formatdate-time
symbol: Optional[str]

Trading symbol. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

trailing_limit_px: Optional[str]

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

trailing_offset: Optional[str]

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

trailing_offset_type: Optional[TrailingOffsetType]

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

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

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

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time
underlying_instrument_id: Optional[str]

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
underlying_instrument_type: Optional[SecurityType]

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
class OrderCancelAllOpenOrdersResponse: …
data: OrderList
id: str

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

account_id: int

Account placing the order

formatint64
client_order_id: str

Client-provided identifier echoed back.

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time
filled_quantity: str

Cumulative filled quantity

leaves_quantity: str

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:
"MARKET"
"LIMIT"
"STOP"
"STOP_LIMIT"
"TRAILING_STOP"
"TRAILING_STOP_LIMIT"
"OTHER"
quantity: str

Total order quantity

side: Side

Side of the order (BUY or SELL)

One of the following:
"BUY"
"SELL"
status: OrderStatus

Current status of the order

One of the following:
"PENDING_NEW"
"QUEUED"
"PENDING_TRIGGER"
"NEW"
"PARTIALLY_FILLED"
"FILLED"
"CANCELED"
"REJECTED"
"EXPIRED"
"PENDING_CANCEL"
"PENDING_REPLACE"
"REPLACED"
"DONE_FOR_DAY"
"STOPPED"
"SUSPENDED"
"CALCULATED"
"OTHER"
time_in_force: TimeInForce

Time in force instruction

One of the following:
"DAY"
"GOOD_TILL_CANCEL"
"IMMEDIATE_OR_CANCEL"
"FILL_OR_KILL"
"GOOD_TILL_DATE"
"AT_OPEN"
"AT_CLOSE"
"OTHER"
updated_at: datetime

Timestamp of the most recent update (UTC)

formatdate-time
venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions. For multileg orders this is the venue’s strategy-level average when reported, else the signed net package price derived from the leg averages: net debit positive, net credit negative, zero possible. When a null/undefined value is observed, it indicates that there is no available data.

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

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
extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

instrument_id: Optional[str]

Instrument identifier for the traded instrument. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
instrument_type: Optional[SecurityType]

Type of security. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
limit_offset: Optional[str]

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

limit_price: Optional[str]

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

releases_at: Optional[datetime]

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

formatdate-time
stop_price: Optional[str]

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

strategy: Optional[Strategy]

The execution strategy the order was submitted with, if any.

type: Literal["SOR", "VWAP", "TWAP", "DMA"]

Execution strategy type.

One of the following:
"SOR"
"VWAP"
"TWAP"
"DMA"
destination: Optional[str]

Venue code the order is routed to. DMA only.

end_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution ends.

formatdate-time
start_at: Optional[datetime]

UTC timestamp (RFC 3339) at which execution begins.

formatdate-time
symbol: Optional[str]

Trading symbol. null when the order is a multileg strategy whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

trailing_limit_px: Optional[str]

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

trailing_offset: Optional[str]

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

trailing_offset_type: Optional[TrailingOffsetType]

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

One of the following:
"PRICE"
"BPS"
trailing_stop_px: Optional[str]

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

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time
underlying_instrument_id: Optional[str]

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
underlying_instrument_type: Optional[SecurityType]

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
class OrderGetExecutionsResponse: …
id: str

Unique identifier for this execution report.

formatuuid
order_id: str

Identifier of the order this execution belongs to.

formatuuid
quantity: str

Filled quantity. For a strategy-level multileg fill this is the net strategy quantity, not a per-leg quantity.

side: Side

Side of the fill.

One of the following:
"BUY"
"SELL"
transaction_time: datetime

Transaction timestamp in nanosecond precision (UTC).

formatdate-time
instrument_id: Optional[str]

Unique instrument identifier. null when this is a strategy-level multileg fill whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
price: Optional[str]

Fill price. null for multileg fills, whose price lives only at the leg level. When a null/undefined value is observed, it indicates it does not apply.

symbol: Optional[str]

Trading symbol. null when this is a strategy-level multileg fill whose legs are reported individually in legs[]. When a null/undefined value is observed, it indicates it does not apply.

underlying_instrument_id: Optional[str]

Underlying instrument identifier for an option fill. Omitted for a non-derivative fill, when the underlier could not be resolved, or for a multileg fill (per-leg underliers live in legs[]). When a null/undefined value is observed, it indicates it does not apply.

formatuuid
underlying_instrument_type: Optional[SecurityType]

Type of the underlying instrument, alongside underlying_instrument_id. When a null/undefined value is observed, it indicates it does not apply.

One of the following:
"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
venue: Optional[str]

Venue where this fill occurred, as reported by that venue. Distinct from an order’s venue, which is the routing destination. Codes are not normalized, so the format varies by venue. When a null/undefined value is observed, it indicates that there is no available data.

class OrderPreviewOrdersResponse: …
One of the following:
class UnionMember0: …

The order was previewed successfully.

preview: OrderPreview

The projected impact of the order.

account_id: int

The account the order was previewed for.

formatint64

Monetary size of the previewed order.

gross_amount: str

Total cash impact of the order before estimated fees and commissions.

net_amount: str

Total cash impact of the order after estimated fees and commissions.

buying_power: OrderPreviewDelta

Buying power before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

currency: str

Currency for all monetary values.

Account equity before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

errors: List[OrderPreviewError]

Risk-check errors that would prevent the order from being accepted. Empty when the order would pass every pre-trade risk check.

description: str

Human-readable description of the error.

metadata: Dict[str, str]

Structured details for the error (stringified values), e.g. required and available amounts, and leg_index/leg_symbol for multileg leg errors.

type: str

Stable error code.

Margin requirements and excess before and after the order.

initial_margin_excess: OrderPreviewDelta

Initial margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

initial_margin_requirement: OrderPreviewDelta

Initial margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_excess: OrderPreviewDelta

Maintenance margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

maintenance_margin_requirement: OrderPreviewDelta

Maintenance margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_excess: OrderPreviewDelta

Overnight margin excess.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

overnight_margin_requirement: OrderPreviewDelta

Overnight margin requirement.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

positions: List[OrderPreviewPosition]

Positions in the traded instruments before and after the order.

instrument_id: str

The instrument’s identifier.

formatuuid

Net position quantity before and after the order.

after: str

The value with the previewed order also fully filled.

before: str

The value before the order, as the risk engine evaluates it: the account’s open orders are projected as filled.

change: str

The previewed order’s isolated impact: after - before.

symbol: str

The instrument’s symbol.

id: Optional[str]

The client-provided id of the order this entry belongs to, echoed from the request. Always present when the request contains more than one order, since ids are required there.

class UnionMember1: …

The order could not be previewed. Shaped exactly like the top-level error object on rejected submissions.

error: APIError

Why this order’s preview failed.

code: int

The error code is used to identify the nature of the error. It corresponds to an HTTP status code.

formatint32
minimum0
message: str

A human-readable message providing more details about the error.

details: Optional[List[Dict[str, object]]]

Additional error details, if any. This can include structured information such as field violations or error metadata.

id: Optional[str]

The client-provided id of the order this entry belongs to, echoed from the request. Always present when the request contains more than one order, since ids are required there.