Skip to main content
A prediction-order message is sent when one of your orders changes state — accepted, partially filled, filled, cancelled or expired.

Access

Requires an API key with the read scope. Send an authenticate frame; there is no separate subscribe for the private stream.

Fields

As on fills, orderId is a string carrying a 63-bit value. Do not parse it as a number.

Status values

cancelReason is replaced when the order was cancelled as part of an amend: amending replaces the resting order, so you receive a cancellation for the old order id alongside the new one.
price is the order’s original limit price, not an execution price. For what you actually paid, read fillPrice on the corresponding fill.

Example

Notes

  • status is the durable answer. The REST create-order response always returns the literal "accepted" regardless of fill state — it tells you the engine sequenced your command, not what happened to it. The socket tells you what happened.
  • The optional fields are populated on engine-emitted updates. Treat them as optional anyway and fall back to your own record of the order rather than assuming presence.
  • This replaces polling GET /v1/orders/{order_id}.