How To Connect Using WebSocket API

Overview

The WebSocket API provides a persistent, real-time connection for receiving market data and interacting with our services. To establish a successful connection, you will need the following credentials and connection details:

Endpoint – The WebSocket server address provided by our team.
Port Number – The port on which the WebSocket service is available.
API Key – Your unique authentication key used to access the API.

Connection Workflow

Follow the steps below to connect and start receiving data through the WebSocket API:

Step 1: Establish a WebSocket Connection

Create a WebSocket connection using the endpoint and port number provided.
ws://endpoint:port/

Step 2: Authenticate

After the connection is established, send an authentication request containing your API key.

Authentication is mandatory before any other API requests can be processed.

Step 3: Verify Authentication

Wait for the authentication response from the server.
If authentication is successful, you can proceed with data requests.
If authentication fails, verify your API key and connection details before retrying.

Step 4: Send Data Requests
Once authenticated, you can send requests for market data and other supported WebSocket functions.

Step 5: Handle Disconnections

If the WebSocket connection is interrupted for any reason (network issues, server restart, timeout, etc.), your application should automatically reconnect and repeat the following process:

Establish a new WebSocket connection.
Send the authentication request.
Wait for successful authentication.
Resubscribe or resend the required data requests.

Connection Flow Diagram