> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qfex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Subscribe — Positions

Subscribe to the **positions** channel to receive pulsed position updates for all symbols.\
Messages are pushed every **1 second**.

## 1) Authenticate

```json theme={null}
{
  "type": "auth",
  "params": {
    "hmac": {
      "public_key": "qfex_pub_xxxxx",
      "nonce": "c0ffee...",
      "unix_ts": 1760545414,
      "signature": "5f2e..."
    }
  }
}
```

## 2) Subscribe

```json theme={null}
{ "type": "subscribe", "params": { "channels": ["positions"] } }
```

## Sample Code

<CodeGroup>
  ```python python theme={null}
  # Python (websocket-client)
  import json, websocket

  API_KEY = "YOUR_API_KEY"

  def send(ws, obj): ws.send(json.dumps(obj))

  def on_open(ws):
      # https://docs.qfex.com/websocket/channels/trade/authenticate#how-it-works
      send(ws, {"type": "auth", "params": { "hmac": { "public_key": "qfex_pub_xxxxx", "nonce": "c0ffee...", "unix_ts": 1760545414, "signature": "5f2e..." }}})
      send(ws, {"type": "subscribe", "params": {"channels": ["positions"]}})

  ws = websocket.WebSocketApp(
      "wss://trade.qfex.com?api_key=YOUR_API_KEY",
      on_open=on_open,
      on_message=lambda _, m: print("Message:", m),
  )
  ws.run_forever()
  ```

  ```javascript node theme={null}
  // Node.js (ws)
  import WebSocket from "ws";
  const API_KEY = "YOUR_API_KEY";
  const ws = new WebSocket("wss://trade.qfex.com?api_key=YOUR_API_KEY");

  ws.on("open", () => {
    ws.send(JSON.stringify({ type: "auth", params: { api_key: API_KEY } }));
    ws.send(
      JSON.stringify({ type: "subscribe", params: { channels: ["positions"] } })
    );
  });

  ws.on("message", (msg) => console.log("Message:", msg.toString()));
  ```

  ```go go theme={null}
  // Go (gorilla/websocket)
  package main

  import (
  	"log"
  	"github.com/gorilla/websocket"
  )

  func mustWriteJSON(c *websocket.Conn, v any) {
  	if err := c.WriteJSON(v); err != nil { log.Fatal("write:", err) }
  }

  func main() {
  	c, _, err := websocket.DefaultDialer.Dial("wss://trade.qfex.com?api_key=YOUR_API_KEY", nil)
  	if err != nil { log.Fatal("dial:", err) }
  	defer c.Close()

  	mustWriteJSON(c, map[string]any{
  		"type": "auth",
  		"params": map[string]any{"hmac": map[string]any{"public_key": "qfex_pub_xxxxx", "nonce": "c0ffee...", "unix_ts": 1760545414, "signature": "5f2e..."}}
  	})

  	mustWriteJSON(c, map[string]any{
  		"type": "subscribe",
  		"params": map[string]any{"channels": []string{"positions"}},
  	})

  	for {
  		_, data, err := c.ReadMessage()
  		if err != nil { log.Fatal("read:", err) }
  		log.Println(string(data))
  	}
  }
  ```

  ```java java theme={null}
  // Java (OkHttp WebSocket)
  import java.util.concurrent.TimeUnit;
  import okhttp3.*;

  public class PositionsSub {
    public static void main(String[] args) {
      OkHttpClient client = new OkHttpClient.Builder()
          .pingInterval(20, TimeUnit.SECONDS).build();

      Request req = new Request.Builder().url("wss://trade.qfex.com?api_key=YOUR_API_KEY").build();

      WebSocketListener li = new WebSocketListener() {
        @Override public void onOpen(WebSocket ws, Response r) {
          ws.send("{\"type\": \"auth\", \"params\": { \"hmac\": { \"public_key\": \"qfex_pub_xxxxx\", \"nonce\": \"c0ffee...\..\", \"unix_ts\": 1760545414, \"signature\": \"5f2e...\" }}}");
          ws.send("{\"type\":\"subscribe\",\"params\":{\"channels\":[\"positions\"]}}");
        }
        @Override public void onMessage(WebSocket ws, String text) {
          System.out.println(text);
        }
      };

      client.newWebSocket(req, li);
      try { Thread.sleep(Long.MAX_VALUE); } catch (InterruptedException ignored) {}
    }
  }
  ```
</CodeGroup>

## Example Responses

```json theme={null}
{ "subscribed": "positions" }
```

```json theme={null}
{
  "position_response": {
    "id": "c003ad60-ded4-401b-9b4c-e255a53d32ea",
    "symbol": "AAPL-USD",
    "position": 0.0,
    "margin_alloc": 0.0,
    "realised_pnl": 0.0,
    "unrealised_pnl": 0.0,
    "net_funding": 0.0,
    "open_orders": 0.0,
    "open_quantity": 0.0,
    "leverage": 20.0,
    "initial_margin": 0.05,
    "maintenance_margin": 0.03333333333333333,
    "average_price": 0.0
  }
}
```

<Note>Position updates are **pulsed every 10 seconds**.</Note>
