General Socket - Position Events

This WebSocket allows you to receive live updates on your positions as your trades execute.

USE CASE

Track your net quantity, average prices and realised P&L live as trades execute.

Details

Subscribe with the positions action on the raw socket, or OnPositions in the Python SDK (callback on_positions). Nothing is delivered until you subscribe.
id is unique for each position, for example NSE:IDEA-EQ-INTRADAY. slNo is used to sort positions.
netQty is the net quantity and qty is its absolute value. A squared-off position is sent with netQty 0, as in the sample response.
dayBuyQty and daySellQty are today's quantities. cfBuyQty and cfSellQty are carry-forward quantities.
For cross-currency positions (crossCurrency is Y), use rbiRefRate to calculate P&L. For commodity positions, use qtyMulti_com.
The raw socket message uses different key names. The SDK renames them, for example pl_realized to realized_profit, tran_side to side, pl_total to pl and pl_unrealized to unrealized_profit.

Response Attributes - For position updates

Attribute	Data Type	Description
`symbol`	string	Eg: NSE:SBIN-EQ
`id`	string	The unique value for each position
`buyAvg`	float	Average buy price
`buyQty`	int	Total buy qty
`sellAvg`	float	Average sell price
`sellQty`	int	Total sell qty
`netAvg`	float	netAvg
`netQty`	int	Net qty
`side`	int	The side shows whether the position is long / short View Details
`qty`	int	Absolute value of net qty
`productType`	string	The product type of the position View Details
`realized_profit`	float	The realized p&l of the position
`crossCurrency`	string	Y => It is cross currency position N => It is not a cross currency position
`rbiRefRate`	float	Incase of cross currency position, the rbi reference rate will be required to calculate the p&l
`qtyMulti_com`	float	Incase of commodity positions, this multiplier is required for p&l calculation
`segment`	int	The segment in which the position is taken. View Details
`exchange`	int	The exchange in which the position is taken. View Details
`slNo`	int	This is used for sorting of positions
`fytoken`	string	Fytoken is a unique identifier for every symbol. View Details
`cfBuyQty`	int	Carry forward buy quantity
`cfSellQty`	int	Carry forward sell quantity
`dayBuyQty`	int	Day forward buy quantity
`daySellQty`	int	Day forward sell quantity
`exchange`	int	The exchange in which order is placed View Details
`buyVal`	float	Total buy value of the position.
`sellVal`	float	Total sell value of the position.

Request

from fyers_apiv3.FyersWebsocket import order_ws

def onPosition(message):
    """
    Callback function to handle incoming messages from the FyersDataSocket WebSocket.

    Parameters:
        message (dict): The received message from the WebSocket.

    """
    print("Position Response:", message)


def onerror(message):
    """
    Callback function to handle WebSocket errors.

    Parameters:
        message (dict): The error message received from the WebSocket.


    """
    print("Error:", message)


def onclose(message):
    """
    Callback function to handle WebSocket connection close events.
    """
    print("Connection closed:", message)


def onopen():
    """
    Callback function to subscribe to data type and symbols upon WebSocket connection.

    """
    # Specify the data type and symbols you want to subscribe to
    data_type = "OnPositions"

    # data_type = "OnOrders"
    # data_type = "OnTrades"
    # data_type = "OnGeneral"
    # data_type = "OnOrders,OnTrades,OnPositions,OnGeneral"

    fyers.subscribe(data_type=data_type)

    # Keep the socket running to receive real-time data
    fyers.keep_running()


# Replace the sample access token with your actual access token obtained from Fyers
access_token = "AAAAAAAA-100:eyJ..."

# Create a FyersDataSocket instance with the provided parameters
fyers = order_ws.FyersOrderSocket(
    access_token=access_token,  # Your access token for authenticating with the Fyers API.
    write_to_file=False,        # A boolean flag indicating whether to write data to a log file or not.
    log_path="",                # The path to the log file if write_to_file is set to True (empty string means current directory).
    on_connect=onopen,          # Callback function to be executed upon successful WebSocket connection.
    on_close=onclose,           # Callback function to be executed when the WebSocket connection is closed.
    on_error=onerror,           # Callback function to handle any WebSocket errors that may occur.
    on_positions=onPosition,    # Callback function to handle position-related events from the WebSocket.
)


# Establish a connection to the Fyers WebSocket
fyers.connect()

{
    "s":"ok",
    "positions":{
        "symbol":"NSE:IDEA-EQ",
        "id":"NSE:IDEA-EQ-INTRADAY",
        "buyAvg":8,
        "buyQty":1,
        "buyVal":8,
        "sellAvg":7.95,
        "sellQty":1,
        "sellVal":7.95,
        "netAvg":0,
        "netQty":0,
        "side":0,
        "qty":0,
        "productType":"INTRADAY",
        "realized_profit":-0.04999999999999982,
        "rbiRefRate":1,
        "fyToken":"101000000014366",
        "exchange":10,
        "segment":10,
        "dayBuyQty":1,
        "daySellQty":1,
        "cfBuyQty":0,
        "cfSellQty":0,
        "qtyMulti_com":1
    }
  }