API  Version 2.0.1
Low-Latency HFT API
 All Classes Functions Variables
API2::COMMON::InstrumentPosition Struct Reference

The InstrumentPosition struct Provides the basic information like Open Qty, OpenSide, Traded Quantity in Buy/Sell Side,
Average traded Price in Buy/Sell Side, Booked and Mark-To-Market Profit and loss. More...

#include <sgCommon.h>

Public Member Functions

SIGNED_LONG getOpenQty ()
 getOpenQty, To get the Open Quantity i,e Buy Qty-Sell Qty More...
 
SIGNED_LONG getTradedQty (const DATA_TYPES::OrderMode &mode)
 getTradedQty To get Traded Quantity at requested OrderMode More...
 
DATA_TYPES::OrderMode getOpenSide ()
 getOpenSide, To get Open Side Position, if BuyQty>SellQty, returns API2::CONSTANTS::CMD_OrderMode_BUY else API2::CONSTANTS::CMD_OrderMode_SELL More...
 
SIGNED_LONG getBookedPnl ()
 getBookedPnl, To get Booked Pnl More...
 
SIGNED_LONG getMtmPnl (UNSIGNED_LONG ltp)
 getMtmPnl, To get Mark to Market Pnl More...
 
DATA_TYPES::PRICE getAvgPrice (const DATA_TYPES::OrderMode &mode)
 getAvgPrice, Get Average Trade Price at requested OrderMode More...
 
UNSIGNED_LONG getPendingQty (const DATA_TYPES::OrderMode &mode)
 getPendingQty, To get Quantity Pending (or not filled) More...
 

Detailed Description

The InstrumentPosition struct Provides the basic information like Open Qty, OpenSide, Traded Quantity in Buy/Sell Side,
Average traded Price in Buy/Sell Side, Booked and Mark-To-Market Profit and loss.

Member Function Documentation

DATA_TYPES::PRICE API2::COMMON::InstrumentPosition::getAvgPrice ( const DATA_TYPES::OrderMode &  mode)

getAvgPrice, Get Average Trade Price at requested OrderMode

Parameters
mode
Returns
Average Price as DATA_TYPES::SIGNED_LONG in paisa ( to convert in Rupee, convert to float and divide by 100)
SIGNED_LONG API2::COMMON::InstrumentPosition::getBookedPnl ( )

getBookedPnl, To get Booked Pnl

Returns
Booked PnL as DATA_TYPES::SIGNED_LONG in paisa ( to convert in Rupee, convert to float and divide by 100)
SIGNED_LONG API2::COMMON::InstrumentPosition::getMtmPnl ( UNSIGNED_LONG  ltp)

getMtmPnl, To get Mark to Market Pnl

Parameters
ltp,Lasttrade Price is to be provided
Returns
Mark to Market Pnl as DATA_TYPES::SIGNED_LONG in paisa ( to convert in Rupee, convert to float and divide by 100)
SIGNED_LONG API2::COMMON::InstrumentPosition::getOpenQty ( )

getOpenQty, To get the Open Quantity i,e Buy Qty-Sell Qty

Returns
DATA_TYPES::OrderMode API2::COMMON::InstrumentPosition::getOpenSide ( )

getOpenSide, To get Open Side Position, if BuyQty>SellQty, returns API2::CONSTANTS::CMD_OrderMode_BUY else API2::CONSTANTS::CMD_OrderMode_SELL

Returns
OpenSide as DATA_TYPES::OrderMode
UNSIGNED_LONG API2::COMMON::InstrumentPosition::getPendingQty ( const DATA_TYPES::OrderMode &  mode)

getPendingQty, To get Quantity Pending (or not filled)

Parameters
mode
Returns
SIGNED_LONG API2::COMMON::InstrumentPosition::getTradedQty ( const DATA_TYPES::OrderMode &  mode)

getTradedQty To get Traded Quantity at requested OrderMode

Parameters
modeDATA_TYPES::CMD_OrderMode
Returns
traded Qty as DATA_TYPES::QTY

The documentation for this struct was generated from the following file: