Skip to main content
Receive real-time updates on your orders.
  • Topic: order
  • Stream: Private (wss://api.ekiden.fi/ws/private)

​
Authenticate

Use authentication flow described in the Connect page.

​
Subscribe

{ "op": "subscribe", "args": ["order"], "req_id": "201001" }
Ack: 
{ "op": "subscribed", "args": ["order"], "req_id": "201001" }

​
Events

Messages arrive with op: "event", topic: "order", and data is an array of Order. Example: 
{
	"op": "event",
	"topic": "order",
	"server_ts_ms": 1731541800000,
	"data": [
		{
			"order_id": "550e8400-e29b-41d4-a716-446655440000",
			"order_link_id": null,
			"symbol": "BTC-USDC",
			"sub_account_address": "0xsubacct...",
			"price": "100200",
			"qty": "1000",
			"side": "Buy",
			"margin_mode": "Cross",
			"order_status": "New",
			"create_type": null,
			"cancel_type": null,
			"reject_reason": null,
			"avg_price": "0",
			"leaves_qty": "1000",
			"leaves_value": "100200000",
			"cum_exec_qty": "0",
			"cum_exec_value": "0",
			"cum_exec_fee": "0",
			"closed_pnl": null,
			"time_in_force": "GTC",
			"expire_time": null,
			"order_type": "Limit",
			"stop_order_type": null,
			"tpsl": null,
			"trigger": null,
			"last_price_on_created": "100150",
			"post_only": false,
			"reduce_only": false,
			"close_on_trigger": false,
			"created_time": "1731541799000",
			"updated_time": "1731541800000"
		}
	]
}
Field notes:
  • Numeric values are encoded as strings to preserve precision.
  • Times (created_time, updated_time, expire_time) are Unix milliseconds (encoded as strings).

​
Fields

FieldTypeNotes
order_idstringOrder ID (UUID)
order_link_idstring or nullClient-provided link id, if set
symbolstringSymbol name
sub_account_addressstringSub-account address
pricestringOrder price
qtystringOrder quantity
sidestringBuy or Sell
margin_modestringCross or Isolated
order_statusstringe.g. New, PartiallyFilled, Filled, Canceled, …
create_typestring or nullCreate source/type
cancel_typestring or nullCancel source/type
reject_reasonstring or nullRejection reason
avg_pricestringAverage executed price
leaves_qtystringRemaining unfilled quantity
leaves_valuestringEstimated value of remaining quantity
cum_exec_qtystringCumulative executed quantity
cum_exec_valuestringCumulative executed value
cum_exec_feestringCumulative fees
closed_pnlstring or nullPresent for close position orders (WS only)
time_in_forcestring or objectGTC, IOC, FOK, Day, or {"GTD": <ms>}
expire_timestring or nullExpiration time for GTD orders (ms)
order_typestringLimit or Market
stop_order_typestring or nullStop order type if applicable
tpslobject or nullTake profit / stop loss details
triggerobject or nullConditional order details
last_price_on_createdstringLast price when created
post_onlybooleanPost-only flag
reduce_onlybooleanReduce-only flag
close_on_triggerbooleanClose-on-trigger flag
created_timestringCreated time (ms)
updated_timestringUpdated time (ms)
See schema details in AsyncAPI: Order.