Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
The migration to V3 will occur on August 25 at 10am EST. Old API integrations will stop working. See the Migrate to V3 guide →
How order statuses changes during an order’s lifetime.
| Status | Means |
|---|---|
PENDING | Accepted and published to the matching engine. Not live, not yet matchable. |
ACTIVE | Resting on the book, in whole or in part. |
INACTIVE | No longer resting. inactiveReason says why. |
FILLED is an inactiveReason, not a status. A fully filled order is status: "INACTIVE"
with inactiveReason: "FILLED". A partial fill whose remainder falls below the minimum resting size
(limits.minRestingOrderSizeBaseUnits) is also reported as FILLED — the engine discards the dust
remainder rather than resting it.ACTIVE entirely. Both go from PENDING straight to INACTIVE. The order never rests, so it is never ACTIVE.
inactiveReason valuesINACTIVE if it is filled or cancelled. inactiveReason tells you which condition applied.
inactiveReason | Fires when |
|---|---|
FILLED | Fully matched, or a partial fill left a remainder below the minimum resting size (limits.minRestingOrderSizeBaseUnits), which is discarded. |
USER_REQUESTED | You cancelled it. |
EXPIRED | The order’s expiry passed. |
NO_LIQUIDITY | An IOC found no compatible liquidity, or an FOK could not fill completely. |
INSUFFICIENT_BALANCE | A balance check failed at match time — on either the maker or the taker side. |
EVENT_LIFECYCLE | The fixture moved into a state that sweeps resting orders — in progress, finished, or cancelled. Includes kickoff. |
MARKET_HALTED | An operator explicitly halted the market. |
HEARTBEAT_TIMEOUT | Your heartbeat lapsed. Sweeps every open order on your account. |
SYSTEM | The exchange cancelled the order. Covers several distinct causes, and the payload does not say which. |