This Python project demonstrates how to connect to the Upstox Websocket API for streaming live market data. It fetches market data for a list of instrument keys and decodes the incoming protobuf data to a JSON format.
These instructions will help you run the sample websocket client.
Before you can run this script, you need to have Python 3.8 or later installed on your system. If you haven’t installed Python yet, you can download it from the official website:
You will also need to install several Python packages:
upstox-python-sdkwebsocketsasyncioprotobufYou can install these packages using pip, a package manager for Python. Open a terminal and enter the following command:
pip install upstox-python-sdk websockets asyncio protobuf
Generate the Protobuf classes in Python from .proto file.
Before you can generate the Protobuf classes, you need to download the proto file and install the Protocol Buffers compiler (protoc).
To download the Protocol Buffers compiler, go to the Google Protocol Buffers GitHub repository and download the appropriate protoc-<version>-<os>.zip file for your operating system. Extract the ZIP file and add the bin directory to your system PATH.
For example, on a Unix-like system, you can add the directory to your PATH like this:
export PATH=$PATH:/path/to/protoc/bin
You can confirm that the compiler is correctly installed by opening a new terminal window and running the following command:
protoc --version
This should print the protoc version.
Navigate to the directory containing your .proto files and run the following command:
protoc --python_out=. *.proto
This will generate .py files for each .proto file in the directory.
In your Python code, you can now import the generated classes like any other Python module. For example, if you have a file MarketDataFeed.proto and you’ve generated MarketDataFeed_pb2.py, you can import it like this:
import MarketDataFeed_pb2 as pb
Sample class (MarketDataFeed_pb2.py) included as part of this repo.
The script requires an Upstox API access token for authorization. You will need to specify your Upstox API access token in the Python script. Look for the line below and replace ‘ACCESS_TOKEN’ with your actual access token.
configuration.access_token = 'ACCESS_TOKEN'
After installing the prerequisites and setting up your access token, you can run the script. Navigate to the directory containing the script and run the following command:
python3 websocket_client.py
Replace websocket_client.py with the name of your Python script.
The script first sets up an SSL context and an OAuth2 access token for authorization. It fetches the authorized redirect URI from the Upstox server and uses this to establish a connection to the Websocket server.
| The script sends a subscription request for “NSE_INDEX | Nifty Bank” and “NSE_INDEX | Nifty 50”. When it receives data from the server, it decodes the protobuf data into a FeedResponse object, converts this object into a dictionary, and then prints the dictionary. |
If you encounter any problems or have any questions about this project, feel free to open an issue in this repository.
This is a sample script meant for educational purposes. It may require modifications to work with your specific requirements.
Please replace 'ACCESS_TOKEN' with your actual access token and websocket_client.py with the name of your Python script. Modify any other details as needed to fit your project.