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
Messages
{
"jsonrpc": "2.0",
"method": "public/subscribe",
"id": 42,
"params": {
"channels": [
"user.orders.(kind).(currency).raw"
]
}
}{
"data": {
"time_in_force": "good_til_cancelled",
"replaced": false,
"reduce_only": false,
"price": 10542.68,
"post_only": false,
"original_order_type": "market",
"order_type": "limit",
"order_state": "open",
"order_id": "6",
"max_show": 200,
"last_update_timestamp": 1581507583024,
"label": "",
"is_rebalance": false,
"is_liquidation": false,
"instrument_name": "BTC-PERPETUAL",
"filled_amount": 0,
"direction": "buy",
"creation_timestamp": 1581507583024,
"average_price": 0,
"api": false,
"amount": 200
}
}User
user.orders.(kind).(currency).raw
User order updates across all instruments for a given kind and currency (raw stream).
Use this channel to receive private order updates across all matching instruments with the highest granularity (raw).
Messages
{
"jsonrpc": "2.0",
"method": "public/subscribe",
"id": 42,
"params": {
"channels": [
"user.orders.(kind).(currency).raw"
]
}
}{
"data": {
"time_in_force": "good_til_cancelled",
"replaced": false,
"reduce_only": false,
"price": 10542.68,
"post_only": false,
"original_order_type": "market",
"order_type": "limit",
"order_state": "open",
"order_id": "6",
"max_show": 200,
"last_update_timestamp": 1581507583024,
"label": "",
"is_rebalance": false,
"is_liquidation": false,
"instrument_name": "BTC-PERPETUAL",
"filled_amount": 0,
"direction": "buy",
"creation_timestamp": 1581507583024,
"average_price": 0,
"api": false,
"amount": 200
}
}kind
type:string
required
Instrument kind
Allowed values: future, option, spot, future_combo, option_combo
currency
type:string
required
Currency code or any for all
Allowed values: BTC, ETH, USDC, USDT, EURR, any
Subscription Request
type:object
Client sends subscription request to subscribe to notification channel. Please refer to Notification page for more information.
Subscription Notification Data
type:object
Server sends subscription notification data
Was this page helpful?
⌘I