Account Info

The account info channel is a channel that you are automatically subscribed to when you authenticate your session. It provides all the pertinent info for your orders, positions, trades, funding offers and loans, balances, and more.

const crypto = require('crypto-js') // Standard JavaScript cryptography library
const WebSocket = require('ws') // Websocket library for Node

const apiKey = '' // Users API credentials are defined here
const apiSecret = ''

const authNonce = * 1000 // Generate an ever increasing, single use value. (a timestamp satisfies this criteria)
const authPayload = 'AUTH' + authNonce // Compile the authentication payload, this is simply the string 'AUTH' prepended to the nonce value
const authSig = crypto.HmacSHA384(authPayload, apiSecret).toString(crypto.enc.Hex) // The authentication payload is hashed using the private key, the resulting hash is output as a hexadecimal string

const payload = {
  apiKey, //API key
  authSig, //Authentication Sig
  event: 'auth', // The connection event, will always equal 'auth'
  //dms: 4, // Optional Dead-Man-Switch flag to cancel all orders when socket is closed
  //filter: [] // Optional filter for the account info received (default = everything)

const wss = new WebSocket('wss://') // Create new Websocket

wss.on('open', () => wss.send(JSON.stringify(payload)))

wss.on('message', (msg) => {     // The 'message' event is called whenever the ws recieves ANY message
  let response = JSON.parse(msg)
package main
import (
func main() {
    ws, err := websocket.Dial("wss://", "", "http://localhost/")
    if err != nil {
    nonce := fmt.Sprintf("%v", time.Now().Unix())
    payload := "AUTH" + nonce
    sig := hmac.New(sha512.New384, []byte("API_SECRET"))
    payload_sign := hex.EncodeToString(sig.Sum(nil))
    connectMsg, _ := json.Marshal(map[string]interface{}{
        "event":       "auth",
        "apiKey":      "API_KEY",
        "authSig":     payload_sign,
        "authPayload": payload,
        "authNonce":   nonce,
    // Send auth message
    _, err = ws.Write(connectMsg)
    if err != nil {
    // Read all incoming messages
    var msg string
    for {
        if err = websocket.Message.Receive(ws, &msg); err != nil {
        } else {

Subscribing to Account Info

Use the code above to open an authenticated connection. Subscribing to the Account Info channel is automatically done when you authenticate your session. You will continue to receive updates until the connection is disconnected/terminated/restarted.

    event: "auth",
    apiKey: api_key,
    authSig: signature,
    authPayload: payload,
    authNonce: +authNonce,
    calc: 1
{ event: 'auth',
  status: 'OK',
  chanId: 0,
  userId: 269312,
  caps: '{"orders": {"read": "1", "write": "0"}, "account": {"read": "1", "write": "0"}, "funding": {"read": "1", "write": "1"}, "history": {"read": "1", "write": "0"}, "wallets": {"read": "1", "write": "1"}, "withdraw": {"read": "0", "write": "1"}, "positions": {"read": "1", "write": "1"}}' }
// response-failure


Filters can be applied to limit the information received through the channel. You can find more information about setting up filters for the account info channel here,

By default, authentication will subscribe you to all account info updates. The account info channel will be assigned a CHANNEL_ID of 0. All snapshots and updates provided through the channel will be structured as follows:

 CHANNEL_ID // = 0
 <TYPE> //'on', 'ou', 'oc', etc. 
   ... //Content goes here

Separate Streams
Please see the documentation page for each stream to find a further specification of the contents returned by each stream. The following table shows all of the included streams, their purpose, and the abbreviations by which messages in the channel can be identified:

Stream Name


Associated Abbreviations (TYPE)s


Snapshot and updates on the trade orders in your account.

'os' = order snapshot; 'on' = order new; 'ou' = order update; 'oc' = order cancel


Snapshot and updates on the positions in your account.

'ps' = position snapshot; 'pn' = position new; 'pu' = position update; 'pc' = position close


Provides a feed of your trades

'te' = trade executed; 'tu' = trade execution update

Funding Offers

Provides a snapshot and updates on the funding offers in your account.

'fos' = funding offer snapshot; 'fon' = funding offer new; 'fou' = funding offer update; 'foc' = funding offer cancel

Funding Credits

Provides a snapshot and updates on your provided funding used in active positions.

'fcs' = funding credits snapshot; 'fcn' = funding credits new; 'fcu' = funding credits update; 'fcc' = funding credits close

Funding Loans

Provides a snapshot and updates on your provided funding that is not used in active positions.

'fls' = funding loans snapshot; 'fln' = funding loans new; 'flu' = funding loans update; 'flc' = funding loans close


Provides a snapshot and updates on wallet balance, unsettled interest, and available balance.

'ws' = wallet snapshot; 'wu' = wallet update

Balance Info

Provides updates on the total and net assets in your account.

'bu' = balance update

Margin Info

Provides margin info updates (tradable balance, margin balance, margin net, margin required)

'miu' = margin info update

Funding Info

Provides funding info updates (average rates for taken and provided funding, average duration for taken and provided funding)

'fiu' = funding info update

Funding Trades

Provides a feed of your funding trades.

'fte' = funding trade execution; 'ftu' = funding trade update


Work in progress: will be used for different changes in status, price alerts, etc.

'n' = notification