Order Details

GET /v1/api/order

This endpoint allows a user to request details for a specific order.

The order may be specified by the client_order_id (client generated) or order_id (exchange generated).

Headers

Header Field	Type	Comments
credentials_secret	JWT	Created by user for validation

Order Details Response Message

Name	Type	Comments
market_id	string	"0" for firm order / "none" for RFQ
tradeable_entity_id	integer	unique instrument id
symbol	string	Instrument name e.g BTC-USD
side	string	buy / sell
type	string	LIMIT / MARKET
quantity	float	"0.1" / "0.000123" / "0.0" / "1.3456"
price	float	"12.0" / "1.1245" / "0.000100"
order_id	string	Unique Order Id generated by the exchange
client_order_id	string	Unique Order Id generated by the client
order_state	string	order state
cancel_state	string	cancellation state
executions	Execution[]	see below

Execution Message

Name	Type	Comments
utc_timestamp	integer	Execution Time
executed_quantity	float	"0.1" / "0.000123" / "0.0" / "1.3456"
executed_price	float	"12.0" / "1.1245" / "0.000100"
trade_id	string	Unique Trade Id generated by the exchange
liquidity_flag	string	added / taken

Responses

If the order is not executed, the executions array will be empty.

{
  "query_order_response": {
    "utc_timestamp": "1637596685110771",
    "market_id": "0",
    "tradeable_entity_id": "7",
    "symbol": "BTC-USD",
    "type": "LIMIT",
    "order_id": "exchange_generated_id",
    "client_order_id": "client_generated_id",
    "quantity": "0.002",
    "price": "64760.00",
    "side": "buy",
    "order_state": "filled",
    "cancel_state": "none",
    "executions": [
      {
        "utc_timestamp": "1637596673102302000",
        "executed_price": "58258.00",
        "executed_quantity": "0.00200000",
        "trade_id": "2164967",
        "liquidity_flag": "taken"
      }
    ]
  }
}

Failure

{
  "query_order_response": {
    "error": "failed",
    "reason": "exchange order id or client order id not found in order cache"
  }
}