Getting Started

Introduction

• The WebSocket serves as an advanced technology that enables the establishment of a bi-directional communication channel between a user's browser and a server. Through this, users can seamlessly send messages to a server and receive responses driven by events, eliminating the need for continuous polling of the server for replies.
• With the WebSocket, users gain the capability to access real-time quotes for all scripts across various Indian Exchanges during market hours. These data feeds are broadly classified into three categories: Market Feed ,OrderUpdate Feed and PositionUpdate Feed. Upon initiating a new connection, users can anticipate receiving an acknowledgment for successful connection establishment.

Create Session

• Copy the susertoken from the login API

Connection String

Create Connection to Websocket using the following URL:

wss://socket.firstock.in/ws

Send the Following Data in the query params of Websockets

wss://socket.firstock.in/ws?userId=AB1234&jKey=cae0e3af6f26583c0e19b83c91f207466199b7fef5e66160b8ff02511205d651&source=developer-api

Response Structure

Success Response

If the credentials and API key are valid, you will receive a 200 OK status with a JSON response containing the following fields:

1. status: Indicates a successful request (e.g., "success").
2. message: Provides a short description of the outcome (e.g., "Authentication successful").

Failure Response

If any required fields are missing or invalid, you will receive a 401 status code with a structure like:

1. status: Typically "failed".
2. messafe: Provides a short description of the outcome (e.g., "Aunauthenticated").

Response

        {"status":"success","message":"Authentication successful"}
        

                    {"status":"failed","message":"unauthenticated"}
                

Usage & Best Practices