- Endpoint:
wss://trade.qfex.com?api_key=YOUR_API_KEY - Authenticate within 1 minute of connecting.
1) Authenticate
Send this immediately after you connect:{ "type": "auth", "params": { "hmac": { "public_key": "qfex_pub_xxxxx", "nonce": "c0ffee...", "unix_ts": 1760545414, "signature": "5f2e..." } } }
2) Add Order
Adding a stop order follows the same pattern as adding a typical order. The direction given must be the eventual direction of the triggered order that is placed into the book. TAKE_PROFIT and STOP_LOSS orders cannot exceed your current position, attempting to do this could cause your order to be rejected or other stop orders to be cancelled.{
"type": "add_order",
"params": {
"symbol": "AAPL-USD",
"side": "BUY",
"order_type": "TAKE_PROFIT",
"order_time_in_force": "GTC",
"quantity": 1,
"price": 200
}
}
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
symbol | string | ✅ | The market symbol (e.g. AAPL-USD). |
side | enum | ✅ | Order direction. See OrderDirection. |
order_type | enum | ✅ | Type of order. See OrderType. |
order_time_in_force | enum | ✅ | Time in force policy. Required for legacy reasons, the value will not be read. |
quantity | number | ✅ | Quantity of the order. Must respect lot size but not min/max limits. |
price | number | ✅ | Price for when the order is triggered. |
⚠️ Notes:
- Tick size, lot size, and min/max order quantity are symbol-specific. See Reference Data API.
- An order may be rejected with OrderStatus codes if parameters are invalid.
Sample Code
# Python (websocket-client)
# pip install websocket-client
import json
import websocket
API_KEY = "YOUR_API_KEY"
def send(ws, obj):
ws.send(json.dumps(obj))
def on_open(ws):
# 1) Authenticate
# 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..." }}})
# 2) Add stop order
send(ws, {
"type": "add_order",
"params": {
"symbol": "AAPL-USD",
"side": "BUY",
"order_type": "TAKE_PROFIT",
"order_time_in_force": "GTC",
"quantity": 1,
"price": 200
}
})
ws = websocket.WebSocketApp(
"wss://trade.qfex.com?api_key=YOUR_API_KEY",
on_open=on_open,
on_message=lambda _, m: print(m),
on_error=lambda _, e: print("Error:", e),
on_close=lambda *_: print("Closed"),
)
ws.run_forever()
// Node.js (ws)
// npm i ws
const WebSocket = require("ws");
const ws = new WebSocket("wss://trade.qfex.com?api_key=YOUR_API_KEY");
ws.on("open", () => {
// 1) Authenticate
ws.send(
JSON.stringify({ type: "auth", params: { api_key: "YOUR_API_KEY" } })
);
// 2) Add stop order
ws.send(
JSON.stringify({
type: "add_order",
params: {
symbol: "AAPL-USD",
side: "BUY",
order_type: "TAKE_PROFIT",
order_time_in_force: "GTC",
quantity: 1,
price: 200,
},
})
);
});
ws.on("message", (m) => console.log(m.toString()));
ws.on("error", (e) => console.error("WS error:", e));
ws.on("close", (code, reason) =>
console.log("Closed:", code, reason?.toString())
);
// Go (gorilla/websocket)
// go get github.com/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()
// 1) Authenticate
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..."}}
})
// 2) Add stop order
mustWriteJSON(c, map[string]any{
"type": "add_order",
"params": map[string]any{
"symbol": "AAPL-USD",
"side": "BUY",
"order_type": "TAKE_PROFIT",
"order_time_in_force": "GTC",
"quantity": 1,
"price": 200,
},
})
}
// Java (OkHttp WebSocket)
// Gradle: implementation("com.squareup.okhttp3:okhttp:4.12.0")
import java.util.concurrent.TimeUnit;
import okhttp3.*;
public class AddOrderWs {
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) {
// 1) Authenticate
ws.send("{\"type\": \"auth\", \"params\": { \"hmac\": { \"public_key\": \"qfex_pub_xxxxx\", \"nonce\": \"c0ffee...\..\", \"unix_ts\": 1760545414, \"signature\": \"5f2e...\" }}}");
// 2) Add stop order
ws.send("{\"type\":\"add_order\",\"params\":{\"symbol\":\"AAPL-USD\",\"side\":\"BUY\",\"order_type\":\"TAKE_PROFIT\",\"order_time_in_force\":\"GTC\",\"quantity\":1,\"price\":200}}");
}
@Override public void onMessage(WebSocket ws, String text) {
System.out.println(text);
}
@Override public void onFailure(WebSocket ws, Throwable t, Response r) {
System.err.println("WS error: " + t.getMessage());
}
};
client.newWebSocket(req, li);
try { Thread.sleep(Long.MAX_VALUE); } catch (InterruptedException ignored) {}
}
}
Example Response
When you place an order, you will receive anorder_response with status ACK:
{
"order_response": {
"order_id": "5b309929-206f-40ec-804d-cbe46e81afc1",
"symbol": "AAPL-USD",
"status": "ACK",
"quantity": 1.0,
"price": 200.0,
"take_profit": 0.0,
"stop_loss": 0.0,
"side": "BUY",
"type": "TAKE_PROFIT",
"time_in_force": "GTC",
"user_id": "0020ce8e-eaee-480e-8d7f-b9241d756ee5",
"client_order_id": "",
"quantity_remaining": 1.0
}
}