Skip to content

Websocket

GET
/websocket

wss://uat.atomicvaults.com/websocket

Connect to the websocket to receive real-time updates. You may open multiple connections.

Parameters

Header Parameters

X-API-KEY*
Type
string
Required

Responses

Responses will be JSON with a message containing order event and the affected order.

application/json
JSON
{
  
"message": {
  
  
"order_event": "string",
  
  
"order": {
  
  
  
"av_order_id": "string",
  
  
  
"average_price": "1.23",
  
  
  
"order_id": "string",
  
  
  
"order_type": "string",
  
  
  
"limit_price": "string",
  
  
  
"stop_price": "string",
  
  
  
"quantity": "1.23",
  
  
  
"quantity_filled": "1.23",
  
  
  
"notional": "1.23",
  
  
  
"notional_filled": "1.23",
  
  
  
"side": "string",
  
  
  
"status": "string",
  
  
  
"symbol": "AAPL 230317C00120000",
  
  
  
"position_effect": "string",
  
  
  
"time_placed": "string",
  
  
  
"order_completion_time": "string",
  
  
  
"initiator": "string",
  
  
  
"time_in_force": "string",
  
  
  
"purpose": "string",
  
  
  
"orig_order_id": "string",
  
  
  
"text": "string",
  
  
  
"take_profit_status": "string",
  
  
  
"stop_loss_status": "string",
  
  
  
"legs": [
  
  
  
  
{
  
  
  
  
  
"leg_ref_id": "string",
  
  
  
  
  
"side": "string",
  
  
  
  
  
"symbol": "string",
  
  
  
  
  
"ratio_qty": "1.23",
  
  
  
  
  
"position_effect": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"take_profit_leg": {
  
  
  
  
"limit_price": "1.23"
  
  
  
},
  
  
  
"stop_loss_leg": {
  
  
  
  
"stop_price": "1.23",
  
  
  
  
"limit_price": "1.23"
  
  
  
},
  
  
  
"end_customer_id": "string"
  
  
}
  
}
}

Playground

Headers

Samples

Powered by VitePress OpenAPI