Skip to main content
GET
Get an order

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Path Parameters

accountId
string<uuid>
required

Account ID or subaccount ID (a UUID). May be the ID the order was placed with, or any subaccount ID the order was allocated to.

Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

orderId
string<uuid>
required

The order ID (a UUID) returned when the order was placed.

Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

Response

The order.

data
Order · object
required

Full current state of an order: the parameters it was placed with, plus its execution state.

Quantity fields and their units:

  • quantity, filledQuantity, remainingQuantity, and canceledQuantity are in units of currency.
  • counterQuantity and counterQuantityAllIn are in units of counterCurrency.
  • Prices (avgPrice, avgPriceAllIn, limitPrice, triggerPrice) are in the quote currency of symbol.
  • Invariant: filledQuantity + remainingQuantity + canceledQuantity = quantity.

An order is returned in one of two views:

  • Account-level view (order endpoints with an account ID in the path): quantities, fills, and fees are order-level aggregates across all allocations. If the order was placed with allocations, allocationCount is present, and the per-allocation execution state is available from the account allocations endpoint (GET /accounts/{accountId}/allocations?orderIds={orderId}).
  • Subaccount-scoped view (order endpoints with a subaccount ID in the path, and every entry returned by the account allocations endpoint): quantity, filledQuantity, remainingQuantity, canceledQuantity, counterQuantity, counterQuantityAllIn, and fee are scoped to one subaccount's portion of the order, and subaccountId and allocationId are present. Fills and fees are apportioned pro-rata across allocations, so avgPrice and avgPriceAllIn are identical in both views. The quantity invariant above holds within the view.