Get order by ID

Retrieve specific order details by ID. The user context is resolved based on the provided API key.

Request

Path parameters
Path parameters

Unique identifier (UUID) of the venue order.

Header parameters
Header parameters

Example: 1746007718237

Current timestamp in Unix epoch milliseconds. Used to prevent replay attacks and construct the signature. Provided with other authentication headers.

Example: "2h/t5o8w+l5s+fjyfA0n/e7j4u5b7h4e+g4k4c8h7a2p6k0g7j1f+w0i2j3k9r0l3s8m5t6r+q1s+o3v/t4x8v5y+w1r+m2t/k3w/j4y+"

The Ed25519 signature of the request. Provided with other authentication headers.

Tip

See Authentication headers: Signing a request for details on how to generate this.

Response

OK - Order details.

Response body
Body object

Order

ID of the order.

ID of the previous/replaced order. Present only if this order has replaced another one.

ID of the order assigned by the client when creating the order.

Symbol of the asset for which this order has been created.

Possible values: [buy, sell]

Side of the order. Indicates whether the order was to acquire (buy) or dispose of (sell) an asset.

Possible values: [market, limit, conditional, tpsl]

Type of the order.

A market order is executed immediately at the current market price. A limit order is executed only if the asset reaches a specified price set by the trader. A conditional order is submitted only once a specific trigger price is reached. A tpsl order sets or adjusts the Take Profit and Stop Loss settings for a position.

Quantity of the order, expressed in base currency.

For sell orders, this is the initial locked balance amount.

Quantity of the order that has been filled.

In other words, how much of the order has already been executed.

Quantity of the order that remains to be filled.

In other words, how much of the order remains to be executed.

The amount of the order expressed in quote currency.

For buy orders, this is the initial locked balance amount.

The worst price for the client at which an order will be filled.

This is the worst price at which the user is willing to trade. For buy orders, it's the maximum price for the order; for sell orders, it's the minimum price.

Quantity-weighted average fill price of the order.

This is the average price at which the order has been executed so far. If the order is filled in parts at different prices, this indicates the overall average price for the order.

Possible values: [pending_new, new, partially_filled, filled, cancelled, rejected, replaced]

Status of the order:

  • pending_new: Accepted by a matching engine but not yet working.
  • new: Working order.
  • partially_filled: Partially filled order.
  • filled: Fully filled order.
  • cancelled: Cancelled order.
  • rejected: Rejected order.
  • replaced: Replaced order.

Reason for rejecting the order, present only for status=rejected.

Possible values: [gtc, ioc, fok]

Time in force of the order. Indicates how long the order should remain active before it’s either executed or canceled. Possible values:

  • gtc: Good till cancelled. Means that the order stays active until it’s either completely filled or it's manually cancelled by the user who created the order.
  • ioc: Immediate or cancel. Means that any portion of the order that cannot be filled immediately will be cancelled.
  • fok: Fill or kill. Means that the order must be filled immediately and in its entirety, or it will be cancelled (no partial fills allowed).

Possible values: [allow_taker, post_only]
Example:

[]

Default value: allow_taker

List of execution instructions for the order. Can be provided as an empty array [] if no specific instructions are required.

Details regarding the trigger conditions. Present only when the order type is conditional.

The price level that activates the order. When the market price reaches this value according to the trigger_direction, the order is submitted.

Possible values: [market, limit]

Type of the order.

Possible values: [ge, le]

The price comparison operator used to trigger the order.

  • ge: Greater than or equal to the trigger price.
  • le: Less than or equal to the trigger price.

The specific price at which the order should be executed. Required for limit orders.

Possible values: [gtc, ioc]

Time in force of the order. Indicates how long the order should remain active before it's either executed or canceled. Possible values:

  • gtc: Good till cancelled. Means that the order stays active until it's either completely filled or it's manually cancelled by the user who created the order.
  • ioc: Immediate or cancel. Means that any portion of the order that cannot be filled immediately will be cancelled.

Possible values: [allow_taker, post_only]
Example:

[]

Default value: allow_taker

List of execution instructions for the order. Can be provided as an empty array [] if no specific instructions are required.

Details of the associated Take Profit trigger. Present when the order type is tpsl. At least one of stop_loss or take_profit will be present.

The price level that activates the order. When the market price reaches this value according to the trigger_direction, the order is submitted.

Possible values: [market, limit]

Type of the order.

Possible values: [ge, le]

The price comparison operator used to trigger the order.

  • ge: Greater than or equal to the trigger price.
  • le: Less than or equal to the trigger price.

The specific price at which the order should be executed. Required for limit orders.

Possible values: [gtc, ioc]

Time in force of the order. Indicates how long the order should remain active before it's either executed or canceled. Possible values:

  • gtc: Good till cancelled. Means that the order stays active until it's either completely filled or it's manually cancelled by the user who created the order.
  • ioc: Immediate or cancel. Means that any portion of the order that cannot be filled immediately will be cancelled.

Possible values: [allow_taker, post_only]
Example:

[]

Default value: allow_taker

List of execution instructions for the order. Can be provided as an empty array [] if no specific instructions are required.

Details of the associated Stop Loss trigger. Present when the order type is tpsl. At least one of stop_loss or take_profit will be present.

The price level that activates the order. When the market price reaches this value according to the trigger_direction, the order is submitted.

Possible values: [market, limit]

Type of the order.

Possible values: [ge, le]

The price comparison operator used to trigger the order.

  • ge: Greater than or equal to the trigger price.
  • le: Less than or equal to the trigger price.

The specific price at which the order should be executed. Required for limit orders.

Possible values: [gtc, ioc]

Time in force of the order. Indicates how long the order should remain active before it's either executed or canceled. Possible values:

  • gtc: Good till cancelled. Means that the order stays active until it's either completely filled or it's manually cancelled by the user who created the order.
  • ioc: Immediate or cancel. Means that any portion of the order that cannot be filled immediately will be cancelled.

Possible values: [allow_taker, post_only]
Example:

[]

Default value: allow_taker

List of execution instructions for the order. Can be provided as an empty array [] if no specific instructions are required.

Timestamp in Unix epoch milliseconds.

Timestamp in Unix epoch milliseconds.

Was this page helpful?