WebSocket Connection

The XBTFX WebSocket API provides real-time streaming market data including price quotes and order book depth.

Connection URL

wss://ws.xbtfx.com/v1/ws

wss://interface.xbtfx.com/v1/ws also works as an alias.

Authentication

After opening a WebSocket connection, you must authenticate by sending an auth message as the first message:

{
  "action": "auth",
  "token": "your_api_key_here"
}

The server responds with a confirmation:

{
  "action": "auth_ok",
  "login": 12345678,
  "tier": "standard"
}

If authentication fails, the server responds with:

{
  "action": "auth_error",
  "message": "Invalid API key"
}

Connection Limits

Limit	Value
Max connections per API key	10
Max subscriptions per connection	1000

Message Format

All messages are JSON. Client messages use an action field to identify the request. Server responses use action for auth messages and channel for data messages.

Client Messages

Action	Description
`auth`	Authenticate the connection
`subscribe`	Subscribe to a channel
`unsubscribe`	Unsubscribe from a channel

Server Messages

Field	Value	Description
`action`	`auth_ok`	Authentication succeeded
`action`	`auth_error`	Authentication failed
`channel`	`quote`	Price quote update

Connection Lifecycle

Open a WebSocket connection to wss://ws.xbtfx.com/v1/ws
Send an auth message with your API key
Wait for the auth_ok response
Subscribe to symbols you want to receive quotes for
Process incoming quote messages
Unsubscribe or close the connection when done

Example (JavaScript)

const ws = new WebSocket("wss://ws.xbtfx.com/v1/ws");

ws.onopen = () => {
  ws.send(JSON.stringify({
    action: "auth",
    token: "your_api_key_here"
  }));
};

ws.onmessage = (event) => {
  const msg = JSON.parse(event.data);

  if (msg.action === "auth_ok") {
    ws.send(JSON.stringify({
      action: "subscribe",
      channel: "quotes",
      symbols: ["EURUSD", "GBPUSD"],
      depth: true
    }));
  }

  if (msg.channel === "quote") {
    console.log(`${msg.symbol}: ${msg.bid} / ${msg.ask} (spread: ${msg.spread})`);
  }
};

Keep-Alive

The server sends periodic ping frames. Most WebSocket libraries handle pong responses automatically. If your connection drops, reconnect and re-authenticate.