Skip to main content
GET
Python (SDK)

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Path Parameters

order_hash
string
required

Response

Successful Response

Returned from GET /order/{hash} — current state of a relayed order.

order_hash
string
required

On-chain order hash.

status
enum<string>
required

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.

Available options:
pending,
filled,
expired,
cancelled
updated_at
string
required

ISO 8601 UTC timestamp at which this status was read.

fill_tx_hash
string | null

Transaction hash of the most recent fill. Populated for fully filled orders and for partial fills while status is still pending.

fill_price_usd
string | null

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.

filled_amount
string | null

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.

submitted_at
string | null

ISO 8601 UTC timestamp at which the order was submitted.