Skip to main content
POST
GetOrder

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol. If omitted, use 1.

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
orderId
string<int64>
required

On-chain order identifier to look up. Required; must be combined with market and reduce_only to uniquely identify the order.

market
market_id · object
required

Market the order belongs to, by market_id or market_symbol. Required; an unresolvable selector returns NOT_FOUND.

reduceOnly
boolean

Whether to look up a reduce-only order (true) or a position-opening order (false) for this order_id. Defaults to false when omitted.

Response

200 - application/json

Success

order
order · object

Current stored state of a position-opening or reduce-only order. Because both order kinds share this message, some numeric fields have different meanings and units. Use reduceOnly when interpreting them.