Websocket Overview - QFEX API Documentation

QFEX provides 2 endpoints for websocket:

mds.qfex.com for public market and reference data.
trade.qfex.com for order entry and private data.

These endpoints have a common set of enums.

Getting Started

You can connect to our websocket endpoints directly using your preferred language or websocket client library.

Setup Python

import websocket
import json

def on_message(ws, message):
    data = json.loads(message)
    print("Received:", data)

ws = websocket.WebSocketApp(
    "wss://mds.qfex.com",
    on_message=on_message
)

ws.run_forever()

Setup Node

import WebSocket from "ws";

const ws = new WebSocket("wss://mds.qfex.com");

ws.on("open", () => {
  console.log("Connected");
  // Example: subscribe to trades
  ws.send(JSON.stringify({
    type: "subscribe",
    channel: "trades",
    symbol: "BTC-USD"
  }));
});

ws.on("message", (message) => {
  console.log("Received:", message.toString());
});

Setup Go

package main

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

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

  // Example: subscribe to order book
  sub := map[string]interface{}{
    "type": "subscribe",
    "channel": "book",
    "symbol": "BTC-USD",
  }
  c.WriteJSON(sub)

  for {
    _, message, err := c.ReadMessage()
    if err != nil {
      log.Println("read:", err)
      return
    }
    fmt.Printf("recv: %s\n", message)
  }
}

Authentication

All websocket connections to trade.qfex.com require an API Key.
You must include it in the connection headers:

X-QFEX-API-KEY: YOUR_API_KEY_HERE

API Documentation

WebSocket

​Getting Started

​Authentication

Getting Started

Authentication