Get the lifecycle state of a submitted order.
The status field is one of pending, filled, expired, or
cancelled. Partial fills stay in pending while filled_amount is
populated as fills come in; once an order fully fills, fill_tx_hash
is also returned.
Upstream protocol states beyond these four (e.g. partially-filled,
refunded) are mapped onto this set.
Documentation Index
Fetch the complete documentation index at: https://docs.compasslabs.ai/llms.txt
Use this file to discover all available pages before exploring further.
Successful Response
Returned from GET /order/{hash} — current state of a relayed order.
On-chain order hash.
Order lifecycle state. One of pending, filled, expired, or cancelled. Upstream protocol states beyond these four (e.g. partially-filled, refunded) are mapped onto this set.
pending, filled, expired, cancelled ISO 8601 UTC timestamp at which this status was read.
Transaction hash of the most recent fill. Populated for fully filled orders and for partial fills while status is still pending.
Implied USD execution rate per unit of the received token, derived from filled amounts and the input token's USD price. For USDC → equity buys, this is the USD paid per equity unit. Omitted when token decimals or pricing are not available.
Total amount filled so far, expressed as a raw integer in the input token's decimals. Populated for partial fills while status is still pending, and for fully filled orders.
ISO 8601 UTC timestamp at which the order was submitted.