Introduction
Websockets
- WSSuser.mmp_trigger.(index_name)
- WSSuser.portfolio.(currency)
- WSSuser.trades.(instrument_name).(interval)
- WSSuser.trades.(kind).(currency).(interval)
- WSSuser.combo_trades.(instrument_name).(interval)
- WSSuser.combo_trades.(kind).(currency).(interval)
- WSSuser.orders.(instrument_name).raw
- WSSuser.orders.(instrument_name).(interval)
- WSSuser.orders.(kind).(currency).raw
- WSSuser.orders.(kind).(currency).(interval)
- WSSuser.changes.(instrument_name).(interval)
- WSSuser.changes.(kind).(currency).(interval)
- WSSuser.access_log
- WSSuser.lock
- WSS
{
"jsonrpc": "2.0",
"method": "public/subscribe",
"id": 42,
"params": {
"channels": [
"user.orders.(kind).(currency).100ms"
]
}
}{
"data": [
{
"time_in_force": "good_til_cancelled",
"reduce_only": false,
"price": 3928.5,
"post_only": false,
"order_type": "limit",
"order_state": "open",
"order_id": "476137",
"max_show": 120,
"last_update_timestamp": 1550826337209,
"label": "",
"is_rebalance": false,
"is_liquidation": false,
"instrument_name": "BTC-PERPETUAL",
"filled_amount": 0,
"direction": "buy",
"creation_timestamp": 1550826337209,
"average_price": 0,
"api": false,
"amount": 120
}
]
}user.orders.(kind).(currency).(interval)
User order updates across all instruments for a given kind and currency (aggregated).
Use this channel to receive private order updates across all matching instruments, aggregated according to interval.
{
"jsonrpc": "2.0",
"method": "public/subscribe",
"id": 42,
"params": {
"channels": [
"user.orders.(kind).(currency).100ms"
]
}
}{
"data": [
{
"time_in_force": "good_til_cancelled",
"reduce_only": false,
"price": 3928.5,
"post_only": false,
"order_type": "limit",
"order_state": "open",
"order_id": "476137",
"max_show": 120,
"last_update_timestamp": 1550826337209,
"label": "",
"is_rebalance": false,
"is_liquidation": false,
"instrument_name": "BTC-PERPETUAL",
"filled_amount": 0,
"direction": "buy",
"creation_timestamp": 1550826337209,
"average_price": 0,
"api": false,
"amount": 120
}
]
}Instrument kind
Allowed values: future, option, spot, future_combo, option_combo
Currency code or any for all
Allowed values: BTC, ETH, USDC, USDT, EURR, any
Frequency of notifications. Events will be aggregated over this interval. The value raw means no aggregation will be applied (Please note that raw interval is only available to authorized users)
Allowed values: raw, 100ms, agg2
Client sends subscription request to subscribe to notification channel. Please refer to Notification page for more information.
Server sends subscription notification data
Was this page helpful?