Skip to main content
WEBHOOK

Body

application/json

Latest state of one derivatives order, using the status values of Get Order. A cancellation or rejection can report only the order's identity, status and close reason; omitted fields do not clear previously received values.

type
string
required

Webhook event identifier.

Allowed value: "derivatives.order_updated"
user_id
string
required

Globally unique public identifier for a user.

Required string length: 14 - 42
account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42
id
string
required

Order identifier used by the derivatives order APIs.

symbol
string
required

Derivatives instrument symbol for the order.

status
enum<string>
required

Latest order status, as Get Order reports it. An open order is still working and may be partly filled. Every other status is final. A closed order is not necessarily fully filled; compare filled_quantity with quantity. A cancelled order may have been partially filled.

Available options:
open,
closed,
cancelled,
expired
updated_at
string<date-time>
required

Time of this order update.

client_order_id
string

Partner-supplied order identifier, when one was provided.

side
enum<string>

Direction of an order or execution.

Available options:
buy,
sell
order_type
enum<string>

How the order executes or triggers. stop_loss and take_profit execute at market once triggered; the _limit variants place a limit order instead. Trailing types move their stop level with the market. Trailing and _limit types are US perpetuals only.

Available options:
market,
limit,
stop_loss,
take_profit,
stop_loss_limit,
take_profit_limit,
trailing_stop,
trailing_stop_limit
close_reason
string

Explanation of why the order closed, for display. Delivered once the order is closed, cancelled or expired. Get Order can add detail to the same explanation, so do not compare the two texts or parse them; use status, quantity and filled_quantity instead.

quantity
string

Requested order quantity.

filled_quantity
string

Quantity filled so far.

limit_price
string

Current limit price, when this order has one. Omitted for market orders. A trailing stop-limit order reports it only once triggered, because until then its limit is set relative to the moving stop.

Required string length: 1 - 64
Pattern: ^[0-9]+(\.[0-9]+)?$
trigger_price
string

Current price at which the order triggers, when this order has one. For a trailing order this is the current stop level, which follows the market, and it appears once the first level is known.

Required string length: 1 - 64
Pattern: ^[0-9]+(\.[0-9]+)?$

Response

2XX

Delivery endpoint accepted the webhook.