Nuvama Wealth Skip to main content

API Connect Document

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Library API Connect is a set of REST-like APIs that expose many capabilities required to build a complete investment and trading platform. Execute orders in real time, manage user portfolio, stream live market data (WebSockets), and more, with the simple HTTP API collection This module provides an easy to use abstraction over the HTTP APIs. The HTTP calls have been converted to methods and their JSON responses are returned.

API Usage Threshold

Parameter Limit If breached?
Number of API orders allowed per day 2000 App will get blocked for a specified time period communicated over email, repetetive breaches may lead to permanent blocking.

* 15 mins for the first breach
* 30 mins for 2nd breach
* 1 hr for 3rd breach
* 2 hrs for 4th breach
* full day for 5th breach
Total API requests allowed per day 86400
Order:Trade ratio (A → Number of API Hits for ( Order Placed /Modify / Cancel ) B → total Trades OTR = A/B (rounded to the nearest integer)) 49:1
Allowed orders placed per second 10 Reject the orders.
Continuous API requests 3000 / 5 min / IP API requests will be get blocked for 1 min during which any further API requests will get rejected

Authentication

  • API Key (Authorization)
    • Parameter Name: Authorization, in: header. Requests should pass an access token for accessing logged in APIs

Common-Login

User's Phone and Email API

Create a successful login flow from code would require three things –

  • a. API key – provided by Nuvama
  • b. API secret – provided by Nuvama
  • c. Request id – Token to be collected post redirection from Login URL using Nuvama credentials. On successful authentication, the Request id will be mentioned in the address bar after redirection to the Redirect URL (default - https://127.0.0.1/)

To validate vendor id and password & generate session

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);

POST /accounts/loginvendor/{vendorID}

Body parameter

{
  "pwd": "string"
}

Parameters

Name In Type Required Description
vendorID path string true vendor id of the client (api Key)
source header string true none
body body true none

Example responses

200 Response

{
  "msg": "string",
  "success": false
}

Responses

Status Meaning Description Schema
200 OK successful operation
default Default unexpected error

Returns login data for requested request id

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.GetAuthorization(reqId)

POST /accounts/logindata

Body parameter

{
  "reqId": "string"
}

Parameters

Name In Type Required Description
SourceToken header string true key obtained from the generate sesion.
AppIdKey header string true key obtained from the generate sesion.
body body false none

Example responses

200 Response

{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "auth": "string",
    "lgnData": {
      "accTyp": "EQ",
      "mrgSts": "COMPLETED",
      "othAccDts": {
        "accTyp": "string",
        "isAct": false,
        "isOnline": false,
        "uid": "string"
      },
      "mrgPopUp": false,
      "mrgAccDts": {
        "uids": [
          {
            "accTyp": "string",
            "uid": "string",
            "alwd": false
          }
        ],
        "phNos": [
          "string"
        ],
        "emIds": [
          "string"
        ]
      },
      "prefAccTyp": "string",
      "excs": [
        "string"
      ],
      "dfPrds": {
        "nse": {
          "by": "string",
          "sl": "string"
        },
        "bse": {
          "by": "string",
          "sl": "string"
        },
        "nfo": {
          "by": "string",
          "sl": "string"
        },
        "bfo": {
          "by": "string",
          "sl": "string"
        },
        "cds": {
          "by": "string",
          "sl": "string"
        },
        "mcx": {
          "by": "string",
          "sl": "string"
        },
        "ncdex": {
          "by": "string",
          "sl": "string"
        }
      },
      "dfPrdsMTF": {
        "nse": {
          "by": "string",
          "sl": "string"
        },
        "bse": {
          "by": "string",
          "sl": "string"
        },
        "nfo": {
          "by": "string",
          "sl": "string"
        },
        "bfo": {
          "by": "string",
          "sl": "string"
        },
        "cds": {
          "by": "string",
          "sl": "string"
        },
        "mcx": {
          "by": "string",
          "sl": "string"
        },
        "ncdex": {
          "by": "string",
          "sl": "string"
        }
      },
      "ordTypes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "sts": "OK",
      "accs": {
        "eqBrkCode": "string",
        "coBrkCode": "string",
        "eqBrId": "string",
        "coBrId": "string",
        "llt": "string",
        "eqAccID": "string",
        "eqAccName": "string",
        "coAccID": "string",
        "coAccName": "string",
        "uid": "string",
        "eqBrk": "string",
        "coBrk": "string",
        "rstpwd": false,
        "rstusr": false,
        "eqstwt": false,
        "costwt": false,
        "bseMfstwt": false,
        "eqRmRt": "N",
        "eqEmpCat": "string",
        "coEmpCat": "string",
        "eqAlgoClnt": "string",
        "prfId": "string",
        "ucmCd": "string",
        "eqDob": "string",
        "coDob": "string",
        "wtspCnsnt": "string",
        "eml": "string",
        "mfInf": false,
        "cdslEsFlg": false
      },
      "qlist": [
        {
          "idx": "string",
          "ques": "string"
        }
      ],
      "mtf": {
        "sts": "string",
        "popFl": "string"
      },
      "comOpCnst": {
        "sts": "string",
        "popFl": "string"
      },
      "adhrEQ": {
        "rlEDt": "string",
        "rlFl": "string",
        "sts": "string",
        "popFl": "string"
      },
      "adhrCOM": {
        "rlEDt": "string",
        "rlFl": "string",
        "sts": "string",
        "popFl": "string"
      },
      "cnsntLst": [
        {
          "name": "string",
          "accType": "string",
          "mdtry": false
        }
      ],
      "prdcts": {
        "property1": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "property2": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        }
      },
      "prds": [
        {
          "exc": "string",
          "prd": [
            {
              "prdDpNm": "string",
              "prdVal": "string",
              "validity": [
                {
                  "dpNm": "string",
                  "vaVal": "string"
                }
              ]
            }
          ]
        }
      ],
      "val": [
        {
          "exc": "string",
          "validity": [
            {
              "dpNm": "string",
              "vaVal": "string"
            }
          ]
        }
      ],
      "gtdGtcValDays": "string",
      "mndtryCnsts": [
        {
          "name": "string",
          "accType": "string",
          "mdtry": false
        }
      ],
      "optCnsts": [
        {
          "name": "string",
          "accType": "string",
          "mdtry": false
        }
      ],
      "srcVendor": "string",
      "vndSrc": "string",
      "reqId": "string",
      "url": "string",
      "jsessionId": "string",
      "vndCnstPopUp": false
    },
    "time": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation
222 Unknown Request id expired
default Default unexpected error

logs out user

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.Logout();

PUT /account/logoff/{userID}

Parameters

Name In Type Required Description
userID path string true none

Example responses

200 Response

{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {
    "app": 1,
    "exp": 1624409130279,
    "info": 14,
    "prmBndExp": 1620977715264
  },
  "data": {
    "type": "simpleStatusDao",
    "msg": "You have been logged out successfully."
  },
  "msgID": "060eb842-5bcc-467c-91ba-0fc6b5f9c009",
  "srvTm": 1624421670371
}

default Response

{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "error": {
    "actCd": "string",
    "errCd": "string",
    "errMsg": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation
default Default unexpected error

Trade

Api's related to Trade

Place Trade / Order Slicing

• Order placement refers to the function by which you as a user can place an order to respective exchanges. Order placement allows you to set various parameters like the symbol, action (buy, sell, stop loss buy, stop loss sell), product type, validity period and few other custom parameters and then finally place the order. Any order placed will first go through a risk validation in our internal systems and will then be sent to exchange. Usually any order successfully placed will have OrderID and ExchangeOrderID fields populated. If ExchangeOrderID is blank it usually means that the order has not been sent and accepted at respective exchange.

• Place trade API can be used for Order slicing also. Order Slicing is a feature that helps break down a large order into smaller slices. This feature is allowed on Equity derivative segment only.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.PlaceTrade(tradingSymbol,exchange, action, duration, orderType, quantity, streamingSymbol, limitPrice, disclosedQuantity, triggerPrice , productCode);

POST /eq/trade/placetrade/v1/{userID}

Body parameter

{
  "trdSym": "INE843F01014",
  "exc": "BSE",
  "action": "BUY",
  "dur": "DAY",
  "flQty": 0,
  "ordTyp": "MARKET",
  "qty": 1,
  "dscQty": 0,
  "sym": "TRICOMFRU",
  "mktPro": null,
  "lmPrc": 0,
  "trgPrc": 0,
  "prdCode": "MIS",
  "posSqr": "N",
  "minQty": 0,
  "ordSrc": "API",
  "vnCode": null,
  "rmk": null,
  "dtDays": null
}

Parameters

Parameter Description
Trading_Symbol Trading Symbol of the Scrip, to be obtained from Contract file downloaded
Exchange Name of the exchange, BSE/NSE/CDS/MCX/NCDEX/NFO/BFO
Action BUY/SELL
Duration Order validity, DAY/IOC/EOS(for BSE)
Order_Type Order type, LIMIT/MARKET/STOP_LIMIT/STOP_MARKET
Quantity Quantity of the scrip to transact
Streaming_Symbol exchangetoken to be obtained from Contract file downloaded
Limit_Price Limit price of scrip
Disclosed_Quantity Quantity to be disclosed publicly while order placement (default 0)
TriggerPrice Trigger Price applicable for SL/SL-M Orders (default 0)
ProductCode Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF (default CNC)
Name In Type Required Description
userID path string true UserId of the client
body body true none

Example responses

200 Response

//Order after slice 
{"resp":
 {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "failedShrs": "string",
    "ord": [
      {
        "lsz": "string",
        "oid": "string"
      }
    ]
  }
 }
}

//Order not sliced
{"resp":
 {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "oid": "string",
  }
 }
 }

401 Response

{
  "config": {},
  "error": {
    "actCd": "52",
    "errCd": "EGN0011",
    "errMsg": "Session Expired"
  },
  "msgID": "22eb607d-bf65-4a9f-9b59-7f60d0370857",
  "srvTm": 1623912675844
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Modify a Trade for a client

Modify orders allows a user to change certain aspects of the order once it is placed. Depending on the execution state of the order (i.e. either completely open, partially open) there are various levels of modification allowed. As a user you can edit the product type, order quantity, order validity and certain other parameters. Please note that any modifications made to an order will be sent back to the risk system for validation before being submitted and there are chances that an already placed order may get rejected in case of a modification.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.ModifyTrade( tradingSymbol, exchange, action, duration, orderType, quantity, streamingSymbol, limitPrice, orderID, disclosedQuantity , triggerPrice ,productCode, currentQuantity );

PUT /eq/trade/modifytrade/v1/{userID}

Body parameter


 {
  "trdSym": "INE409B01013",
  "exc": "NSE",
  "action": "SELL",
  "dur": "DAY",
  "flQty": "0",
  "ordTyp": "LIMIT",
  "qty": "1",
  "curQty": "1",
  "dscQty": "0",
  "sym": "11909_NSE",
  "mktPro": "",
  "lmPrc": "200.0",
  "trgPrc": "",
  "prdCode": "CNC",
  "dtDays": "",
  "nstOID": "76578587"
    }

Parameters

Parameter Description
Trading_Symbol Trading Symbol of the Scrip, to be obtained from Contract file downloaded
Exchange Name of the exchange, BSE/NSE/CDS/MCX/NCDEX/NFO/BFO
Action BUY/SELL
Duration Order validity, DAY/IOC/EOS(for BSE)
Order_Type Order type, LIMIT/MARKET/STOP_LIMIT/STOP_MARKET
Quantity Quantity of the scrip to transact
Current Quantity Current Quantity of the scrip to transact
Streaming_Symbol exchangetoken to be obtained from Contract file downloaded
Limit_Price Limit price of scrip
Order_ID Parent order Id
Disclosed_Quantity Quantity to be disclosed publicly while order placement (default 0)
TriggerPrice Trigger Price applicable for SL/SL-M Orders (default 0)
ProductCode Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF (default CNC)
Name In Type Required Description
userID path string true USER ID of the client
body body false none

Example responses

200 Response

//Order after slice 
{"resp":
      {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "failedShrs": "string",
    "ord": [
      {
        "lsz": "string",
        "oid": "string"
      }
    ]
  }
 }
}

//Order not sliced
{"resp":
  {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "oid": "string",
  }
 }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Cancel trade for a client.

An order can be cancelled, as long as on order is open or pending in the system

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.CancelTrade(orderId, exchange, orderType, productCode, Trading_Symbol, Action, streaming_symbol, CurrentQuantity);

PUT /eq/trade/canceltrade/v1/{userID}

Body parameter

{
  "nstOID": "12433232313",
  "exc": "NSE",
  "prdCode": "CNC",
  "ordTyp": "LIMIT",
  "action": "BUY",
  "trdSym": "INE793A01012",
  "sym": "7053_NSE",
  "curQty": "1"
}

Parameters

Parameter Description
OrderId Parent order Id
Exchange Name of the exchange, BSE/NSE/CDS/MCX/NCDEX/NFO/BFO
Order_Type Order type, LIMIT/MARKET/STOP_LIMIT/STOP_MARKET
ProductCode Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF (default CNC)
Action BUY/SELL
Streaming_Symbol exchangetoken to be obtained from Contract file downloaded
Trading_Symbol Trading Symbol of the Scrip, to be obtained from Contract file downloaded
Current Quantity Current Quantity of the scrip to transact
Name In Type Required Description
userID path string true USER ID of the client
body body true nstOID, exc, ordTyp, prdCode are mandatory

Example responses

200 Response


{"resp":
        {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "oid": "string"
  }
 }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Get AMO Flag

Before placing AMO order, you can check if AMO orders can be placed at this time

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.GetAMOFlag();

GET /eq/trade/amostatus/{exchange}

Example responses

200 Response

{"resp":
        {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "sts": "string"
  }
 }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Position squareOff API For Equity and Commodity

Square off is a term used in intraday and simply means closing all open positions by the end of the trading day.

OrderList : List of orders to be Squared Off.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.PositionSquareOff(orderlist);

POST /eq/trade/position/sqroff/v1/{userID}

Body parameter

{
  "sqrLst": [
    {
      "trdSym": "INE438A01022",
      "exc": "NSE",
      "action": "SELL",
      "dur": "DAY",
      "flQty": "0",
      "ordTyp": "MARKET",
      "qty": "1",
      "dscQty": "0",
      "sym": "163_NSE",
      "mktPro": "",
      "lmPrc": "0",
      "trgPrc": "0",
      "prdCode": "CO",
      "dtDays": null,
      "posSqr": "",
      "minQty": "0",
      "ordSrc": "TX3",
      "vnCode": "",
      "rmk": ""
    }
  ]
}

Parameters

Name In Type Required Description
userID path string true UserId of the client
body body true Position square off Request Fields

Example responses

200 Response


{"resp":
 {"resp":
    {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "posSqrOffs": [
      {
        "errMsg": "string",
        "errCd": "string",
        "actCd": "string",
        "msg": "string",
        "oid": "string"
      }
    ]
   }
  }
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
403 Forbidden Invalid AppID Key
500 Internal Server Error Something went wrong, please try again later
default Default unexpected error

Convert a position for a clients

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.ConvertPosition(orderId, fill Id, newProductCode, oldProductCode, exchange, orderType);

PUT /eq/trade/convertposition/v1/{userID}

Body parameter

{
  "prdCodeCh": "CNC",
  "prdCode": "NRML",
  "nstOID": "210621000000351",
  "flID": "30414",
  "exc": "BSE",
  "ordTyp": "LIMIT"
}

Parameters

Parameter Description
OrderId Parent order Id
Fill_Id Fill Id of the trade obtained from TradeBook API
New_Product_Code New Product code of the trade
Old_Product_Code Existing Product Code of the trade
Exchange Name of the exchange, BSE/NSE/CDS/MCX/NCDEX/NFO/BFO etc
orderType Order type, LIMIT/MARKET/STOP_LIMIT/STOP_MARKET
Name In Type Required Description
userID path string true USER ID of the client
body body false none

Example responses

200 Response


{"resp":        
        {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string"
    }
  } 
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Place AMO trade for a client in equity and commodity

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.PlaceAMOTrade(tradingSymbol, exchange, action, duration, orderType, quantity, streamingSymbol, limitPrice, disclosedQuantity , triggerPrice , productCode);

POST /eq/trade/amo/placetrade/v1/{userID}

Body parameter

{
  "vnCode": "118",
  "dur": "DAY",
  "sym": "8696_NSE",
  "trgPrc": "",
  "action": "BUY",
  "ordTyp": "LIMIT",
  "prdCode": "CNC",
  "posSqr": "NO",
  "amoFlg": "YES",
  "minQty": "",
  "lmPrc": "167.70",
  "mktPro": "",
  "trdSym": "INE366I01010",
  "dtDays": "",
  "dscQty": "",
  "exc": "NSE",
  "rmk": "AMO remarks",
  "qty": "1"
}

Parameters

Parameter Description
Trading_Symbol Trading Symbol of the Scrip, to be obtained from Contract file downloaded
Exchange Name of the exchange, BSE/NSE/CDS/MCX/NCDEX/NFO/BFO
Action BUY/SELL
Duration Order validity, DAY/IOC/EOS(for BSE)
Order_Type Order type, LIMIT/MARKET/STOP_LIMIT/STOP_MARKET
Quantity Quantity of the scrip to transact
Streaming_Symbol exchangetoken to be obtained from Contract file downloaded
Limit_Price Limit price of scrip
Disclosed_Quantity Quantity to be disclosed publicly while order placement (default 0)
TriggerPrice Trigger Price applicable for SL/SL-M Orders (default 0)
ProductCode Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF (default CNC)
Name In Type Required Description
userID path string true UserId of the client
body body false none

Example responses

200 Response

//Order after slice 
{"resp":
      {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "failedShrs": "string",
    "ord": [
      {
        "lsz": "string",
        "oid": "string"
      }
    ]
  }
 }
}

//Order not sliced
{"resp":
 {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "oid": "string",
  }
 }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Modify amo Trade for a client

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.ModifyAMOTrade(tradingSymbol,exchange, action, duration, orderType, quantity, streamingSymbol,limitPrice,orderID, disclosedQuantity,triggerPrice, productCode, currentQuantity);

PUT /eq/trade/amo/modifytrade/v1/{userID}

Body parameter

{
  "dur": "DAY",
  "sym": "15124_NSE",
  "trgPrc": "",
  "nstOID": "210622000285636",
  "action": "SELL",
  "ordTyp": "MARKET",
  "prdCode": "CNC",
  "lmPrc": "",
  "mktPro": "",
  "trdSym": "INE094I01018",
  "dtDays": "",
  "dscQty": "0",
  "exc": "NSE",
  "flQty": "0",
  "qty": "3",
  "curQty": "3",
  "nstReqID": "2"
}

Parameters

Parameter Description
Trading_Symbol Trading Symbol of the Scrip, to be obtained from Contract file downloaded
Exchange Name of the exchange, BSE/NSE/CDS/MCX/NCDEX/NFO/BFO
Action BUY/SELL
Duration Order validity, DAY/IOC/EOS(for BSE)
Order_Type Order type, LIMIT/MARKET/STOP_LIMIT/STOP_MARKET
Quantity Quantity of the scrip to transact
Current Quantity Current Quantity of the scrip to transact
Streaming_Symbol exchangetoken to be obtained from Contract file downloaded
Limit_Price Limit price of scrip
Order_ID Parent order Id
Disclosed_Quantity Quantity to be disclosed publicly while order placement (default 0)
TriggerPrice Trigger Price applicable for SL/SL-M Orders (default 0)
ProductCode Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF (default CNC)
Name In Type Required Description
userID path string true USER ID of the client
body body false none

Example responses

200 Response

//Order after slice 
{"resp":
      {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "failedShrs": "string",
    "ord": [
      {
        "lsz": "string",
        "oid": "string"
      }
    ]
  }
 } 
}

//Order not sliced
{"resp":
 {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "oid": "string",
  }
 } 
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Cancel AMO trade for a client in equity and commodity

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.CancelAMOTrade(orderId, exchange, orderType, productCode, Trading_Symbol, Action, streaming_symbol, CurrentQuantity);

PUT /eq/trade/amo/canceltrade/{userID}

Body parameter

{
  "nstOID": "210623000000155",
  "exc": "NSE",
  "prdCode": "CNC",
  "ordTyp": "MARKET",
  "action": "BUY",
  "trdSym": "INE793A01012",
  "sym": "7053_NSE",
  "curQty": "1"
}

Parameters

Parameter Description
OrderId Parent order Id
Exchange Name of the exchange, BSE/NSE/CDS/MCX/NCDEX/NFO/BFO
Order_Type Order type, LIMIT/MARKET/STOP_LIMIT/STOP_MARKET
ProductCode Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF (default CNC)
Action BUY/SELL
Streaming_Symbol exchangetoken to be obtained from Contract file downloaded
Trading_Symbol Trading Symbol of the Scrip, to be obtained from Contract file downloaded
Current Quantity Current Quantity of the scrip to transact
Name In Type Required Description
userID path string true USER ID of the client
body body false none

Example responses

200 Response


{"resp":
 {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "oid": "string"
  }
 }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Orders

Apis Related to clients orders, consists of order book, order logs, order history, trade book and trade history

Show order book for a client in equity (including BO)/ commodity.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.OrderBook();

GET /eq/order/book/{userID}/v1

This method will retrieve the equity and commodity Order Book.

Parameters

Name In Type Required Description
userID path string true UserId of the client
rTyp query true Request Type (PAYOUT)

Enumerated Values

Parameter Value
rTyp PAYOUT
rTyp PAYIN

Example responses

200 Response

 {"resp":{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "ord": [
      {
        "lstPos": 0,
        "stkPrc": "string",
        "isCOSecLeg": "string",
        "dur": "string",
        "vlDt": "string",
        "rcvTim": "string",
        "rcvEpTim": "string",
        "sym": "string",
        "cpName": "string",
        "exit": "string",
        "syomID": "string",
        "exc": "string",
        "ntQty": "string",
        "dpName": "string",
        "cancel": "string",
        "sipID": "string",
        "nstReqID": "string",
        "ordTyp": "LIMIT",
        "qtyUnits": "string",
        "opTyp": "string",
        "trsTyp": "string",
        "srs": "string",
        "reqQty": "string",
        "prdCode": "CNC",
        "ogt": "string",
        "flQty": "string",
        "trdSym": "string",
        "edit": "string",
        "asTyp": "string",
        "trgPrc": "string",
        "avgPrc": "string",
        "dsQty": "string",
        "ordID": "string",
        "sts": "string",
        "dpInsTyp": "string",
        "rjRsn": "string",
        "userID": "string",
        "dpExpDt": "string",
        "ltSz": "string",
        "tkSz": "string",
        "desc": "string",
        "prc": "string",
        "exONo": "string",
        "exp": "string",
        "rcvDt": "string",
        "pdQty": "string",
        "userCmnt": "string",
        "isSL": false,
        "isTgt": false,
        "flId": "string",
        "rmk": "string",
        "boSeqId": "string",
        "epochTim": "string",
        "ordTim": "string",
        "trgId": "string",
        "dpVal": "string",
        "cta": "string",
        "ltp": "string",
        "vndSrc": "string",
        "bsktOrdId": "string",
        "bsktEpch": "string",
        "algoId": "string"
        "algoCategory": "string"
        "brkOrd": [
          {
            "flLg": {
              "lstPos": 0,
              "stkPrc": "string",
              "isCOSecLeg": "string",
              "dur": "DAY",
              "vlDt": "string",
              "rcvTim": "string",
              "rcvEpTim": "string",
              "sym": "string",
              "cpName": "string",
              "exit": "string",
              "syomID": "string",
              "exc": "string",
              "ntQty": "string",
              "dpName": "string",
              "cancel": "string",
              "sipID": "string",
              "nstReqID": "string",
              "ordTyp": "LIMIT",
              "qtyUnits": "string",
              "opTyp": "string",
              "trsTyp": "string",
              "srs": "string",
              "reqQty": "string",
              "prdCode": "CNC",
              "ogt": "string",
              "flQty": "string",
              "trdSym": "string",
              "edit": "string",
              "asTyp": "string",
              "trgPrc": "string",
              "avgPrc": "string",
              "dsQty": "string",
              "ordID": "string",
              "sts": "string",
              "dpInsTyp": "string",
              "rjRsn": "string",
              "userID": "string",
              "dpExpDt": "string",
              "ltSz": "string",
              "tkSz": "string",
              "desc": "string",
              "prc": "string",
              "exONo": "string",
              "exp": "string",
              "rcvDt": "string",
              "pdQty": "string",
              "userCmnt": "string",
              "isSL": false,
              "isTgt": false,
              "flId": "string",
              "rmk": "string",
              "boSeqId": "string",
              "epochTim": "string",
              "ordTim": "string",
              "trgId": "string",
              "dpVal": "string",
              "cta": "string",
              "ltp": "string",
              "vndSrc": "string",
              "bsktOrdId": "string",
              "bsktEpch": "string"
            },
            "slLg": {
              "lstPos": 0,
              "stkPrc": "string",
              "isCOSecLeg": "string",
              "dur": "DAY",
              "vlDt": "string",
              "rcvTim": "string",
              "rcvEpTim": "string",
              "sym": "string",
              "cpName": "string",
              "exit": "string",
              "syomID": "string",
              "exc": "string",
              "ntQty": "string",
              "dpName": "string",
              "cancel": "string",
              "sipID": "string",
              "nstReqID": "string",
              "ordTyp": "LIMIT",
              "qtyUnits": "string",
              "opTyp": "string",
              "trsTyp": "string",
              "srs": "string",
              "reqQty": "string",
              "prdCode": "CNC",
              "ogt": "string",
              "flQty": "string",
              "trdSym": "string",
              "edit": "string",
              "asTyp": "string",
              "trgPrc": "string",
              "avgPrc": "string",
              "dsQty": "string",
              "ordID": "string",
              "sts": "string",
              "dpInsTyp": "string",
              "rjRsn": "string",
              "userID": "string",
              "dpExpDt": "string",
              "ltSz": "string",
              "tkSz": "string",
              "desc": "string",
              "prc": "string",
              "exONo": "string",
              "exp": "string",
              "rcvDt": "string",
              "pdQty": "string",
              "userCmnt": "string",
              "isSL": false,
              "isTgt": false,
              "flId": "string",
              "rmk": "string",
              "boSeqId": "string",
              "epochTim": "string",
              "ordTim": "string",
              "trgId": "string",
              "dpVal": "string",
              "cta": "string",
              "ltp": "string",
              "vndSrc": "string",
              "bsktOrdId": "string",
              "bsktEpch": "string"
            },
            "tgtLg": {
              "lstPos": 0,
              "stkPrc": "string",
              "isCOSecLeg": "string",
              "dur": "DAY",
              "vlDt": "string",
              "rcvTim": "string",
              "rcvEpTim": "string",
              "sym": "string",
              "cpName": "string",
              "exit": "string",
              "syomID": "string",
              "exc": "string",
              "ntQty": "string",
              "dpName": "string",
              "cancel": "string",
              "sipID": "string",
              "nstReqID": "string",
              "ordTyp": "LIMIT",
              "qtyUnits": "string",
              "opTyp": "string",
              "trsTyp": "string",
              "srs": "string",
              "reqQty": "string",
              "prdCode": "CNC",
              "ogt": "string",
              "flQty": "string",
              "trdSym": "string",
              "edit": "string",
              "asTyp": "string",
              "trgPrc": "string",
              "avgPrc": "string",
              "dsQty": "string",
              "ordID": "string",
              "sts": "string",
              "dpInsTyp": "string",
              "rjRsn": "string",
              "userID": "string",
              "dpExpDt": "string",
              "ltSz": "string",
              "tkSz": "string",
              "desc": "string",
              "prc": "string",
              "exONo": "string",
              "exp": "string",
              "rcvDt": "string",
              "pdQty": "string",
              "userCmnt": "string",
              "isSL": false,
              "isTgt": false,
              "flId": "string",
              "rmk": "string",
              "boSeqId": "string",
              "epochTim": "string",
              "ordTim": "string",
              "trgId": "string",
              "dpVal": "string",
              "cta": "string",
              "ltp": "string",
              "vndSrc": "string",
              "bsktOrdId": "string",
              "bsktEpch": "string"
            }
          }
        ]
      }
    ]
  }
 }
}

222 Response

{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "error": {
    "actCd": "54",
    "errCd": "ETRD0007",
    "errMsg": "Seems like there are no orders in your order book"
  },
  "msgID": "6a4b455e-26aa-4bce-9d4c-206eb56e4672",
  "srvTm": 1623912574579
}

Responses

Status Meaning Description Schema
200 OK successful operation
222 Unknown Empty order book
401 Unauthorized Session Expired
default Default unexpected error

Shows order details for a client in Equity/ Commodity

Please use this method to retrieve the details of single order.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.OrderDetail(orderId, exchange);

GET /eq/order/details/{userID}

Parameters

Parameter Description
OrderId Order Id
Exchange Name of the exchange, BSE/NSE/MCX/NCDEX
Name In Type Required Description
userID path string true UserId of the client
nOID query string true nOID

Example responses

200 Response

{"resp":{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "ord": [
      {
        "exc": "string",
        "ordID": "string",
        "nstReqID": "string",
        "trsTyp": "string",
        "symName": "string",
        "scName": "string",
        "prcTF": "string",
        "avgPrc": "string",
        "trgPrc": "string",
        "qtyTF": "string",
        "unFlSz": "string",
        "dsQty": "string",
        "exOID": "string",
        "sts": "string",
        "tim": "string",
        "txt": "string",
        "prcTyp": "string",
        "dur": "string",
        "prdCode": "CNC"
        "algoId": "string"
        "algoCategory": "string"
      }
    ]
  }
 }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Shows order history for a client in equity/ commodity

This method will retrieve all the historical orders placed from StartDate to EndDate

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.OrderHistory(startDate, endDate);

GET /eq/order/history/{userID}

Parameters

Parameter Description
StartDate Start Date of search
EndDate End Date of search
Name In Type Required Description
userID path string true UserId of the client
sDt query string true From Date(MM/DD/YYYY)
eDt query string true To Date((MM/DD/YYYY)

Example responses

200 Response

 {"resp":{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "hstOrdBk": [
      {
        "exc": "string",
        "ordID": "string",
        "nstReqID": "string",
        "trsTyp": "string",
        "symName": "string",
        "prcTF": "string",
        "avgPrc": "string",
        "trgPrc": "string",
        "qtyTF": "string",
        "unFlSz": "string",
        "dsQty": "string",
        "exOID": "string",
        "sts": "string",
        "rjRsn": "string",
        "ordTyp": "string",
        "dur": "string",
        "prdCode": "CNC",
        "rpTyp": "string",
        "trdSym": "string",
        "cstFirm": "string",
        "flQty": "string",
        "exTimStm": "string",
        "ordSrc": "string",
        "flDtTim": "string",
        "ordGenTyp": "string",
        "ordEntTyp": "string",
        "cta": "string"
       }
     ]
   }
  }
 }

222 Response

{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "error": {
    "actCd": "54",
    "errCd": "ETRD0009",
    "errMsg": "No data available"
  },
  "msgID": "831b9b6a-cdd3-42cd-a24f-fd863e7cab3b",
  "srvTm": 1623910403937
}

Responses

Status Meaning Description Schema
200 OK successful operation
222 Unknown No data available
401 Unauthorized Session Expired
default Default unexpected error

Holdings

Retrieving holdings response (both rms and mf) for a particular client

Retrieving CNC and MTF RMS holdings response for a particular client

Holdings comprises of the user's portfolio of long-term equity delivery stocks. An instrument in a holding's portfolio remains there indefinitely until its sold or is delisted or changed by the exchanges. Underneath it all, instruments in the holdings reside in the user's DEMAT account, as settled by exchanges and clearing institutions.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.Holdings();

GET /eq/holdings/v1/rmsholdings/{userID}

Parameters

Name In Type Required Description
userID path string true none

Example responses

200 Response

{"resp":
        {
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "eqHv": "string",
    "rmsHdg": [
      {
        "asTyp": "string",
        "cpName": "string",
        "dpName": "string",
        "exc": "string",
        "isin": "string",
        "ltSz": "string",
        "ltp": "string",
        "tkSz": "string",
        "trdSym": "string",
        "totalQty": "string",
        "totalVal": "string",
        "sym": "string",
        "cncRmsHdg": {
          "td": "string",
          "hdgVl": "string",
          "clUQty": "string",
          "hdgUQty": "string",
          "usdQty": "string",
          "t1HQty": "string",
          "clQty": "string",
          "qty": "string",
          "pdQty": "string",
          "pdCnt": "string",
          "sym": "string",
          "totQty": "string"
        },
        "mtfRmsHdg": {
          "td": "string",
          "hdgVl": "string",
          "clUQty": "string",
          "hdgUQty": "string",
          "usdQty": "string",
          "t1HQty": "string",
          "clQty": "string",
          "qty": "string",
          "pdQty": "string",
          "pdCnt": "string",
          "sym": "string",
          "totQty": "string"
        }
      }
    ]
   }
  }
 }

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Limits

Retrieving Limits for a particular client

Retrieving RMSSubLimits for a particular client

Limits refers to the cumulative margins available in your account which can be used for trading and investing in various products. Limits is a combination of the free cash you have (i.e. un-utilized cash), cash equivalent securities (usually margin pledged securities), any money which is in transit (T1/T2 day sell transaction values) and others, all of which can be used for placing orders. Usually whenever you place an order in a given asset and product type our risk management system assesses your limits available and then lets the orders go through or blocks the orders. Limits are dynamic in nature and can be influenced by the Mark to Markets in your positions and sometimes even by the LTP of your holdings.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.Limits();

GET /eq/limits/rmssublimits/{userID}

Parameters

Name In Type Required Description
userID path string true UserId of the client

Example responses

200 Response

{"resp":{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "cshAvl": "string",
    "mtmMg": "string",
    "nvl": "string",
    "nvlPer": "string",
    "exp": "string",
    "srtFall": {
      "srtFall": "string",
      "spnSrtFall": "string"
    },
    "mrgAvl": {
      "mrgAvl": "string",
      "dayOpenBal": "string",
      "stkColVal": "string",
      "mfOthColVal": "string",
      "fndAdd": "string",
      "adMrg": "string",
      "notMrg": "string"
    },
    "mrgUtd": {
      "mrgUtd": "string",
      "blkRelDlvry": "string",
      "lvPrdMrg": "string",
      "fnoSpnMrg": "string",
      "fnoExpMrg": "string",
      "spnExpMrg": "string",
      "prmPdRcd": "string",
      "rlPnl": "string",
      "unRlMtm": "string",
      "mf": "string",
      "ipoAmt": "string",
      "fndWthdrwn": "string",
      "ttpv": "string"
    },
    "unPstdChrgs": {
      "ntChrg": "string",
      "ntUnPstdChrg": {
        "subaccode": "string",
        "recorddate": "2019-08-24T14:15:22Z",
        "dpdues": "string",
        "dpcharges": "string",
        "ist": "string",
        "comoshortfall": "string",
        "fnopenality": "string",
        "pisbankbal": "string",
        "wealthpoabal": "string",
        "mtfbal": "string",
        "oth4amt": "string",
        "oth5amt": "string",
        "accode": "string"
      }
    }
   }
 }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

PositionBook

Retrieving Positions(both net and day) for a particular client

Retrieving NetPositions for a particular client

Net position usually is referred to in context of trades placed during the day in case of Equity, or can refer to carry forward positions in case of Derivatives, Currency and Commodity. It indicates the net obligation (either buy or sell) for the given day in a given symbol. Usually you monitor the net positions screen to track the profit or loss made from the given trades and will have options to square off your entire position and book the entire profit and loss.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.NetPosition();

GET /eq/positions/net/{userID}

Parameters

Name In Type Required Description
userID path string true none

Example responses

200 Response

 {"resp":{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "pos": [
      {
        "sym": "string",
        "ltp": "string",
        "ltt": "string",
        "chg": "string",
        "chgP": "string",
        "exc": "string",
        "vol": "string",
        "dpName": "string",
        "trdSym": "string",
        "asTyp": "string",
        "ltSz": "string",
        "tkSz": "string",
        "dpInsTyp": "string",
        "desc": "string",
        "dpVal": "string",
        "stkPrc": "string",
        "opTyp": "string",
        "exp": "string",
        "dpExpDt": "string",
        "opInt": "string",
        "opIntChg": "string",
        "opIntChgP": "string",
        "spot": "string",
        "rlOvrP": "string",
        "rlCAbs": "string",
        "trsTyp": "string",
        "prdCode": "CNC",
        "avgSlPrc": "string",
        "avgByPrc": "string",
        "byAmt": "string",
        "byQty": "string",
        "slAmt": "string",
        "slQty": "string",
        "ntQty": "string",
        "ntAmt": "string",
        "rlzPL": "string",
        "urlzPL": "string",
        "ntPL": "string",
        "mtm": "string",
        "prc": "string",
        "sqOff": "string",
        "mul": "string",
        "cpName": "string",
        "rchFlg": "string",
        "nwsFlg": "string",
        "cfAvgSlPrc": "string",
        "cfAvgByPrc": "string",
        "cfSlQty": "string",
        "cfByQty": "string",
        "cfSlAmt": "string",
        "cfByAmt": "string",
        "ntSlQty": "string",
        "ntByQty": "string",
        "ntSlAmt": "string",
        "ntByAmt": "string",
        "brkEvnPrc": "string",
        "uniqKey": "string",
        "pn": "string",
        "gn": "string",
        "gd": "string",
        "pd": "string"
      }
    ],
    "ntMTM": "string",
    "tdyMtm": "string",
    "urlMtm": "string",
    "npos": "string",
    "opn": "string",
    "cls": "string"
  }
}
}

222 Response

{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "error": {
    "actCd": "54",
    "errCd": "ETRD0004",
    "errMsg": "Seems like there are no positions in your account currently"
  },
  "msgID": "06bd0d76-574c-40c6-ae04-fed4261fd968",
  "srvTm": 1624426313506
}

Responses

Status Meaning Description Schema
200 OK successful operation
222 Unknown No positions
401 Unauthorized Session Expired
default Default unexpected error

TradeBook

Retrieving Equity TradeBook for a particular client

Shows trade book for a client in equity/ commodity

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.TradeBook();

GET /eq/tradebook/v1/{userID}

This method will retrieve the Trade Book.

Parameters

Name In Type Required Description
userID path string true UserId of the client
nOID query string false OrderID

Example responses

200 Response

 {"resp":{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "trade": [
      {
        "ordTim": "string",
        "trdSym": "string",
        "exONo": "string",
        "dpInsTyp": "string",
        "ntPrc": "string",
        "rmk": "string",
        "dpExpDt": "string",
        "ltSz": "string",
        "cpName": "string",
        "prdCode": "CNC",
        "flTim": "string",
        "flDt": "string",
        "flLeg": "string",
        "flID": "string",
        "fldQty": "string",
        "psCnv": "string",
        "qty": "string",
        "rjRsn": "string",
        "opTyp": "string",
        "sym": "string",
        "dpName": "string",
        "ordID": "string",
        "trsTyp": "string",
        "stkPrc": "string",
        "exc": "string",
        "chgP": "string",
        "sts": "string",
        "asTyp": "string",
        "tkSz": "string",
        "ordType": "string",
        "trdID": "string",
        "ltp": "string",
        "flQty": "string",
        "chg": "string",
        "srs": "string",
        "rcvTim": "string",
        "nstReqID": "string",
        "flPrc": "string",
        "exp": "string",
        "qtyUnits": "string",
        "epochTim": "string"
      }
    ]
  }
 }
}

222 Response

{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "error": {
    "actCd": "54",
    "errCd": "ETRD0002",
    "errMsg": "Seems like there are no trades in your trade book."
  },
  "msgID": "001a05a5-c2ce-405a-a5b2-a1783fbf1849",
  "srvTm": 1623915376485
}

Responses

Status Meaning Description Schema
200 OK successful operation
222 Unknown Empty trade book
401 Unauthorized Session Expired
default Default unexpected error

Transaction-History

Retrieving Transaction History for a particular client

Shows transaction history for a client

Code samples

GET /equity/pnl/transaction?accountId={accountId}&fromDate={fromDate}&toDate={toDate}

This method will retrieve the Transaction History.

Parameters

Name In Type Required Description
accountID query string true AccountID of the client
fromDate query string false from Date of transaction
toDate query string false to Date of transaction

Example responses

200 Response

{"resp":
        {
  "status": "true",
  "data": {
    "totalRecords": "1",
    "transactionList": [
      {
        "accountCode": "string",
        "security": "string",
        "transactionDate": "string",
        "txnType": "string",
        "action": "string",
        "exchangeName": "string",
        "quantity": "float",
        "transactionPrice": "float",
        "brokerage": "float",
        "stampDutyCharges": "float",
        "sebiTax": "float",
        "transactionCharge": "float",
        "other": "int",
        "accountID": "int",
        "tranId": "int",
        "editFlag": "int",
        "filterFlags": {
          "editable": "false"
        },
        "priceEditable": "false",
        "splitAllowed": "false",
        "scripIdentifier": "int",
        "cumulativeQuantity": "float",
        "netCharges": "float",
        "assetType": "string",
        "stax_GST": "float",
        "stt": "float",
        "tstax": "float",
        "isin": "string"
      }
    ]
  }
 }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Market-Depth

Retrieving depth for a particular symbol

Shows market depth for a symbol

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.GetMarketDepth();

GET /quote/scrip/{symbol}

This method will retrieve the depth data for a symbol.

Parameters

Name In Type Required Description
symbol path string true symbol of the scrip

Example responses

200 Response

{
  "data": {
    "qt": {
      "isOpenLow": false,
      "tkSz": "string",
      "lut": "string",
      "exc": "string",
      "isCasEligible": false,
      "isMTFEnabled": false,
      "alltmhidt": "string",
      "atp": "string",
      "akSz": "string",
      "opInt": "string",
      "ltTQty": "string",
      "alltmlodt": "string",
      "rchFlg": "string",
      "marketCap": "string",
      "chg": "string",
      "avgThreeMonth": "string",
      "trdSym": "string",
      "asSymbols": [],
      "expFlg": false,
      "referenceLimitPrice": "string",
      "isNCD": false,
      "yrLw": "string",
      "ltSz": "string",
      "isTradable": false,
      "desc": "string",
      "chgP": "string",
      "nwsFlg": "string",
      "dpVal": "string",
      "dpNm": "string",
      "sym": "string",
      "altt": "string",
      "opIntChg": "string",
      "bidPr": "string",
      "totalImbalance": "string",
      "isOpenHigh": false,
      "yrH": "string",
      "yrLwDt": "string",
      "vol": "string",
      "coCode": "string",
      "askPr": "string",
      "yrHDt": "string",
      "ntTrdVal": "string",
      "hiCt": "string",
      "c": "string",
      "loCt": "string",
      "bdSz": "string",
      "h": "string",
      "ltp": "string",
      "alltmhi": "string",
      "l": "string",
      "ltt": "string",
      "alltmlo": "string",
      "o": "string",
      "isETF": false,
      "asTyp": "string"
    },
    "mkd": {
      "ask": [
        {
          "no": "string",
          "price": "string",
          "qty": "string"
        },
        {
          "no": "string",
          "price": "string",
          "qty": "string"
        },
        {
          "no": "string",
          "price": "string",
          "qty": "string"
        },
        {
          "no": "string",
          "price": "string",
          "qty": "string"
        },
        {
          "no": "string",
          "price": "string",
          "qty": "string"
        }
      ],
      "bid": [
        {
          "no": "string",
          "price": "string",
          "qty": "string"
        },
        {
          "no": "string",
          "price": "string",
          "qty": "string"
        },
        {
          "no": "string",
          "price": "string",
          "qty": "string"
        },
        {
          "no": "string",
          "price": "string",
          "qty": "string"
        },
        {
          "no": "string",
          "price": "string",
          "qty": "string"
        }
      ],
      "buyQty": "string",
      "sellQty": "string"
    },
    "asSym": [
      {
        "exc": "string",
        "optExpIdx": "string",
        "sym": "string",
        "futExpIdx": "string"
      }
    ],
    "fdQtEq": {
      "divYld": "string",
      "pe": "string",
      "mktCap": "string",
      "pbv": "string",
      "eps": "string"
    },
    "rchSt": "string"
  },
  "msgID": "string",
  "srvTm": "string",
  "appID": "string"
}

222 Response

{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "error": {
    "actCd": "54",
    "errCd": "ETRD0002",
    "errMsg": "Seems like there are an issue with symbol."
  },
  "msgID": "001a05a5-c2ce-405a-a5b2-a1783fbf1849",
  "srvTm": 1623915376485
}

Responses

Status Meaning Description Schema
200 OK successful operation
222 Unknown Empty reponse
401 Unauthorized Session Expired
default Default unexpected error

Charting

Api's related to Charting

Intraday tick by tick Historical Data

The exchange provides data for every tick received by the exchange from various market participants.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.GetIntradayChart(ChartExchangeEnum exchange,ChartAssetTypeEnum assetType,
ChartIntradayIntervalEnum interval,string symbol,string tillDate=null,bool includeContinousFuture=false);

POST /charts/v2/main/{interval}/{exc}/{aTyp}/{symbol}

Parameters

Parameter Description
Interval It is the candle interval or length of time that one chooses for a candle data to be displayed. The body of the candle represents the opening and closing price including high and low of candle based on the interval. The available time intervals are M15,H1,M5,M1,M30,M3
Asset_Type It is the class of asset FUTCOM,FUTSTK,OPTCUR,OPTIDX,INDEX,OPTSTK,EQUITY,OPTFUT,FUTIDX,FUTCUR
Symbol Each Symbol is unique and represents the stock identity. This is the exchange token to be obtained from the contract file downloaded
Exchange_Type It is the name of the segment like BSE, CDS,NSE,INDEX,NFO,NCDEX,MCX
Till_Date If user passes the value against the till date variable then the data is fetched until a day prior to the date selected. For eg: if you choose till date as 2022-12-07 while sending the request, the response will have the data until 2022-12-06 If user passes the ‘NULL’ against the till date variable then data is fetched till today. For eg: if the current date is 2022-12-07, when you pass None, the data is fetched till 2022-12-07
Include_Continuous_Future This attribute is applicable only for the futures - FUTIDX, FUTSTK, FUTCUR, FUTCOM
Name In Type Required Description
userID path string true UserId of the client
body body true none

Example responses

200 Response


  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": [
      ["2021-05-27 00:00:00", 11, 11.22, 11, 11, 56087],
      ["2021-06-21 00:00:00", 10.8, 10.8, 9.8, 9.8, 909],
      ["2021-07-29 00:00:00", 9.8, 9.94, 9.51, 9.7, 2440],
      ["2021-08-30 00:00:00", 9.51, 9.51, 8.39, 8.39, 5490],
      ["2021-09-30 00:00:00", 8.39, 8.39, 8.39, 8.39, 20],
      ["2021-10-25 00:00:00", 8.39, 8.39, 8.39, 8.39, 152],
      ["2021-11-29 00:00:00", 8.55, 8.71, 8.55, 8.71, 100],
      ["2021-12-31 00:00:00", 8.71, 9.09, 8.71, 9.09, 49203]
    ],
    "nextTillDate": "2006-05-29 00:00:00"
  }

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

EOD Historical Data

Provides an historical data with OHLC (open, high, low and close) values.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.GetEODChart(ChartExchangeEnum exchange, ChartAssetTypeEnum assetType,ChartEODIntervalEnum interval, string symbol, string tillDate = null, bool includeContinousFuture = false)

POST /charts/v2/main/{interval}/{exc}/{aTyp}/{symbol}

Parameters

Parameter Description
Interval It is the candle interval or length of time that one chooses for a candle data to be displayed. The body of the candle represents the opening and closing price including high and low of candle based on the interval. The available time intervals are MN1,W1,D1 respectively
Asset_Type It is the class of asset FUTCOM,FUTSTK,OPTCUR,OPTIDX,INDEX,OPTSTK,EQUITY,OPTFUT,FUTIDX,FUTCUR
Symbol Each Symbol is unique and represents the stock identity. This is the exchange token to be obtained from the contract file downloaded
Exchange_Type It is the name of the segment like BSE, CDS,NSE,INDEX,NFO,NCDEX,MCX
Till_Date If user passes the value against the till date variable then the data is fetched until the preceding year of the same day . For eg: if you choose till date as 2021-12-31 while sending the request, then the response will have the data until 2020-12-31 If user passes the NULL value against the till date then the data will be fetched till date.
Include_Continuous_Future This attribute is applicable only for the futures - FUTIDX, FUTSTK, FUTCUR, FUTCOM
Name In Type Required Description
userID path string true UserId of the client
body body true none

Example responses

200 Response


  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": [
      ["2021-05-27 00:00:00", 11, 11.22, 11, 11, 56087],
      ["2021-06-21 00:00:00", 10.8, 10.8, 9.8, 9.8, 909],
      ["2021-07-29 00:00:00", 9.8, 9.94, 9.51, 9.7, 2440],
      ["2021-08-30 00:00:00", 9.51, 9.51, 8.39, 8.39, 5490],
      ["2021-09-30 00:00:00", 8.39, 8.39, 8.39, 8.39, 20],
      ["2021-10-25 00:00:00", 8.39, 8.39, 8.39, 8.39, 152],
      ["2021-11-29 00:00:00", 8.55, 8.71, 8.55, 8.71, 100],
      ["2021-12-31 00:00:00", 8.71, 9.09, 8.71, 9.09, 49203]
    ],
    "nextTillDate": "2006-05-29 00:00:00"
  }

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Live News

Api's related to Live News

News Categories

Categories that user can chose based on his/her discretion

Code samples

GET /liveNews/getfiltersandcatagories

Example responses

200 Response


   {"resp":
   {
     "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
     "srvTm": 1660900624895,
     "data": {
        "ctLst": [
          {
            "dpNm": "string",
            "cat": "string",
            "uiTyp": "string"
          }
        ],
        "newsFilters": [
          {
            "dpNm": "string",
            "inc": [
              "string"
            ],
            "exc": [
              "string"
            ],
            "lgrq": true,
            "uiTyp": "string"
          }
        ]
   } 
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Live News

Provides the user with the live news of the equity stocks

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.getLiveNews(string category, bool holdings, string searchText, int pgNum);

POST /liveNews/general

Parameters

Parameter Description
Category Categories that user can chose based on his/her discretion
Holdings This will help fetch the news only for that holdings held in the user account
Search_Text Will help filter out the news content that user is seeking
Page_Number Mention the page number and then search

Example responses

200 Response


  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": {
        "listResponse": {
          "content": [
            {
              "title": "string",
              "desc": "string",
              "guid": "string",
              "category": "string",
              "date": "string",
              "timeText": "string",
              "customElements": [
                {
                  "hghlTxt": "string",
                  "dpName": "string",
                  "sym": "string",
                  "trdSym": "string",
                  "chgP": "string"
                }
              ]
            }
          ],
          "totalElements": 0,
          "first": true,
          "last": true,
          "totalPages": 0,
          "size": 0,
          "number": 0
        },
        "groupResponse": {
          "content": [
            {
              "sym": "string",
              "ltp": "string",
              "ltt": "string",
              "chg": "string",
              "chgP": "string",
              "exc": "string",
              "vol": "string",
              "dpName": "string",
              "trdSym": "string",
              "asTyp": "string",
              "ltSz": "string",
              "tkSz": "string",
              "dpInsTyp": "string",
              "desc": "string",
              "dpVal": "string",
              "symbol": "string",
              "hasMoreNewsItems": true,
              "newsItems": [
                {
                  "title": "string",
                  "desc": "string",
                  "guid": "string",
                  "category": "string",
                  "date": "string",
                  "timeText": "string",
                  "customElements": {
                    "hghlTxt": "string",
                    "dpName": "string",
                    "sym": "string",
                    "trdSym": "string",
                    "chgP": "string"
                  }
                }
              ]
            }
          ],
          "totalElements": 0,
          "first": true,
          "last": true,
          "totalPages": 0,
          "size": 0,
          "number": 0
        }        
  }

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Results & News

Results that are announced for all stocks that user holds in the account

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.getResultsAndStocksNews(bool holdings, string searchText, int pgNum);

POST /liveNews/general

Parameters

Parameter Description
Holdings This will help fetch the news only for that holdings held in the user account
Search_Text Will help filter out the news content that user is seeking
Page_Number Mention the page number and then search

Example responses

200 Response


  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": {
      "listResponse": {
        "content": [
          {
            "title": "string",
            "desc": "string",
            "guid": "string",
            "category": "string",
            "date": "string",
            "timeText": "string",
            "customElements": [
              {
                "hghlTxt": "string",
                "dpName": "string",
                "sym": "string",
                "trdSym": "string",
                "chgP": "string"
              }
            ]
          }
        ],
        "totalElements": 0,
        "first": true,
        "last": true,
        "totalPages": 0,
        "size": 0,
        "number": 0
      },
      "groupResponse": {
        "content": [
          {
            "sym": "string",
            "ltp": "string",
            "ltt": "string",
            "chg": "string",
            "chgP": "string",
            "exc": "string",
            "vol": "string",
            "dpName": "string",
            "trdSym": "string",
            "asTyp": "string",
            "ltSz": "string",
            "tkSz": "string",
            "dpInsTyp": "string",
            "desc": "string",
            "dpVal": "string",
            "symbol": "string",
            "hasMoreNewsItems": true,
            "newsItems": [
              {
                "title": "string",
                "desc": "string",
                "guid": "string",
                "category": "string",
                "date": "string",
                "timeText": "string",
                "customElements": {
                  "hghlTxt": "string",
                  "dpName": "string",
                  "sym": "string",
                  "trdSym": "string",
                  "chgP": "string"
                }
              }
            ]
          }
        ],
        "totalElements": 0,
        "first": true,
        "last": true,
        "totalPages": 0,
        "size": 0,
        "number": 0
      }    
  }

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Latest Corporate Actions

This will help user see if there are any corporate actions only for stocks that user hold in the account

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect. getLatestCorporateActions(string symbol);

GET /events/latestcorpactions/{sym}

Parameters

Parameter Description
Symbol Each Symbol is unique and represents the stock identity. This is the exchange token to be obtained from the contract file downloaded

Example responses

200 Response


{"resp":
  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": {
      "resLst": [
    {
      "date": "string",
      "event": "string",
      "val": "string"
    }
  ],
  "dpName": "string"
  } 
 }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Watchlist

Api's related to Watchlist

Get Watchlist Groups

These are groups that user creates his/her favourite stocks and monitors the performance of stock

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.GetWatchlistGroup();

GET /accounts/groups

Example responses

200 Response


{"resp":
  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": {
      "defGr": [
    {
      "grID": "string",
      "grName": "string",
      "grValue": "string",
      "edit": "string",
      "updatedOn": 0
    }
  ],
  "usrGr": [
    {
      "grID": "string",
      "grName": "string",
      "grValue": "string",
      "edit": "string",
      "updatedOn": 0
    }
  ],
  "idxGr": [
    {
      "grID": "string",
      "grName": "string",
      "grValue": "string",
      "edit": "string",
      "updatedOn": 0
    }
  ],
  "usrTbs": [
    {
      "tab": "string",
      "tabtype": "string"
    }
  ]
  }  
 }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Get Watchlist Scrips

Scrips/stocks that user created under the watchlist

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.getWatchlistScrips(string grpNm);

GET /accounts/groups/symbols

Parameters

Parameter Description
Group_Name Watchlist group

Example responses

200 Response


{"resp":
  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": {
      "syLst": [
      {
        "trdSym": "string",
        "sym": "string",
        "asTyp": "string",
        "yrLw": "string",
        "yrLwDt": "string",
        "yrH": "string",
        "yrHDt": "string",
        "o": "string",
        "h": "string",
        "l": "string",
        "c": "string",
        "ltp": "string",
        "ltt": "string",
        "altt": "string",
        "lut": "string",
        "atp": "string",
        "bidPr": "string",
        "askPr": "string",
        "vol": "string",
        "loCt": "string",
        "hiCt": "string",
        "chg": "string",
        "chgP": "string",
        "ltSz": "string",
        "tkSz": "string",
        "dpNm": "string",
        "stkPrc": "string",
        "opTyp": "string",
        "exp": "string",
        "desc": "string",
        "exc": "string",
        "brdLotQty": "string",
        "qtyUnits": "string",
        "prcUnits": "string",
        "prcQtn": "string",
        "dpInsTyp": "string",
        "bdSz": "string",
        "akSz": "string",
        "dpExpDt": "string",
        "expFlg": true,
        "opInt": "string",
        "opIntChg": "string",
        "opIntChgP": "string",
        "spotSym": "string",
        "spot": "string",
        "spotChg": "string",
        "spotChgP": "string",
        "rlOvrP": "string",
        "rlCAbs": "string",
        "ltTQty": "string",
        "tdrStDt": "string",
        "tdrEndDt": "string",
        "srpStDt": "string",
        "mxLtSz": "string",
        "trdInfoId": [
          "string"
        ],
        "ntByQty": "string",
        "ntSlQty": "string",
        "onewkhi": "string",
        "onewklo": "string",
        "onemnhi": "string",
        "onemnlo": "string",
        "thrmnhi": "string",
        "thrmnlo": "string",
        "alltmhi": "string",
        "alltmhidt": "string",
        "alltmlo": "string",
        "alltmlodt": "string",
        "askivfut": "string",
        "askivspt": "string",
        "bidivfut": "string",
        "bidivspt": "string",
        "ltpivfut": "string",
        "ltpivspt": "string",
        "ntTrdVal": "string",
        "mns": "string",
        "isMTFEnabled": true,
        "rchFlg": "string",
        "nwsFlg": "string",
        "rlOvrCst": "string",
        "rlOvrCstPrc": "string",
        "rlOvrPrc": "string",
        "bta": "string",
        "pe": "string",
        "mktCap": "string",
        "delta": "string",
        "gamma": "string",
        "theta": "string",
        "vega": "string",
        "idxFutTrdSym": "string",
        "dpVal": "string",
        "pcr": "string",
        "pdVal": "string",
        "bas": "string",
        "isin": "string",
        "asSym": "string",
        "asExc": "string"
      }
    ]  
  }  
 }
}

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Create Watchlist Group

This will help you create watchlist groups and can have stocks under the group

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.createWatchlistGroup(string grpNm, List symbolList);

POST /accounts/groups/{groupName}

Parameters

Parameter Description
Group_Name Watchlist group
Symbols Each Symbol is unique and represents the stock identity. This is the exchange token to be obtained from the contract file downloaded

Example responses

200 Response


  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": {
      "sts": "string",
      "msg": "string",
      "rearrangeTab": true,
      "updatedOn": 0    
  }

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Delete Watchlist Groups

This will help delete the active watchlist groups

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.deleteWatchlistGroups(string delGrp);

DELETE /accounts/groups

Parameters

Parameter Description
Group_Names Watchlist groups that are already created earlier

Example responses

200 Response


  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": {
      "sts": "string",
      "msg": "string",
      "rearrangeTab": true,
      "updatedOn": 0    
  }

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Renname Watchlist Group

This will help rename the already created watchlist groups

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.renameWatchlistGroup(string grpNm, string newGrpNm);

PUT /accounts/groups/{groupName}

Parameters

Parameter Description
Group_Name Watchlist group that was already created earlier
New_Group_Name New Watchlist name

Example responses

200 Response


  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": {
      "sts": "string",
      "msg": "string",
      "rearrangeTab": true,
      "updatedOn": 0    
  }

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Add Symboles to watchlist group

Each Symbol is unique and represents the stock identity. This is the exchange token to be obtained from the contract file downloaded and add it to the watchlist groups

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.addSymbolsWatchlist(string grpNm, List symbolList);

PUT /accounts/groups/{groupName}

Parameters

Parameter Description
Group_Name Watchlist group that was already created earlier
Symbols Each Symbol is unique and represents the stock identity. This is the exchange token to be obtained from the contract file downloaded

Example responses

200 Response


  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": {
      "sts": "string",
      "msg": "string",
      "rearrangeTab": true,
      "updatedOn": 0    
  }

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Delete Symbols from watchlist group

Will help delete the already added symbols to the groups

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.deleteSymbolsWatchlist(string grpNm, List symbolList);

PUT /accounts/groups/{groupName}

Parameters

Parameter Description
Group_Name Watchlist group that was already created earlier
Symbols Each Symbol is unique and represents the stock identity. This is the exchange token to be obtained from the contract file downloaded

Example responses

200 Response


  {
    "msgID": "6f5da42b-668f-4e76-a129-aa85b770cacd",
    "srvTm": 1660900624895,
    "data": {
      "sts": "string",
      "msg": "string",
      "rearrangeTab": true,
      "updatedOn": 0
  }

Responses

Status Meaning Description Schema
200 OK successful operation
401 Unauthorized Session Expired
default Default unexpected error

Instruments

Several instruments exist between multiple exchanges and segments that trade. Any trading application has to have a master list of these instruments.

instruments provide a consolidated, import-ready CSV list of instruments available for trading.

Code samples


      
      
      
      
      

      
Streaming

      




Reduced Quotes Streamer








#Callback Method sample

public void SubscriberCallbackQuotes(string msg)
{
System.Console.WriteLine(msg);
}

APIConnect apiconnect = new APIConnect (apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiconnect.initQuotesStreaming().SubscribeReducedQuotesFeed(symbolList, SubscriberCallbackQuotes);








Parameters



  
    

      Parameter
      Description
    

  
  
    

      symbols
      Symbol list for subscription : Symbol_exchange (exchangetoken) to be obtained from Contract File
    

    

      callBack
      Callback method to receive the Feed in
    

  



Unsubscribe


This method will unsubscribe the symbols from the streamer. After successful invocation of this, will stop the streamer packets of these symbols.




apiconnect.initQuotesStreaming().UnsubscribeReducedQuotesFeed();        









      
Reduced Quotes Responses

      
{
   "response":{
      "data":{
         "aPr":"2527.00",
         "aSz":"1277",
         "altt":"21 Jul 2023, 12:44:55 PM",
         "avgPrc":"2560.72",
         "bPr":"2526.15",
         "bSz":"252",
         "c":"2637.95",
         "chg":"-28.95",
         "chgp":"-1.10",
         "futPrc":"0.00",
         "h":"0.00",
         "hCL":"2881.80",
         "l":"0.00",
         "lCL":"2357.90",
         "ltp":"2609.00",
         "ltq":"3",
         "ltt":"21 Jul 2023, 12:44:55 PM",
         "lut":"21 Jul 2023, 12:44:55 PM",
         "mO":"0",
         "ntTrdVal":"219959.91",
         "o":"2609.00",
         "oI":"58056750",
         "oiChg":"--",
         "oiChgp":"--",
         "refLP":"0.00",
         "spotPrc":"0.00",
         "sym":"2885_NSE",
         "tBQ":"297310",
         "tSQ":"571992",
         "ttlImbalance":"0",
         "vol":"8589768",
         "yHgh":"2856.15",
         "yLw":"2180.00",
      },
      "streaming_type":"quote"
   }
}



      

        
          

            Symbol
            Value
          

        
        
          

            o
            OPEN
          

          

            h
            HIGH
          

          

            l
            LOW
          

          

            c
            CLOSE
          

          

            hCL
            HIGH CIRCUIT LIMIT
          

          

            lCL
            LOW CIRCUIT LIMIT
          

          

            ltp
            LAST TRADED PRICE
          

          

            vol
            TOTAL VOLUME
          

          

            yHgh
            YEAR HIGH
          

          

            yLw
            YEAR LOW
          

          

            avgPrc
            AVERAGE PRICE
          

          

            chg
            CHANGE
          

          

            chgp
            CHANGE %
          

          

            oiChg
            OI CHANGE
          

          

            oiChgp
            OI CHANGE %
          

          

            mO
            MARKET STATUS (IF OPEN(1) OR CLOSE(2))
          

          

            tBQ
            TOTAL BUY QTY
          

          

            tSQ
            TOTAL SELL QTY
          

          

            ltq
            LAST TRADED QUANTITY
          

          

            oI
            OPEN INTEREST
          

          

            spotPrc
            SPOT PRICE
          

          

            futPrc
            FUTURE PRICE
          

          

            ltt
            LAST TRADED TIME
          

          

            lut
            LAST UPDATED TIME
          

          

            aPr
            ASK PRICE
          

          

            bPr
            BID PRICE
          

          

            aSz
            ASK SIZE
          

          

            bSz
            BID SIZE
          

          

            sym
            SYMBOL
          

          

            altt
            ACTUAL LAST TRADED TIME
          

          

            ntTrdVal
            NET TRADED VALUE
          

        
      




Mini Quote Streamer








#Callback Method sample

public void SubscriberCallbackMiniQuotes(string msg)
{
System.Console.WriteLine(msg);
}

APIConnect apiconnect = new APIConnect (apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiconnect.initMiniQuoteStreaming().subscribeMiniQuoteFeed(symbolList, SubscriberCallbackMiniQuotes);








Parameters



  
    

      Parameter
      Description
    

  
  
    

      symbols
      Symbol list for subscription : Symbol_exchange (exchangetoken) to be obtained from Contract File
    

    

      callBack
      Callback method to receive the Feed in
    

  



Unsubscribe


This method will unsubscribe the symbols from the streamer. After successful invocation of this, will stop the streamer packets of these symbols.




apiconnect.initMiniQuoteStreaming().unsubscribeMiniQuoteFeed();        









      
Mini Quotes Responses

      
{
   "response":{
      "data":{
        
         "c":"2637.95",
         "chg":"-28.95",
         "chgp":"-1.10",
         "h":"0.00",
         "l":"0.00",
         "ltp":"2609.00",
         "lut":"21 Jul 2023, 12:44:55 PM",
         "o":"2609.00",
         "oI":"58056750",
         "oiChg":"--",
         "oiChgp":"--",
         "refLP":"0.00",
         "sym":"2885_NSE",
         "ttlImbalance":"0",
         "vol":"8589768",
      },
      "streaming_type":"miniquote"
   }
}



      

        
          

            Symbol
            Value
          

        
        
          

            o
            OPEN
          

          

            h
            HIGH
          

          

            l
            LOW
          

          

            c
            CLOSE
          

          

            ltp
            LAST TRADED PRICE
          

          

            vol
            TOTAL VOLUME
          

          

            chg
            CHANGE
          

          

            chgp
            CHANGE %
          

          

            oiChg
            OI CHANGE
          

          

            oiChgp
            OI CHANGE %
          

          

            oI
            OPEN INTEREST
          

          

            lut
            LAST UPDATED TIME
          

          

            sym
            SYMBOL
          

        
      




Market Depth Streamer








#Callback Method sample

public void SubscriberCallbackDepth(string msg)
{
System.Console.WriteLine(msg);
}

APIConnect apiconnect = new APIConnect (apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiconnect.initDepthStreaming().subscribeDepthFeed(symbolList, SubscriberCallbackDepth);








Parameters



  
    

      Parameter
      Description
    

  
  
    

      symbols
      Symbol list for subscription : Symbol_exchange (exchangetoken) to be obtained from Contract File
    

    

      callBack
      Callback method to receive the Feed in
    

  



Unsubscribe


This method will unsubscribe the symbols from the streamer. After successful invocation of this, will stop the streamer packets of these symbols.




apiconnect.initDepthStreaming().UnsubscribeDepthFeed();        









      
Depth Responses

      
{
   "response":{
      "data":{
         "askValues":[
            {
                "no":"2",
                "price":"46007.65",
                "qty":"27"
            },
            {
                "no":"20",
                "price":"46007.75",
                "qty":"27"
            },
            {
                "no":"3",
                "price":"46007.85",
                "qty":"27"
            },
            {
                "no":"5",
                "price":"46007.90",
                "qty":"27"
            },
            {
                "no":"1",
                "price":"46008.05",
                "qty":"27"
            }
         ],
         "bidValues":[
            {
                "no":"2",
                "price":"46006.80",
                "qty":"121"
            },
            {
                "no":"1",
                "price":"46006.75",
                "qty":"121"
            },
            {
                "no":"1",
                "price":"46006.70",
                "qty":"121"
            },
            {
                "no":"1",
                "price":"46006.50",
                "qty":"121"
            },
            {
                "no":"1",
                "price":"46006.20",
                "qty":"121"
            }
         ],
         "ltt":"21/07/2023 12:35:39",
         "symbol":"42692_NFO",
         "taq":"89865",
         "tbq":"67800"
      },
      "streaming_type":"quote2"
   }
}



      

        
          

            Symbol
            Value
          

        
        
          

            askValues
            SELLER DATA
          

          

            bidValues
            BUYER DATA
          

          

            no
            NUMBER OF TRADES
          

          

            price
            PRICE OF THE TRADE
          

          

            qty
            QUANTITY OF TRADES
          

          

            ltt
            LAST TRADED TIME
          

          

            symbol
            SUBSCRIBED SYMBOL
          

          

            tbq
            TOTAL BUY QUANTITY
          

          

            taq
            TOTAL SELL QUANTITY
          

        
      



      
Orders Streamer

      

    
    

#Callback Method sample

 public void SubscriberCallbackOrder(string msg)
 {
     System.Console.WriteLine(msg);
 }

APIConnect apiconnect = new APIConnect (apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiconnect.initOrdersStreaming().SubscribeOrderFeed(e.Stremer_AccId, e.Stremer_UserId, SubscriberCallbackOrder);


    
    
    
    
    
    
Parameters

    

      
        

          Parameter
          Description
        

      
      
        

          acc_id
          Customer Account ID (Trading A/C No. available in My Profile section of Nuvamawealth.com OR get it from eqAccID of Get Login Info)
        

        

          user_id
          Your User ID for Nuvamawealth.com
        

        

          callBack
          Callback method to receive the Feed in
        

      
    

    
Unsubscribe

    
This method will unsubscribe the symbols from the streamer. After successful invocation of this, will stop the streamer packets.

  
  

apiconnect.initOrdersStreaming().UnsubscribeOrderFeed();


  
  
  
  
  



Live News Streamer


Properties

      

        
          

            Parameter
            Description
          

        
        
          

            callBack
            Callback method to receive the Feed in
          

        
      

    
    

#Callback Method sample

public void SubscriberCallbackOrder(string msg)
{
    System.Console.WriteLine(msg);
}

APIConnect apiconnect = new APIConnect (apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiconnect.initLiveNewsStreaming().SubscribeLiveNewsFeed(SubscriberCallbackLiveNews);
  

    
    
    
    
    
  
Unsubscribe

  
This method will unsubscribe the symbols from the streamer. After successful invocation of this, will stop the streamer packets.




apiconnect.initLiveNewsStreaming().UnsubscribeLiveNewsFeed();









Succesful Response

{
  "response": {
    "data": {
      "category": "Default",
      "custom_elements": [
        {
          "dpName": "abc",
          "hghlTxt": "ABC",
          "sym": "13844_NSE"
        }     
      ],
        "date": "2022-01-01T00:00:00",
        "description": "xyz",
        "guid": "5b04ff38f4cd392339e7126f",
        "title": "XYZ" 
      },
      "streaming_type": "news"
  }
}








      
Schemas

      
Rtype

      

        
        
        
      

      
"PAYOUT"



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            string
            false
            none
            none
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            anonymous
            PAYOUT
          

          

            anonymous
            PAYIN
          

        
      

      
Action

      

        
        
        
      

      
"BUY"



      
Action to be performed, BUY/SELL

      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            string
            false
            none
            Action to be performed, BUY/SELL
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            anonymous
            BUY
          

          

            anonymous
            SELL
          

        
      

      
      
OrderType

      

        
        
        
      

      
"LIMIT"



      
Order Type

      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            string
            false
            none
            Order Type
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            anonymous
            LIMIT
          

          

            anonymous
            SL-M
          

          

            anonymous
            SL
          

          

            anonymous
            MARKET
          

        
      

      
PrdCode

      

        
        
        
      

      
"CNC"



      
Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO

      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            string
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            anonymous
            CNC
          

          

            anonymous
            MIS
          

          

            anonymous
            NRML
          

          

            anonymous
            MTF
          

          

            anonymous
            CO
          

          

            anonymous
            BO
          

        
      

      
Duration

      

        
        
        
      

      
"DAY"



      
Order validity, DAY/IOC/EOS(for BSE)

      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            string
            false
            none
            Order validity, DAY/IOC/EOS(for BSE)
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            anonymous
            DAY
          

          

            anonymous
            IOC
          

          

            anonymous
            EOS
          

        
      

      
ValidateUidPwdRequest

      

        
        
        
      

      
{
  "pwd": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            pwd
            string
            true
            none
            API secret (password)
          

        
      

      
GnrResDao

      

        
        
        
      

      
{
  "msg": "string",
  "success": false
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            msg
            string
            false
            none
            none
          

          

            success
            boolean
            false
            none
            none
          

        
      

      
LoginAuthDataRequestDto

      

        
        
        
      

      
{
  "reqId": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            reqId
            string
            false
            none
            Request Id (Requests id obtained manually from weblogin)
          

        
      

      
LoginAuthDataResponse

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "auth": "string",
    "lgnData": {
      "accTyp": "EQ",
      "mrgSts": "COMPLETED",
      "othAccDts": {
        "accTyp": "string",
        "isAct": false,
        "isOnline": false,
        "uid": "string"
      },
      "mrgPopUp": false,
      "mrgAccDts": {
        "uids": [
          {
            "accTyp": "string",
            "uid": "string",
            "alwd": false
          }
        ],
        "phNos": [
          "string"
        ],
        "emIds": [
          "string"
        ]
      },
      "prefAccTyp": "string",
      "excs": [
        "string"
      ],
      "dfPrds": {
        "nse": {
          "by": "string",
          "sl": "string"
        },
        "bse": {
          "by": "string",
          "sl": "string"
        },
        "nfo": {
          "by": "string",
          "sl": "string"
        },
        "bfo": {
          "by": "string",
          "sl": "string"
        },
        "cds": {
          "by": "string",
          "sl": "string"
        },
        "mcx": {
          "by": "string",
          "sl": "string"
        },
        "ncdex": {
          "by": "string",
          "sl": "string"
        }
      },
      "dfPrdsMTF": {
        "nse": {
          "by": "string",
          "sl": "string"
        },
        "bse": {
          "by": "string",
          "sl": "string"
        },
        "nfo": {
          "by": "string",
          "sl": "string"
        },
        "bfo": {
          "by": "string",
          "sl": "string"
        },
        "cds": {
          "by": "string",
          "sl": "string"
        },
        "mcx": {
          "by": "string",
          "sl": "string"
        },
        "ncdex": {
          "by": "string",
          "sl": "string"
        }
      },
      "ordTypes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "sts": "OK",
      "accs": {
        "eqBrkCode": "string",
        "coBrkCode": "string",
        "eqBrId": "string",
        "coBrId": "string",
        "llt": "string",
        "eqAccID": "string",
        "eqAccName": "string",
        "coAccID": "string",
        "coAccName": "string",
        "uid": "string",
        "eqBrk": "string",
        "coBrk": "string",
        "rstpwd": false,
        "rstusr": false,
        "eqstwt": false,
        "costwt": false,
        "bseMfstwt": false,
        "eqRmRt": "N",
        "eqEmpCat": "string",
        "coEmpCat": "string",
        "eqAlgoClnt": "string",
        "prfId": "string",
        "ucmCd": "string",
        "eqDob": "string",
        "coDob": "string",
        "wtspCnsnt": "string",
        "eml": "string",
        "mfInf": false,
        "cdslEsFlg": false
      },
      "qlist": [
        {
          "idx": "string",
          "ques": "string"
        }
      ],
      "mtf": {
        "sts": "string",
        "popFl": "string"
      },
      "comOpCnst": {
        "sts": "string",
        "popFl": "string"
      },
      "adhrEQ": {
        "rlEDt": "string",
        "rlFl": "string",
        "sts": "string",
        "popFl": "string"
      },
      "adhrCOM": {
        "rlEDt": "string",
        "rlFl": "string",
        "sts": "string",
        "popFl": "string"
      },
      "cnsntLst": [
        {
          "name": "string",
          "accType": "string",
          "mdtry": false
        }
      ],
      "prdcts": {
        "property1": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "property2": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        }
      },
      "prds": [
        {
          "exc": "string",
          "prd": [
            {
              "prdDpNm": "string",
              "prdVal": "string",
              "validity": [
                {
                  "dpNm": "string",
                  "vaVal": "string"
                }
              ]
            }
          ]
        }
      ],
      "val": [
        {
          "exc": "string",
          "validity": [
            {
              "dpNm": "string",
              "vaVal": "string"
            }
          ]
        }
      ],
      "gtdGtcValDays": "string",
      "mndtryCnsts": [
        {
          "name": "string",
          "accType": "string",
          "mdtry": false
        }
      ],
      "optCnsts": [
        {
          "name": "string",
          "accType": "string",
          "mdtry": false
        }
      ],
      "srcVendor": "string",
      "vndSrc": "string",
      "reqId": "string",
      "url": "string",
      "jsessionId": "string",
      "vndCnstPopUp": false
    },
    "time": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» auth
            string
            false
            none
            none
          

          

            »» lgnData
            
            false
            none
            none
          

          

            »» time
            string
            false
            none
            none
          

        
      

      
LogOutDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» msg
            string
            false
            none
            none
          

        
      

      
VerifyAnswersResponseDao

      

        
        
        
      

      
{
  "accTyp": "EQ",
  "mrgSts": "COMPLETED",
  "othAccDts": {
    "accTyp": "string",
    "isAct": false,
    "isOnline": false,
    "uid": "string"
  },
  "mrgPopUp": false,
  "mrgAccDts": {
    "uids": [
      {
        "accTyp": "string",
        "uid": "string",
        "alwd": false
      }
    ],
    "phNos": [
      "string"
    ],
    "emIds": [
      "string"
    ]
  },
  "prefAccTyp": "string",
  "excs": [
    "string"
  ],
  "dfPrds": {
    "nse": {
      "by": "string",
      "sl": "string"
    },
    "bse": {
      "by": "string",
      "sl": "string"
    },
    "nfo": {
      "by": "string",
      "sl": "string"
    },
    "bfo": {
      "by": "string",
      "sl": "string"
    },
    "cds": {
      "by": "string",
      "sl": "string"
    },
    "mcx": {
      "by": "string",
      "sl": "string"
    },
    "ncdex": {
      "by": "string",
      "sl": "string"
    }
  },
  "dfPrdsMTF": {
    "nse": {
      "by": "string",
      "sl": "string"
    },
    "bse": {
      "by": "string",
      "sl": "string"
    },
    "nfo": {
      "by": "string",
      "sl": "string"
    },
    "bfo": {
      "by": "string",
      "sl": "string"
    },
    "cds": {
      "by": "string",
      "sl": "string"
    },
    "mcx": {
      "by": "string",
      "sl": "string"
    },
    "ncdex": {
      "by": "string",
      "sl": "string"
    }
  },
  "ordTypes": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "sts": "OK",
  "accs": {
    "eqBrkCode": "string",
    "coBrkCode": "string",
    "eqBrId": "string",
    "coBrId": "string",
    "llt": "string",
    "eqAccID": "string",
    "eqAccName": "string",
    "coAccID": "string",
    "coAccName": "string",
    "uid": "string",
    "eqBrk": "string",
    "coBrk": "string",
    "rstpwd": false,
    "rstusr": false,
    "eqstwt": false,
    "costwt": false,
    "bseMfstwt": false,
    "eqRmRt": "N",
    "eqEmpCat": "string",
    "coEmpCat": "string",
    "eqAlgoClnt": "string",
    "prfId": "string",
    "ucmCd": "string",
    "eqDob": "string",
    "coDob": "string",
    "wtspCnsnt": "string",
    "eml": "string",
    "mfInf": false,
    "cdslEsFlg": false
  },
  "qlist": [
    {
      "idx": "string",
      "ques": "string"
    }
  ],
  "mtf": {
    "sts": "string",
    "popFl": "string"
  },
  "comOpCnst": {
    "sts": "string",
    "popFl": "string"
  },
  "adhrEQ": {
    "rlEDt": "string",
    "rlFl": "string",
    "sts": "string",
    "popFl": "string"
  },
  "adhrCOM": {
    "rlEDt": "string",
    "rlFl": "string",
    "sts": "string",
    "popFl": "string"
  },
  "cnsntLst": [
    {
      "name": "string",
      "accType": "string",
      "mdtry": false
    }
  ],
  "prdcts": {
    "property1": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "property2": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    }
  },
  "prds": [
    {
      "exc": "string",
      "prd": [
        {
          "prdDpNm": "string",
          "prdVal": "string",
          "validity": [
            {
              "dpNm": "string",
              "vaVal": "string"
            }
          ]
        }
      ]
    }
  ],
  "val": [
    {
      "exc": "string",
      "validity": [
        {
          "dpNm": "string",
          "vaVal": "string"
        }
      ]
    }
  ],
  "gtdGtcValDays": "string",
  "mndtryCnsts": [
    {
      "name": "string",
      "accType": "string",
      "mdtry": false
    }
  ],
  "optCnsts": [
    {
      "name": "string",
      "accType": "string",
      "mdtry": false
    }
  ],
  "srcVendor": "string",
  "vndSrc": "string",
  "reqId": "string",
  "url": "string",
  "jsessionId": "string",
  "vndCnstPopUp": false
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            accTyp
            string
            false
            none
            Account types for which user is logged in to
          

          

            mrgSts
            string
            false
            none
            merge status of userID
          

          

            othAccDts
            
            false
            none
            none
          

          

            mrgPopUp
            boolean
            false
            none
            none
          

          

            mrgAccDts
            
            false
            none
            none
          

          

            prefAccTyp
            string
            false
            none
            Field will be sent only when mrg status is completed/Processed. Note : This might be null when status is
              processed (when userid's are same before merging)
          

          

            excs
            [string]
            false
            none
            list of exchanges enabled for the user
          

          

            dfPrds
            
            false
            none
            none
          

          

            dfPrdsMTF
            
            false
            none
            none
          

          

            ordTypes
            []
            false
            none
            List of Order types enabled for the user
          

          

            sts
            string
            false
            none
            Is user successfully logged in then status is ok, else if status is invalid_answers then new 2fa
              questions should be displayed
          

          

            accs
            
            false
            none
            none
          

          

            qlist
            []
            false
            none
            If user enters invalid answers to 2fa questions. then new set of questions comes under this field
          

          

            mtf
            
            false
            none
            none
          

          

            comOpCnst
            
            false
            none
            none
          

          

            adhrEQ
            
            false
            none
            none
          

          

            adhrCOM
            
            false
            none
            none
          

          

            cnsntLst
            []
            false
            none
            consent priority List
          

          

            prdcts
            object
            false
            none
            none
          

          

            » additionalProperties
            object
            false
            none
            none
          

          

            »» additionalProperties
            [string]
            false
            none
            none
          

          

            prds
            []
            false
            none
            For every exchange it will give the list of validity based on product
          

          

            val
            []
            false
            none
            List of validity corresponding to exchange
          

          

            gtdGtcValDays
            string
            false
            none
            Validity days for GTC/GTD product
          

          

            mndtryCnsts
            []
            false
            none
            Mandatory consent priority List --> Won't be available if there is no mandatory consents (null check
              required)
          

          

            optCnsts
            []
            false
            none
            Optional consent priority List --> Won't be available if there is a mandatory consent and no optional
              consents (null check required)
          

          

            srcVendor
            string
            false
            none
            vendor name
          

          

            vndSrc
            string
            false
            none
            vendor source
          

          

            reqId
            string
            false
            none
            Toc Login data request id
          

          

            url
            string
            false
            none
            Redirect Url
          

          

            jsessionId
            string
            false
            none
            none
          

          

            vndCnstPopUp
            boolean
            false
            none
            none
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            accTyp
            EQ
          

          

            accTyp
            CO
          

          

            accTyp
            COMEQ
          

          

            mrgSts
            COMPLETED
          

          

            mrgSts
            REQUESTED
          

          

            mrgSts
            ONE_ACCOUNT
          

          

            mrgSts
            PROCESSED
          

          

            mrgSts
            NOT_REQUESTED
          

          

            mrgSts
            NOT_ENABLED
          

          

            sts
            OK
          

          

            sts
            INVALID_ANSWERS
          

        
      

      
OtherAccountDetailsResponseObject

      

        
        
        
      

      
{
  "accTyp": "string",
  "isAct": false,
  "isOnline": false,
  "uid": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            accTyp
            string
            false
            none
            none
          

          

            isAct
            boolean
            false
            none
            none
          

          

            isOnline
            boolean
            false
            none
            none
          

          

            uid
            string
            false
            none
            required for activating an account
          

        
      

      
MergeAccountDetailsResponseObject

      

        
        
        
      

      
{
  "uids": [
    {
      "accTyp": "string",
      "uid": "string",
      "alwd": false
    }
  ],
  "phNos": [
    "string"
  ],
  "emIds": [
    "string"
  ]
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            uids
            []
            false
            none
            none
          

          

            phNos
            [string]
            false
            none
            none
          

          

            emIds
            [string]
            false
            none
            none
          

        
      

      
DefaultProductTypesObject

      

        
        
        
      

      
{
  "nse": {
    "by": "string",
    "sl": "string"
  },
  "bse": {
    "by": "string",
    "sl": "string"
  },
  "nfo": {
    "by": "string",
    "sl": "string"
  },
  "bfo": {
    "by": "string",
    "sl": "string"
  },
  "cds": {
    "by": "string",
    "sl": "string"
  },
  "mcx": {
    "by": "string",
    "sl": "string"
  },
  "ncdex": {
    "by": "string",
    "sl": "string"
  }
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            nse
            
            false
            none
            none
          

          

            bse
            
            false
            none
            none
          

          

            nfo
            
            false
            none
            none
          

          

            bfo
            
            false
            none
            none
          

          

            cds
            
            false
            none
            none
          

          

            mcx
            
            false
            none
            none
          

          

            ncdex
            
            false
            none
            none
          

        
      

      
KeyValueResponseObject

      

        
        
        
      

      
{
  "key": "string",
  "value": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            key
            string
            false
            none
            none
          

          

            value
            string
            false
            none
            none
          

        
      

      
AccountDetailsResponeObject

      

        
        
        
      

      
{
  "eqBrkCode": "string",
  "coBrkCode": "string",
  "eqBrId": "string",
  "coBrId": "string",
  "llt": "string",
  "eqAccID": "string",
  "eqAccName": "string",
  "coAccID": "string",
  "coAccName": "string",
  "uid": "string",
  "eqBrk": "string",
  "coBrk": "string",
  "rstpwd": false,
  "rstusr": false,
  "eqstwt": false,
  "costwt": false,
  "bseMfstwt": false,
  "eqRmRt": "N",
  "eqEmpCat": "string",
  "coEmpCat": "string",
  "eqAlgoClnt": "string",
  "prfId": "string",
  "ucmCd": "string",
  "eqDob": "string",
  "coDob": "string",
  "wtspCnsnt": "string",
  "eml": "string",
  "mfInf": false,
  "cdslEsFlg": false
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            eqBrkCode
            string
            false
            none
            Equity Broker Code of the user
          

          

            coBrkCode
            string
            false
            none
            Commodity Broker Code of the user
          

          

            eqBrId
            string
            false
            none
            Equity Branch Id of the user
          

          

            coBrId
            string
            false
            none
            Commodity Branch Id of the user
          

          

            llt
            string
            false
            none
            Last Successful login time
          

          

            eqAccID
            string
            false
            none
            Equity Account ID
          

          

            eqAccName
            string
            false
            none
            Equity Account name of the user.
          

          

            coAccID
            string
            false
            none
            Commodity Account ID
          

          

            coAccName
            string
            false
            none
            Equity Account name of the user.
          

          

            uid
            string
            false
            none
            User ID
          

          

            eqBrk
            string
            false
            none
            Equity Account Broker of the user
          

          

            coBrk
            string
            false
            none
            Commodity Account Broker of the user
          

          

            rstpwd
            boolean
            false
            none
            reset password flag. If true then user needs to change password.
          

          

            rstusr
            boolean
            false
            none
            Change userID flag. If true then user needs to change userid.
          

          

            eqstwt
            boolean
            false
            none
            if user accepted Equity consent then it will come as true
          

          

            costwt
            boolean
            false
            none
            if user accepted Commodity consent then it will come as true
          

          

            bseMfstwt
            boolean
            false
            none
            if user accepted BSE MF Start consent then it will come as true
          

          

            eqRmRt
            string
            false
            none
            Equity RM Rating Setting,NA - RM Rating is not enabled, Y - RM Rating is enabled and Show popup just
              after login, N - RM Rating is enabled and donot show pop up
          

          

            eqEmpCat
            string
            false
            none
            Employee Category, if eq account is for employee, otherwise NA
          

          

            coEmpCat
            string
            false
            none
            Employee Category, if co account is for employee, otherwise NA
          

          

            eqAlgoClnt
            string
            false
            none
            If the client is Algo client
          

          

            prfId
            string
            false
            none
            client's profile id
          

          

            ucmCd
            string
            false
            none
            client's ucm code
          

          

            eqDob
            string
            false
            none
            Client's DOB recorded in Equity Account
          

          

            coDob
            string
            false
            none
            Client's DOB recorded in Commodity Account
          

          

            wtspCnsnt
            string
            false
            none
            Client's WhatsApp Consent exists or not, true if exists
          

          

            eml
            string
            false
            none
            E-mail
          

          

            mfInf
            boolean
            false
            none
            MF Infinity flag
          

          

            cdslEsFlg
            boolean
            false
            none
            CDSL Easy flag
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            eqRmRt
            N
          

          

            eqRmRt
            Y
          

          

            eqRmRt
            NA
          

        
      

      
Questions_Response

      

        
        
        
      

      
{
  "idx": "string",
  "ques": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            idx
            string
            false
            none
            Index of the question
          

          

            ques
            string
            false
            none
            Question
          

        
      

      
CommonConsentStatusDao

      

        
        
        
      

      
{
  "sts": "string",
  "popFl": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            sts
            string
            false
            none
            Status of client's consent
          

          

            popFl
            string
            false
            none
            Flag to determine if client's consent is needed
          

        
      

      
AadharStatusDao

      

        
        
        
      

      
{
  "rlEDt": "string",
  "rlFl": "string",
  "sts": "string",
  "popFl": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            rlEDt
            string
            false
            none
            Last date of aadhar validation
          

          

            rlFl
            string
            false
            none
            To enable remind me later button on popup
          

          

            sts
            string
            false
            none
            Status of client's Aadhar validation
          

          

            popFl
            string
            false
            none
            Flag to determine if client's Aadhar validation is needed
          

        
      

      
ConsentStatusDao

      

        
        
        
      

      
{
  "name": "string",
  "accType": "string",
  "mdtry": false
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            name
            string
            false
            none
            none
          

          

            accType
            string
            false
            none
            none
          

          

            mdtry
            boolean
            false
            none
            none
          

        
      

      
ValidityProductsResponseObject

      

        
        
        
      

      
{
  "exc": "string",
  "prd": [
    {
      "prdDpNm": "string",
      "prdVal": "string",
      "validity": [
        {
          "dpNm": "string",
          "vaVal": "string"
        }
      ]
    }
  ]
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            exc
            string
            false
            none
            Exchange
          

          

            prd
            []
            false
            none
            List of validity based on product
          

        
      

      
ValidityExchangeObject

      

        
        
        
      

      
{
  "exc": "string",
  "validity": [
    {
      "dpNm": "string",
      "vaVal": "string"
    }
  ]
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            exc
            string
            false
            none
            none
          

          

            validity
            []
            false
            none
            List of validity
          

        
      

      
SegmentType

      

        
        
        
      

      
{
  "accTyp": "string",
  "uid": "string",
  "alwd": false
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            accTyp
            string
            false
            none
            none
          

          

            uid
            string
            false
            none
            none
          

          

            alwd
            boolean
            false
            none
            True -> Allowed to choose as Merge UserID.
          

        
      

      
BuySellObject

      

        
        
        
      

      
{
  "by": "string",
  "sl": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            by
            string
            false
            none
            none
          

          

            sl
            string
            false
            none
            none
          

        
      

      
ProductValueResponseObject

      

        
        
        
      

      
{
  "prdDpNm": "string",
  "prdVal": "string",
  "validity": [
    {
      "dpNm": "string",
      "vaVal": "string"
    }
  ]
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            prdDpNm
            string
            false
            none
            Product Display Name
          

          

            prdVal
            string
            false
            none
            Product Value
          

          

            validity
            []
            false
            none
            List will contain validity
          

        
      

      
ValidityObject

      

        
        
        
      

      
{
  "dpNm": "string",
  "vaVal": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            dpNm
            string
            false
            none
            Validity display name
          

          

            vaVal
            string
            false
            none
            Validity value
          

        
      

      
EQBracketExitRequestDao

      

        
        
        
      

      
{
  "nstOrdNo": "string",
  "syomID": "string",
  "sts": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            nstOrdNo
            string
            false
            none
            NestOrderNumber
          

          

            syomID
            string
            false
            none
            SyOmOrderId for leg orders
          

          

            sts
            string
            false
            none
            Status of the Bracket Order
          

        
      

      
CancelTradeDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "oid": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» msg
            string
            false
            none
            none
          

          

            »» oid
            string
            false
            none
            none
          

        
      

      
CancelTradeCoverDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» msg
            string
            false
            none
            none
          

        
      

  
    
      
EqOrderDetailsDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "ord": [
      {
        "exc": "string",
        "ordID": "string",
        "nstReqID": "string",
        "trsTyp": "string",
        "symName": "string",
        "scName": "string",
        "prcTF": "string",
        "avgPrc": "string",
        "trgPrc": "string",
        "qtyTF": "string",
        "unFlSz": "string",
        "dsQty": "string",
        "exOID": "string",
        "sts": "string",
        "tim": "string",
        "txt": "string",
        "prcTyp": "string",
        "dur": "string",
        "prdCode": "CNC"
      }
    ]
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» ord
            []
            false
            none
            none
          

        
      

      
OrderDetailsResponseObject

      

        
        
        
      

      
{
  "exc": "string",
  "ordID": "string",
  "nstReqID": "string",
  "trsTyp": "string",
  "symName": "string",
  "scName": "string",
  "prcTF": "string",
  "avgPrc": "string",
  "trgPrc": "string",
  "qtyTF": "string",
  "unFlSz": "string",
  "dsQty": "string",
  "exOID": "string",
  "sts": "string",
  "tim": "string",
  "txt": "string",
  "prcTyp": "string",
  "dur": "string",
  "prdCode": "CNC"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            exc
            string
            false
            none
            Name of the exchange, BSE/NSE/MCX/NCDEX
          

          

            ordID
            string
            false
            none
            Order Id
          

          

            nstReqID
            string
            false
            none
            none
          

          

            trsTyp
            string
            false
            none
            none
          

          

            symName
            string
            false
            none
            none
          

          

            scName
            string
            false
            none
            none
          

          

            prcTF
            string
            false
            none
            none
          

          

            avgPrc
            string
            false
            none
            none
          

          

            trgPrc
            string
            false
            none
            none
          

          

            qtyTF
            string
            false
            none
            none
          

          

            unFlSz
            string
            false
            none
            none
          

          

            dsQty
            string
            false
            none
            none
          

          

            exOID
            string
            false
            none
            none
          

          

            sts
            string
            false
            none
            none
          

          

            tim
            string
            false
            none
            none
          

          

            txt
            string
            false
            none
            none
          

          

            prcTyp
            string
            false
            none
            none
          

          

            dur
            string
            false
            none
            none
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

        
      

      
EqOrderHistoryDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "hstOrdBk": [
      {
        "exc": "string",
        "ordID": "string",
        "nstReqID": "string",
        "trsTyp": "string",
        "symName": "string",
        "prcTF": "string",
        "avgPrc": "string",
        "trgPrc": "string",
        "qtyTF": "string",
        "unFlSz": "string",
        "dsQty": "string",
        "exOID": "string",
        "sts": "string",
        "rjRsn": "string",
        "ordTyp": "string",
        "dur": "string",
        "prdCode": "CNC",
        "rpTyp": "string",
        "trdSym": "string",
        "cstFirm": "string",
        "flQty": "string",
        "exTimStm": "string",
        "ordSrc": "string",
        "flDtTim": "string",
        "ordGenTyp": "string",
        "ordEntTyp": "string",
        "cta": "string"
      }
    ]
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» hstOrdBk
            []
            false
            none
            none
          

        
      

      
EqOrderHistoryResponseObject

      

        
        
        
      

      
{
  "exc": "string",
  "ordID": "string",
  "nstReqID": "string",
  "trsTyp": "string",
  "symName": "string",
  "prcTF": "string",
  "avgPrc": "string",
  "trgPrc": "string",
  "qtyTF": "string",
  "unFlSz": "string",
  "dsQty": "string",
  "exOID": "string",
  "sts": "string",
  "rjRsn": "string",
  "ordTyp": "string",
  "dur": "string",
  "prdCode": "CNC",
  "rpTyp": "string",
  "trdSym": "string",
  "cstFirm": "string",
  "flQty": "string",
  "exTimStm": "string",
  "ordSrc": "string",
  "flDtTim": "string",
  "ordGenTyp": "string",
  "ordEntTyp": "string",
  "cta": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            exc
            string
            false
            none
            none
          

          

            ordID
            string
            false
            none
            none
          

          

            nstReqID
            string
            false
            none
            none
          

          

            trsTyp
            string
            false
            none
            none
          

          

            symName
            string
            false
            none
            none
          

          

            prcTF
            string
            false
            none
            none
          

          

            avgPrc
            string
            false
            none
            none
          

          

            trgPrc
            string
            false
            none
            none
          

          

            qtyTF
            string
            false
            none
            none
          

          

            unFlSz
            string
            false
            none
            none
          

          

            dsQty
            string
            false
            none
            none
          

          

            exOID
            string
            false
            none
            none
          

          

            sts
            string
            false
            none
            none
          

          

            rjRsn
            string
            false
            none
            none
          

          

            ordTyp
            string
            false
            none
            none
          

          

            dur
            string
            false
            none
            none
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            rpTyp
            string
            false
            none
            none
          

          

            trdSym
            string
            false
            none
            none
          

          

            cstFirm
            string
            false
            none
            none
          

          

            flQty
            string
            false
            none
            none
          

          

            exTimStm
            string
            false
            none
            none
          

          

            ordSrc
            string
            false
            none
            none
          

          

            flDtTim
            string
            false
            none
            none
          

          

            ordGenTyp
            string
            false
            none
            none
          

          

            ordEntTyp
            string
            false
            none
            none
          

          

            cta
            string
            false
            none
            none
          

        
      

      
EQModifyTradeRequestDao

      

        
        
        
      

      
{
  "trdSym": "string",
  "exc": "string",
  "action": "BUY",
  "dur": "DAY",
  "flQty": "string",
  "ordTyp": "LIMIT",
  "qty": "string",
  "dscQty": "string",
  "mktPro": "string",
  "lmPrc": "string",
  "trgPrc": "string",
  "prdCode": "CNC",
  "dtDays": "string",
  "nstOID": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            trdSym
            string
            false
            none
            Trading Symbol of the Scrip, to be obtained from Contract file downloaded
          

          

            exc
            string
            false
            none
            Name of the exchange, BSE/NSE
          

          

            action
            
            false
            none
            Action to be performed, BUY/SELL
          

          

            dur
            
            false
            none
            Order validity, DAY/IOC/EOS(for BSE)
          

          

            flQty
            string
            false
            none
            Filled Quantity or filled shares. It is mandatory for order modification
          

          

            ordTyp
            
            false
            none
            Order Type
          

          

            qty
            string
            false
            none
            Quantity of the scrip to transact in multiple of Lot size/Board lot qty
          

          

            dscQty
            string
            false
            none
            Disclosed Quantity.
          

          

            mktPro
            string
            false
            none
            Market Protection
          

          

            lmPrc
            string
            false
            none
            Limit price of scrip in multiple of tick size
          

          

            trgPrc
            string
            false
            none
            Trigger Price applicable for SL/SL-M Orders (default 0)
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            dtDays
            string
            false
            none
            date in dd/MM/yyyy format
          

          

            nstOID
            string
            false
            none
            Nest Order ID .Order number received from Orderbook response. It is mandatory for modifying/cancelling
              an order
          

        
      

      
ModifyTradeDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "oid": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» msg
            string
            false
            none
            none
          

          

            »» oid
            string
            false
            none
            none
          

        
      

      
EQCancelTradeReq

      

        
        
        
      

      
{
  "nstOID": "string",
  "exc": "string",
  "ordTyp": "LIMIT",
  "prdCode": "CNC"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            nstOID
            string
            true
            none
            Nest Order ID .Order number received from Order book response.
          

          

            exc
            string
            false
            none
            Name of the exchange, BSE/NSE
          

          

            ordTyp
            
            true
            none
            Order Type
          

          

            prdCode
            
            true
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

        
      

      
HoldingsRMSDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "eqHv": "string",
    "rmsHdg": [
      {
        "asTyp": "string",
        "cpName": "string",
        "dpName": "string",
        "exc": "string",
        "isin": "string",
        "ltSz": "string",
        "ltp": "string",
        "tkSz": "string",
        "trdSym": "string",
        "totalQty": "string",
        "totalVal": "string",
        "sym": "string",
        "cncRmsHdg": {
          "td": "string",
          "hdgVl": "string",
          "clUQty": "string",
          "hdgUQty": "string",
          "usdQty": "string",
          "t1HQty": "string",
          "clQty": "string",
          "qty": "string",
          "pdQty": "string",
          "pdCnt": "string",
          "sym": "string",
          "totQty": "string"
        },
        "mtfRmsHdg": {
          "td": "string",
          "hdgVl": "string",
          "clUQty": "string",
          "hdgUQty": "string",
          "usdQty": "string",
          "t1HQty": "string",
          "clQty": "string",
          "qty": "string",
          "pdQty": "string",
          "pdCnt": "string",
          "sym": "string",
          "totQty": "string"
        }
      }
    ]
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» eqHv
            string
            false
            none
            none
          

          

            »» rmsHdg
            []
            false
            none
            none
          

        
      

      
CNCMTFHoldingBlock

      

        
        
        
      

      
{
  "asTyp": "string",
  "cpName": "string",
  "dpName": "string",
  "exc": "string",
  "isin": "string",
  "ltSz": "string",
  "ltp": "string",
  "tkSz": "string",
  "trdSym": "string",
  "totalQty": "string",
  "totalVal": "string",
  "sym": "string",
  "cncRmsHdg": {
    "td": "string",
    "hdgVl": "string",
    "clUQty": "string",
    "hdgUQty": "string",
    "usdQty": "string",
    "t1HQty": "string",
    "clQty": "string",
    "qty": "string",
    "pdQty": "string",
    "pdCnt": "string",
    "sym": "string",
    "totQty": "string"
  },
  "mtfRmsHdg": {
    "td": "string",
    "hdgVl": "string",
    "clUQty": "string",
    "hdgUQty": "string",
    "usdQty": "string",
    "t1HQty": "string",
    "clQty": "string",
    "qty": "string",
    "pdQty": "string",
    "pdCnt": "string",
    "sym": "string",
    "totQty": "string"
  }
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            asTyp
            string
            false
            none
            none
          

          

            cpName
            string
            false
            none
            none
          

          

            dpName
            string
            false
            none
            none
          

          

            exc
            string
            false
            none
            none
          

          

            isin
            string
            false
            none
            none
          

          

            ltSz
            string
            false
            none
            none
          

          

            ltp
            string
            false
            none
            none
          

          

            tkSz
            string
            false
            none
            none
          

          

            trdSym
            string
            false
            none
            none
          

          

            totalQty
            string
            false
            none
            none
          

          

            totalVal
            string
            false
            none
            none
          

          

            sym
            string
            false
            none
            none
          

          

            cncRmsHdg
            
            false
            none
            none
          

          

            mtfRmsHdg
            
            false
            none
            none
          

        
      

      
HoldingRMSObject

      

        
        
        
      

      
{
  "td": "string",
  "hdgVl": "string",
  "clUQty": "string",
  "hdgUQty": "string",
  "usdQty": "string",
  "t1HQty": "string",
  "clQty": "string",
  "qty": "string",
  "pdQty": "string",
  "pdCnt": "string",
  "sym": "string",
  "totQty": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            td
            string
            false
            none
            none
          

          

            hdgVl
            string
            false
            none
            none
          

          

            clUQty
            string
            false
            none
            none
          

          

            hdgUQty
            string
            false
            none
            none
          

          

            usdQty
            string
            false
            none
            none
          

          

            t1HQty
            string
            false
            none
            none
          

          

            clQty
            string
            false
            none
            none
          

          

            qty
            string
            false
            none
            none
          

          

            pdQty
            string
            false
            none
            none
          

          

            pdCnt
            string
            false
            none
            none
          

          

            sym
            string
            false
            none
            none
          

          

            totQty
            string
            false
            none
            none
          

        
      

      
EQLimitsDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "cshAvl": "string",
    "mtmMg": "string",
    "nvl": "string",
    "nvlPer": "string",
    "exp": "string",
    "srtFall": {
      "srtFall": "string",
      "spnSrtFall": "string"
    },
    "mrgAvl": {
      "mrgAvl": "string",
      "dayOpenBal": "string",
      "stkColVal": "string",
      "mfOthColVal": "string",
      "fndAdd": "string",
      "adMrg": "string",
      "notMrg": "string"
    },
    "mrgUtd": {
      "mrgUtd": "string",
      "blkRelDlvry": "string",
      "lvPrdMrg": "string",
      "fnoSpnMrg": "string",
      "fnoExpMrg": "string",
      "spnExpMrg": "string",
      "prmPdRcd": "string",
      "rlPnl": "string",
      "unRlMtm": "string",
      "mf": "string",
      "ipoAmt": "string",
      "fndWthdrwn": "string",
      "ttpv": "string"
    },
    "unPstdChrgs": {
      "ntChrg": "string",
      "ntUnPstdChrg": {
        "subaccode": "string",
        "recorddate": "2019-08-24T14:15:22Z",
        "dpdues": "string",
        "dpcharges": "string",
        "ist": "string",
        "comoshortfall": "string",
        "fnopenality": "string",
        "pisbankbal": "string",
        "wealthpoabal": "string",
        "mtfbal": "string",
        "oth4amt": "string",
        "oth5amt": "string",
        "accode": "string"
      }
    }
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» cshAvl
            string
            false
            none
            Cash available
          

          

            »» mtmMg
            string
            false
            none
            MtoM Margin
          

          

            »» nvl
            string
            false
            none
            nvl value
          

          

            »» nvlPer
            string
            false
            none
            nvl Percentage
          

          

            »» exp
            string
            false
            none
            Exposure
          

          

            »» srtFall
            
            false
            none
            Short fall
          

          

            »» mrgAvl
            
            false
            none
            Margin Available
          

          

            »» mrgUtd
            
            false
            none
            Margin Utilized
          

          

            »» unPstdChrgs
            
            false
            none
            Unposted Charges
          

        
      

      
ShortFallDao

      

        
        
        
      

      
{
  "srtFall": "string",
  "spnSrtFall": "string"
}



      
Short fall

      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            srtFall
            string
            false
            none
            Short Fall
          

          

            spnSrtFall
            string
            false
            none
            Span Short Fall
          

        
      

      
MarginAvailableDao

      

        
        
        
      

      
{
  "mrgAvl": "string",
  "dayOpenBal": "string",
  "stkColVal": "string",
  "mfOthColVal": "string",
  "fndAdd": "string",
  "adMrg": "string",
  "notMrg": "string"
}



      
Margin Available

      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            mrgAvl
            string
            false
            none
            Margin Available
          

          

            dayOpenBal
            string
            false
            none
            Day Opening Balance (Cash)
          

          

            stkColVal
            string
            false
            none
            Stocks Collateral Value
          

          

            mfOthColVal
            string
            false
            none
            MF with Other Collateral Value
          

          

            fndAdd
            string
            false
            none
            Funds Added
          

          

            adMrg
            string
            false
            none
            Adhoc Margin
          

          

            notMrg
            string
            false
            none
            Notional Margin
          

        
      

      
MarginUtilized

      

        
        
        
      

      
{
  "mrgUtd": "string",
  "blkRelDlvry": "string",
  "lvPrdMrg": "string",
  "fnoSpnMrg": "string",
  "fnoExpMrg": "string",
  "spnExpMrg": "string",
  "prmPdRcd": "string",
  "rlPnl": "string",
  "unRlMtm": "string",
  "mf": "string",
  "ipoAmt": "string",
  "fndWthdrwn": "string",
  "ttpv": "string"
}



      
Margin Utilized

      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            mrgUtd
            string
            false
            none
            Margin Utilized
          

          

            blkRelDlvry
            string
            false
            none
            Blocked (+) / Released (-) For Delivery
          

          

            lvPrdMrg
            string
            false
            none
            Leveraged Product Margin (Cash Segment)
          

          

            fnoSpnMrg
            string
            false
            none
            Span Margin
          

          

            fnoExpMrg
            string
            false
            none
            Exposure Margin
          

          

            spnExpMrg
            string
            false
            none
            Spand and Exposure Margin
          

          

            prmPdRcd
            string
            false
            none
            Premium Paid (+) / Received (-)
          

          

            rlPnl
            string
            false
            none
            Realized PnL Value
          

          

            unRlMtm
            string
            false
            none
            Unrealized Mark to Market
          

          

            mf
            string
            false
            none
            Mutual Funds
          

          

            ipoAmt
            string
            false
            none
            IPO / Bonds / NCDs / ETC..
          

          

            fndWthdrwn
            string
            false
            none
            Funds Withdrawn
          

          

            ttpv
            string
            false
            none
            Total Third party value
          

        
      

      
UnpostedObject

      

        
        
        
      

      
{
  "ntChrg": "string",
  "ntUnPstdChrg": {
    "subaccode": "string",
    "recorddate": "2019-08-24T14:15:22Z",
    "dpdues": "string",
    "dpcharges": "string",
    "ist": "string",
    "comoshortfall": "string",
    "fnopenality": "string",
    "pisbankbal": "string",
    "wealthpoabal": "string",
    "mtfbal": "string",
    "oth4amt": "string",
    "oth5amt": "string",
    "accode": "string"
  }
}



      
Unposted Charges

      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            ntChrg
            string
            false
            none
            none
          

          

            ntUnPstdChrg
            
            false
            none
            none
          

        
      

      
UnpostedCollectionDao

      

        
        
        
      

      
{
  "subaccode": "string",
  "recorddate": "2019-08-24T14:15:22Z",
  "dpdues": "string",
  "dpcharges": "string",
  "ist": "string",
  "comoshortfall": "string",
  "fnopenality": "string",
  "pisbankbal": "string",
  "wealthpoabal": "string",
  "mtfbal": "string",
  "oth4amt": "string",
  "oth5amt": "string",
  "accode": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            subaccode
            string
            false
            none
            none
          

          

            recorddate
            string(date-time)
            false
            none
            none
          

          

            dpdues
            string
            false
            none
            none
          

          

            dpcharges
            string
            false
            none
            none
          

          

            ist
            string
            false
            none
            none
          

          

            comoshortfall
            string
            false
            none
            none
          

          

            fnopenality
            string
            false
            none
            none
          

          

            pisbankbal
            string
            false
            none
            none
          

          

            wealthpoabal
            string
            false
            none
            none
          

          

            mtfbal
            string
            false
            none
            none
          

          

            oth4amt
            string
            false
            none
            none
          

          

            oth5amt
            string
            false
            none
            none
          

          

            accode
            string
            false
            none
            none
          

        
      

      
PositionSquareOffRequestDto

      

        
        
        
      

      
{
  "trdSym": "string",
  "exc": "string",
  "action": "BUY",
  "dur": "DAY",
  "flQty": "string",
  "ordTyp": "LIMIT",
  "qty": "string",
  "dscQty": "string",
  "sym": "string",
  "mktPro": "string",
  "lmPrc": "string",
  "trgPrc": "string",
  "prdCode": "CNC",
  "dtDays": "string",
  "posSqr": "string",
  "minQty": "string",
  "ordSrc": "MOB",
  "vnCode": "string",
  "rmk": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            trdSym
            string
            false
            none
            Trading Symbol
          

          

            exc
            string
            false
            none
            Exchange
          

          

            action
            
            false
            none
            Action to be performed, BUY/SELL
          

          

            dur
            
            false
            none
            Order validity, DAY/IOC/EOS(for BSE)
          

          

            flQty
            string
            false
            none
            Filled Quantity or filled shares. It is mandatory for order modification
            
          

          

            ordTyp
            
            false
            none
            Order Type
          

          

            qty
            string
            false
            none
            Quantity.
          

          

            dscQty
            string
            false
            none
            Disclosed Quantity.
          

          

            sym
            string
            false
            none
            Symbol of the contract that is being traded.SYMBOL_EXCHANGE From MW
          

          

            mktPro
            string
            false
            none
            Market Protection
          

          

            lmPrc
            string
            false
            none
            Limit Price.
          

          

            trgPrc
            string
            false
            none
            Trigger Price.
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            dtDays
            string
            false
            none
            Date Days
          

          

            posSqr
            string
            false
            none
            Position Square Flag
          

          

            minQty
            string
            false
            none
            Minimum Quantity
          

          

            ordSrc
            string
            false
            none
            Location Indicator
          

          

            vnCode
            string
            false
            none
            Vendor Code
          

          

            rmk
            string
            false
            none
            Remarks
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            ordSrc
            MOB
          

          

            ordSrc
            WEB
          

          

            ordSrc
            XMLAPI
          

          

            ordSrc
            TOC
          

        
      

      
PositionSquareOffResponseDto

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "posSqrOffs": [
      {
        "errMsg": "string",
        "errCd": "string",
        "actCd": "string",
        "msg": "string",
        "oid": "string"
      }
    ]
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» posSqrOffs
            []
            false
            none
            none
          

        
      

      
PositionSquareOffResponseObject

      

        
        
        
      

      
{
  "errMsg": "string",
  "errCd": "string",
  "actCd": "string",
  "msg": "string",
  "oid": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            errMsg
            string
            false
            none
            none
          

          

            errCd
            string
            false
            none
            none
          

          

            actCd
            string
            false
            none
            none
          

          

            msg
            string
            false
            none
            none
          

          

            oid
            string
            false
            none
            none
          

        
      

      
ErrorResponseDao

      

        
        
        
      

      
{
  "errMsg": "string",
  "errCd": "string",
  "actCd": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            errMsg
            string
            false
            none
            none
          

          

            errCd
            string
            false
            none
            none
          

          

            actCd
            string
            false
            none
            none
          

        
      

      
OrderBookResponse

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "ord": [
      {
        "lstPos": 0,
        "stkPrc": "string",
        "isCOSecLeg": "string",
        "dur": "string",
        "vlDt": "string",
        "rcvTim": "string",
        "rcvEpTim": "string",
        "sym": "string",
        "cpName": "string",
        "exit": "string",
        "syomID": "string",
        "exc": "string",
        "ntQty": "string",
        "dpName": "string",
        "cancel": "string",
        "sipID": "string",
        "nstReqID": "string",
        "ordTyp": "LIMIT",
        "qtyUnits": "string",
        "opTyp": "string",
        "trsTyp": "string",
        "srs": "string",
        "reqQty": "string",
        "prdCode": "CNC",
        "ogt": "string",
        "flQty": "string",
        "trdSym": "string",
        "edit": "string",
        "asTyp": "string",
        "trgPrc": "string",
        "avgPrc": "string",
        "dsQty": "string",
        "ordID": "string",
        "sts": "string",
        "dpInsTyp": "string",
        "rjRsn": "string",
        "userID": "string",
        "dpExpDt": "string",
        "ltSz": "string",
        "tkSz": "string",
        "desc": "string",
        "prc": "string",
        "exONo": "string",
        "exp": "string",
        "rcvDt": "string",
        "pdQty": "string",
        "userCmnt": "string",
        "isSL": false,
        "isTgt": false,
        "flId": "string",
        "rmk": "string",
        "boSeqId": "string",
        "epochTim": "string",
        "ordTim": "string",
        "trgId": "string",
        "dpVal": "string",
        "cta": "string",
        "ltp": "string",
        "vndSrc": "string",
        "bsktOrdId": "string",
        "bsktEpch": "string",
        "brkOrd": [
          {
            "flLg": {
              "lstPos": 0,
              "stkPrc": "string",
              "isCOSecLeg": "string",
              "dur": "DAY",
              "vlDt": "string",
              "rcvTim": "string",
              "rcvEpTim": "string",
              "sym": "string",
              "cpName": "string",
              "exit": "string",
              "syomID": "string",
              "exc": "string",
              "ntQty": "string",
              "dpName": "string",
              "cancel": "string",
              "sipID": "string",
              "nstReqID": "string",
              "ordTyp": "LIMIT",
              "qtyUnits": "string",
              "opTyp": "string",
              "trsTyp": "string",
              "srs": "string",
              "reqQty": "string",
              "prdCode": "CNC",
              "ogt": "string",
              "flQty": "string",
              "trdSym": "string",
              "edit": "string",
              "asTyp": "string",
              "trgPrc": "string",
              "avgPrc": "string",
              "dsQty": "string",
              "ordID": "string",
              "sts": "string",
              "dpInsTyp": "string",
              "rjRsn": "string",
              "userID": "string",
              "dpExpDt": "string",
              "ltSz": "string",
              "tkSz": "string",
              "desc": "string",
              "prc": "string",
              "exONo": "string",
              "exp": "string",
              "rcvDt": "string",
              "pdQty": "string",
              "userCmnt": "string",
              "isSL": false,
              "isTgt": false,
              "flId": "string",
              "rmk": "string",
              "boSeqId": "string",
              "epochTim": "string",
              "ordTim": "string",
              "trgId": "string",
              "dpVal": "string",
              "cta": "string",
              "ltp": "string",
              "vndSrc": "string",
              "bsktOrdId": "string",
              "bsktEpch": "string"
            },
            "slLg": {
              "lstPos": 0,
              "stkPrc": "string",
              "isCOSecLeg": "string",
              "dur": "DAY",
              "vlDt": "string",
              "rcvTim": "string",
              "rcvEpTim": "string",
              "sym": "string",
              "cpName": "string",
              "exit": "string",
              "syomID": "string",
              "exc": "string",
              "ntQty": "string",
              "dpName": "string",
              "cancel": "string",
              "sipID": "string",
              "nstReqID": "string",
              "ordTyp": "LIMIT",
              "qtyUnits": "string",
              "opTyp": "string",
              "trsTyp": "string",
              "srs": "string",
              "reqQty": "string",
              "prdCode": "CNC",
              "ogt": "string",
              "flQty": "string",
              "trdSym": "string",
              "edit": "string",
              "asTyp": "string",
              "trgPrc": "string",
              "avgPrc": "string",
              "dsQty": "string",
              "ordID": "string",
              "sts": "string",
              "dpInsTyp": "string",
              "rjRsn": "string",
              "userID": "string",
              "dpExpDt": "string",
              "ltSz": "string",
              "tkSz": "string",
              "desc": "string",
              "prc": "string",
              "exONo": "string",
              "exp": "string",
              "rcvDt": "string",
              "pdQty": "string",
              "userCmnt": "string",
              "isSL": false,
              "isTgt": false,
              "flId": "string",
              "rmk": "string",
              "boSeqId": "string",
              "epochTim": "string",
              "ordTim": "string",
              "trgId": "string",
              "dpVal": "string",
              "cta": "string",
              "ltp": "string",
              "vndSrc": "string",
              "bsktOrdId": "string",
              "bsktEpch": "string"
            },
            "tgtLg": {
              "lstPos": 0,
              "stkPrc": "string",
              "isCOSecLeg": "string",
              "dur": "DAY",
              "vlDt": "string",
              "rcvTim": "string",
              "rcvEpTim": "string",
              "sym": "string",
              "cpName": "string",
              "exit": "string",
              "syomID": "string",
              "exc": "string",
              "ntQty": "string",
              "dpName": "string",
              "cancel": "string",
              "sipID": "string",
              "nstReqID": "string",
              "ordTyp": "LIMIT",
              "qtyUnits": "string",
              "opTyp": "string",
              "trsTyp": "string",
              "srs": "string",
              "reqQty": "string",
              "prdCode": "CNC",
              "ogt": "string",
              "flQty": "string",
              "trdSym": "string",
              "edit": "string",
              "asTyp": "string",
              "trgPrc": "string",
              "avgPrc": "string",
              "dsQty": "string",
              "ordID": "string",
              "sts": "string",
              "dpInsTyp": "string",
              "rjRsn": "string",
              "userID": "string",
              "dpExpDt": "string",
              "ltSz": "string",
              "tkSz": "string",
              "desc": "string",
              "prc": "string",
              "exONo": "string",
              "exp": "string",
              "rcvDt": "string",
              "pdQty": "string",
              "userCmnt": "string",
              "isSL": false,
              "isTgt": false,
              "flId": "string",
              "rmk": "string",
              "boSeqId": "string",
              "epochTim": "string",
              "ordTim": "string",
              "trgId": "string",
              "dpVal": "string",
              "cta": "string",
              "ltp": "string",
              "vndSrc": "string",
              "bsktOrdId": "string",
              "bsktEpch": "string"
            }
          }
        ]
      }
    ]
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» ord
            []
            false
            none
            none
          

        
      

      
EqTradeBookDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "trade": [
      {
        "ordTim": "string",
        "trdSym": "string",
        "exONo": "string",
        "dpInsTyp": "string",
        "ntPrc": "string",
        "rmk": "string",
        "dpExpDt": "string",
        "ltSz": "string",
        "cpName": "string",
        "prdCode": "CNC",
        "flTim": "string",
        "flDt": "string",
        "flLeg": "string",
        "flID": "string",
        "fldQty": "string",
        "psCnv": "string",
        "qty": "string",
        "rjRsn": "string",
        "opTyp": "string",
        "sym": "string",
        "dpName": "string",
        "ordID": "string",
        "trsTyp": "string",
        "stkPrc": "string",
        "exc": "string",
        "chgP": "string",
        "sts": "string",
        "asTyp": "string",
        "tkSz": "string",
        "ordType": "string",
        "trdID": "string",
        "ltp": "string",
        "flQty": "string",
        "chg": "string",
        "srs": "string",
        "rcvTim": "string",
        "nstReqID": "string",
        "flPrc": "string",
        "exp": "string",
        "qtyUnits": "string",
        "epochTim": "string"
      }
    ]
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» trade
            []
            false
            none
            none
          

        
      

      
AddPayOutRequest

      

        
        
        
      

      
{
  "seg": "string",
  "bnkName": "string",
  "bnkAccNo": "string",
  "brcName": "string",
  "ifsc": "string",
  "trnsAmt": "string",
  "rmk": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            seg
            string
            false
            none
            Segment Name
          

          

            bnkName
            string
            false
            none
            Bank Name
          

          

            bnkAccNo
            string
            false
            none
            Bank Account Number
          

          

            brcName
            string
            false
            none
            Bank Branch Name
          

          

            ifsc
            string
            false
            none
            Bank IFSC code
          

          

            trnsAmt
            string
            false
            none
            Transaction Ammount
          

          

            rmk
            string
            false
            none
            Remarks
          

        
      

      
AddPayOutDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "sts": "string",
    "msg": "string",
    "trnSt": {
      "reqTyp": "string",
      "seg": "string",
      "instNo": "string",
      "dt": "string",
      "tm": "string",
      "trnsAmt": "string",
      "refNo": "string",
      "rmk": "string",
      "bnkName": "string",
      "sts": "string",
      "brcName": "string",
      "bnkAccNo": "string",
      "edit": "string",
      "cancel": "string",
      "verify": "string",
      "ldgrNm": "string",
      "upi": "string",
      "payMd": "string"
    }
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» sts
            string
            false
            none
            none
          

          

            »» msg
            string
            false
            none
            none
          

          

            »» trnSt
            
            false
            none
            none
          

        
      

      
NetPositionsDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "pos": [
      {
        "sym": "string",
        "ltp": "string",
        "ltt": "string",
        "chg": "string",
        "chgP": "string",
        "exc": "string",
        "vol": "string",
        "dpName": "string",
        "trdSym": "string",
        "asTyp": "string",
        "ltSz": "string",
        "tkSz": "string",
        "dpInsTyp": "string",
        "desc": "string",
        "dpVal": "string",
        "stkPrc": "string",
        "opTyp": "string",
        "exp": "string",
        "dpExpDt": "string",
        "opInt": "string",
        "opIntChg": "string",
        "opIntChgP": "string",
        "spot": "string",
        "rlOvrP": "string",
        "rlCAbs": "string",
        "trsTyp": "string",
        "prdCode": "CNC",
        "avgSlPrc": "string",
        "avgByPrc": "string",
        "byAmt": "string",
        "byQty": "string",
        "slAmt": "string",
        "slQty": "string",
        "ntQty": "string",
        "ntAmt": "string",
        "rlzPL": "string",
        "urlzPL": "string",
        "ntPL": "string",
        "mtm": "string",
        "prc": "string",
        "sqOff": "string",
        "mul": "string",
        "cpName": "string",
        "rchFlg": "string",
        "nwsFlg": "string",
        "cfAvgSlPrc": "string",
        "cfAvgByPrc": "string",
        "cfSlQty": "string",
        "cfByQty": "string",
        "cfSlAmt": "string",
        "cfByAmt": "string",
        "ntSlQty": "string",
        "ntByQty": "string",
        "ntSlAmt": "string",
        "ntByAmt": "string",
        "brkEvnPrc": "string",
        "uniqKey": "string",
        "pn": "string",
        "gn": "string",
        "gd": "string",
        "pd": "string"
      }
    ],
    "ntMTM": "string",
    "tdyMtm": "string",
    "urlMtm": "string",
    "npos": "string",
    "opn": "string",
    "cls": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» pos
            []
            false
            none
            none
          

          

            »» ntMTM
            string
            false
            none
            none
          

          

            »» tdyMtm
            string
            false
            none
            none
          

          

            »» urlMtm
            string
            false
            none
            none
          

          

            »» npos
            string
            false
            none
            none
          

          

            »» opn
            string
            false
            none
            none
          

          

            »» cls
            string
            false
            none
            none
          

        
      

      
EQPlaceTradeRequestDao

      

        
        
        
      

      
{
  "trdSym": "string",
  "exc": "BSE",
  "action": "BUY",
  "dur": "DAY",
  "flQty": "string",
  "ordTyp": "LIMIT",
  "qty": "string",
  "dscQty": "string",
  "sym": "string",
  "mktPro": "string",
  "lmPrc": "string",
  "trgPrc": "string",
  "prdCode": "CNC",
  "dtDays": "string",
  "posSqr": "string",
  "minQty": "string",
  "ordSrc": "MOB",
  "vnCode": "string",
  "rmk": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            trdSym
            string
            false
            none
            Trading Symbol of the Scrip, to be obtained from Contract file downloaded
          

          

            exc
            string
            false
            none
            Name of the exchange, BSE/NSE
          

          

            action
            
            false
            none
            Action to be performed, BUY/SELL
          

          

            dur
            
            false
            none
            Order validity, DAY/IOC/EOS(for BSE)
          

          

            flQty
            string
            false
            none
            Filled Quantity or filled shares. It is mandatory for order modification
            
          

          

            ordTyp
            
            false
            none
            Order Type
          

          

            qty
            string
            false
            none
            Quantity in multiple of Lot size/Board lot qty
          

          

            dscQty
            string
            false
            none
            Disclosed Quantity. Quantity to be disclosed publicly while order placement (default 0)
          

          

            sym
            string
            false
            none
            Symbol of the contract that is being traded.SYMBOL_EXCHANGE From MW
          

          

            mktPro
            string
            false
            none
            Market Protection
          

          

            lmPrc
            string
            false
            none
            Limit price of scrip in multiple of tick size
          

          

            trgPrc
            string
            false
            none
            Trigger Price applicable for SL/SL-M Orders (default 0)
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            dtDays
            string
            false
            none
            Date Days
          

          

            posSqr
            string
            false
            none
            Position Square Flag
          

          

            minQty
            string
            false
            none
            Minimum Quantity
          

          

            ordSrc
            string
            false
            none
            Location Indicator
          

          

            vnCode
            string
            false
            none
            Vendor Code
          

          

            rmk
            string
            false
            none
            Remarks
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            exc
            BSE
          

          

            exc
            NSE
          

          

            ordSrc
            MOB
          

          

            ordSrc
            WEB
          

          

            ordSrc
            XMLAPI
          

          

            ordSrc
            TOC
          

        
      

      
PlaceTradeDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string",
    "oid": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» msg
            string
            false
            none
            none
          

          

            »» oid
            string
            false
            none
            none
          

        
      

      
PlaceTradeBaseketDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» msg
            string
            false
            none
            none
          

        
      

      
EQBracketTradeRequestDao

      

        
        
        
      

      
{
  "exc": "string",
  "sym": "string",
  "trnsTyp": "BUY",
  "qty": "string",
  "dur": "DAY",
  "dsQty": "string",
  "prc": "string",
  "trdBsdOn": "LTP",
  "sqOffBsdOn": "Absolute",
  "sqOffVal": "string",
  "slBsdOn": "Absolute",
  "slVal": "string",
  "trlSl": "Y",
  "trlSlVal": "string",
  "ordSrc": "EMT"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            exc
            string
            false
            none
            Name of the exchange, BSE/NSE
          

          

            sym
            string
            false
            none
            Symbol
          

          

            trnsTyp
            
            false
            none
            Action to be performed, BUY/SELL
          

          

            qty
            string
            false
            none
            Quantity of the scrip to transact
          

          

            dur
            
            false
            none
            Order validity, DAY/IOC/EOS(for BSE)
          

          

            dsQty
            string
            false
            none
            Quantity to be disclosed publicly while order placement (default 0)
          

          

            prc
            string
            false
            none
            Price
          

          

            trdBsdOn
            string
            false
            none
            Trade Based On, (ATP is optional)
          

          

            sqOffBsdOn
            string
            false
            none
            Square Off Based On, (Ticks is optional)
          

          

            sqOffVal
            string
            false
            none
            Square Off Value
          

          

            slBsdOn
            string
            false
            none
            Stop Loss Based On Absolute/Ticks ,(Ticks is optional)
          

          

            slVal
            string
            false
            none
            Stop Loss Value
          

          

            trlSl
            string
            false
            none
            Trailing Stop Loss Flag, Y/N (default Y)
          

          

            trlSlVal
            string
            false
            none
            Trailing Stop Loss Value, Number (default 1)
          

          

            ordSrc
            string
            false
            none
            Location Indicator
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            trdBsdOn
            LTP
          

          

            trdBsdOn
            ATP
          

          

            sqOffBsdOn
            Absolute
          

          

            sqOffBsdOn
            Ticks
          

          

            slBsdOn
            Absolute
          

          

            slBsdOn
            Ticks
          

          

            trlSl
            Y
          

          

            trlSl
            N
          

          

            ordSrc
            EMT
          

          

            ordSrc
            WEB
          

          

            ordSrc
            XMLAPI
          

          

            ordSrc
            TOC
          

          

            ordSrc
            TX3
          

        
      

      
EQCancelTradeRequestDao

      

        
        
        
      

      
{
  "nstOID": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            nstOID
            string
            false
            none
            Nest Order ID.Order number received from Order book response. It is mandatory for modifying/cancelling
              an order.
          

        
      

      
BasketOrderRequestDao

      

        
        
        
      

      
{
  "ordLst": [
    {
      "exc": "string",
      "trdSym": "string",
      "action": "BUY",
      "prdCode": "CNC",
      "ordTyp": "LIMIT",
      "dur": "DAY",
      "price": "string",
      "trgPrc": "string",
      "qty": "string",
      "dscQty": "string",
      "gtdDt": "string",
      "rmk": "string",
      "vnCode": "string"
    }
  ],
  "ordSrc": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            ordLst
            []
            false
            none
            List of Basket Orders
          

          

            ordSrc
            string
            false
            none
            Order Source
          

        
      

      
OrderBookResponseObject

      

        
        
        
      

      
{
  "lstPos": 0,
  "stkPrc": "string",
  "isCOSecLeg": "string",
  "dur": "string",
  "vlDt": "string",
  "rcvTim": "string",
  "rcvEpTim": "string",
  "sym": "string",
  "cpName": "string",
  "exit": "string",
  "syomID": "string",
  "exc": "string",
  "ntQty": "string",
  "dpName": "string",
  "cancel": "string",
  "sipID": "string",
  "nstReqID": "string",
  "ordTyp": "LIMIT",
  "qtyUnits": "string",
  "opTyp": "string",
  "trsTyp": "string",
  "srs": "string",
  "reqQty": "string",
  "prdCode": "CNC",
  "ogt": "string",
  "flQty": "string",
  "trdSym": "string",
  "edit": "string",
  "asTyp": "string",
  "trgPrc": "string",
  "avgPrc": "string",
  "dsQty": "string",
  "ordID": "string",
  "sts": "string",
  "dpInsTyp": "string",
  "rjRsn": "string",
  "userID": "string",
  "dpExpDt": "string",
  "ltSz": "string",
  "tkSz": "string",
  "desc": "string",
  "prc": "string",
  "exONo": "string",
  "exp": "string",
  "rcvDt": "string",
  "pdQty": "string",
  "userCmnt": "string",
  "isSL": false,
  "isTgt": false,
  "flId": "string",
  "rmk": "string",
  "boSeqId": "string",
  "epochTim": "string",
  "ordTim": "string",
  "trgId": "string",
  "dpVal": "string",
  "cta": "string",
  "ltp": "string",
  "vndSrc": "string",
  "bsktOrdId": "string",
  "bsktEpch": "string",
  "brkOrd": [
    {
      "flLg": {
        "lstPos": 0,
        "stkPrc": "string",
        "isCOSecLeg": "string",
        "dur": "DAY",
        "vlDt": "string",
        "rcvTim": "string",
        "rcvEpTim": "string",
        "sym": "string",
        "cpName": "string",
        "exit": "string",
        "syomID": "string",
        "exc": "string",
        "ntQty": "string",
        "dpName": "string",
        "cancel": "string",
        "sipID": "string",
        "nstReqID": "string",
        "ordTyp": "LIMIT",
        "qtyUnits": "string",
        "opTyp": "string",
        "trsTyp": "string",
        "srs": "string",
        "reqQty": "string",
        "prdCode": "CNC",
        "ogt": "string",
        "flQty": "string",
        "trdSym": "string",
        "edit": "string",
        "asTyp": "string",
        "trgPrc": "string",
        "avgPrc": "string",
        "dsQty": "string",
        "ordID": "string",
        "sts": "string",
        "dpInsTyp": "string",
        "rjRsn": "string",
        "userID": "string",
        "dpExpDt": "string",
        "ltSz": "string",
        "tkSz": "string",
        "desc": "string",
        "prc": "string",
        "exONo": "string",
        "exp": "string",
        "rcvDt": "string",
        "pdQty": "string",
        "userCmnt": "string",
        "isSL": false,
        "isTgt": false,
        "flId": "string",
        "rmk": "string",
        "boSeqId": "string",
        "epochTim": "string",
        "ordTim": "string",
        "trgId": "string",
        "dpVal": "string",
        "cta": "string",
        "ltp": "string",
        "vndSrc": "string",
        "bsktOrdId": "string",
        "bsktEpch": "string"
      },
      "slLg": {
        "lstPos": 0,
        "stkPrc": "string",
        "isCOSecLeg": "string",
        "dur": "DAY",
        "vlDt": "string",
        "rcvTim": "string",
        "rcvEpTim": "string",
        "sym": "string",
        "cpName": "string",
        "exit": "string",
        "syomID": "string",
        "exc": "string",
        "ntQty": "string",
        "dpName": "string",
        "cancel": "string",
        "sipID": "string",
        "nstReqID": "string",
        "ordTyp": "LIMIT",
        "qtyUnits": "string",
        "opTyp": "string",
        "trsTyp": "string",
        "srs": "string",
        "reqQty": "string",
        "prdCode": "CNC",
        "ogt": "string",
        "flQty": "string",
        "trdSym": "string",
        "edit": "string",
        "asTyp": "string",
        "trgPrc": "string",
        "avgPrc": "string",
        "dsQty": "string",
        "ordID": "string",
        "sts": "string",
        "dpInsTyp": "string",
        "rjRsn": "string",
        "userID": "string",
        "dpExpDt": "string",
        "ltSz": "string",
        "tkSz": "string",
        "desc": "string",
        "prc": "string",
        "exONo": "string",
        "exp": "string",
        "rcvDt": "string",
        "pdQty": "string",
        "userCmnt": "string",
        "isSL": false,
        "isTgt": false,
        "flId": "string",
        "rmk": "string",
        "boSeqId": "string",
        "epochTim": "string",
        "ordTim": "string",
        "trgId": "string",
        "dpVal": "string",
        "cta": "string",
        "ltp": "string",
        "vndSrc": "string",
        "bsktOrdId": "string",
        "bsktEpch": "string"
      },
      "tgtLg": {
        "lstPos": 0,
        "stkPrc": "string",
        "isCOSecLeg": "string",
        "dur": "DAY",
        "vlDt": "string",
        "rcvTim": "string",
        "rcvEpTim": "string",
        "sym": "string",
        "cpName": "string",
        "exit": "string",
        "syomID": "string",
        "exc": "string",
        "ntQty": "string",
        "dpName": "string",
        "cancel": "string",
        "sipID": "string",
        "nstReqID": "string",
        "ordTyp": "LIMIT",
        "qtyUnits": "string",
        "opTyp": "string",
        "trsTyp": "string",
        "srs": "string",
        "reqQty": "string",
        "prdCode": "CNC",
        "ogt": "string",
        "flQty": "string",
        "trdSym": "string",
        "edit": "string",
        "asTyp": "string",
        "trgPrc": "string",
        "avgPrc": "string",
        "dsQty": "string",
        "ordID": "string",
        "sts": "string",
        "dpInsTyp": "string",
        "rjRsn": "string",
        "userID": "string",
        "dpExpDt": "string",
        "ltSz": "string",
        "tkSz": "string",
        "desc": "string",
        "prc": "string",
        "exONo": "string",
        "exp": "string",
        "rcvDt": "string",
        "pdQty": "string",
        "userCmnt": "string",
        "isSL": false,
        "isTgt": false,
        "flId": "string",
        "rmk": "string",
        "boSeqId": "string",
        "epochTim": "string",
        "ordTim": "string",
        "trgId": "string",
        "dpVal": "string",
        "cta": "string",
        "ltp": "string",
        "vndSrc": "string",
        "bsktOrdId": "string",
        "bsktEpch": "string"
      }
    }
  ]
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            lstPos
            integer(int32)
            false
            none
            none
          

          

            stkPrc
            string
            false
            none
            Strike price
          

          

            isCOSecLeg
            string
            false
            none
            Cover Order second leg flag
          

          

            dur
            string
            false
            none
            Order Duration DAY/IOC/EOS etc
          

          

            vlDt
            string
            false
            none
            Order validity data -GTC/GTD
          

          

            rcvTim
            string
            false
            none
            Time
          

          

            rcvEpTim
            string
            false
            none
            Epoch time
          

          

            sym
            string
            false
            none
            Streaming symbol
          

          

            cpName
            string
            false
            none
            Company name
          

          

            exit
            string
            false
            none
            Exit flag
          

          

            syomID
            string
            false
            none
            Traded order id
          

          

            exc
            string
            false
            none
            Exchange
          

          

            ntQty
            string
            false
            none
            Net quantity
          

          

            dpName
            string
            false
            none
            Display scrip name
          

          

            cancel
            string
            false
            none
            Order Cancellatiion flag
          

          

            sipID
            string
            false
            none
            SIP Indicator
          

          

            nstReqID
            string
            false
            none
            Nest request id
          

          

            ordTyp
            
            false
            none
            Order Type
          

          

            qtyUnits
            string
            false
            none
            Quantity -- commodity
          

          

            opTyp
            string
            false
            none
            Option type
          

          

            trsTyp
            string
            false
            none
            Transaction type
          

          

            srs
            string
            false
            none
            Series
          

          

            reqQty
            string
            false
            none
            Requested quantity - not using
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            ogt
            string
            false
            none
            Order generation type
          

          

            flQty
            string
            false
            none
            Quantity traded
          

          

            trdSym
            string
            false
            none
            Trading symbol
          

          

            edit
            string
            false
            none
            Order modification flag
          

          

            asTyp
            string
            false
            none
            Asset type
          

          

            trgPrc
            string
            false
            none
            Trigger price
          

          

            avgPrc
            string
            false
            none
            Average price
          

          

            dsQty
            string
            false
            none
            Disclosed quantity
          

          

            ordID
            string
            false
            none
            Order number
          

          

            sts
            string
            false
            none
            Order Status
          

          

            dpInsTyp
            string
            false
            none
            Display instrument type
          

          

            rjRsn
            string
            false
            none
            Rejection reason
          

          

            userID
            string
            false
            none
            User id
          

          

            dpExpDt
            string
            false
            none
            Display expiry date
          

          

            ltSz
            string
            false
            none
            Lot size
          

          

            tkSz
            string
            false
            none
            Tick size
          

          

            desc
            string
            false
            none
            Order description
          

          

            prc
            string
            false
            none
            Price
          

          

            exONo
            string
            false
            none
            Exchange order number
          

          

            exp
            string
            false
            none
            Scrip expiry
          

          

            rcvDt
            string
            false
            none
            Order recieved date
          

          

            pdQty
            string
            false
            none
            Pending quantity
          

          

            userCmnt
            string
            false
            none
            Comment added by user while placing the order
          

          

            isSL
            boolean
            false
            none
            Bracket order SL leg flag
          

          

            isTgt
            boolean
            false
            none
            Flag for target leg of bracket order
          

          

            flId
            string
            false
            none
            Fill id comes when order is traded (fully or partially)
          

          

            rmk
            string
            false
            none
            Remark added by the small case user while placing the order
          

          

            boSeqId
            string
            false
            none
            Sequence id for bracket order legs
          

          

            epochTim
            string
            false
            none
            none
          

          

            ordTim
            string
            false
            none
            Time stamp
          

          

            trgId
            string
            false
            none
            Trigger ID
          

          

            dpVal
            string
            false
            none
            display real scrip name
          

          

            cta
            string
            false
            none
            Call to action based on rejection reason
          

          

            ltp
            string
            false
            none
            Last Traded Price
          

          

            vndSrc
            string
            false
            none
            Order source vendor (value may be null if unavailable)
          

          

            bsktOrdId
            string
            false
            none
            Basket Order Id
          

          

            bsktEpch
            string
            false
            none
            Basket Order Placement Time
          

          

            brkOrd
            []
            false
            none
            none
          

        
      

      
EqTradeBookResponseObject

      

        
        
        
      

      
{
  "ordTim": "string",
  "trdSym": "string",
  "exONo": "string",
  "dpInsTyp": "string",
  "ntPrc": "string",
  "rmk": "string",
  "dpExpDt": "string",
  "ltSz": "string",
  "cpName": "string",
  "prdCode": "CNC",
  "flTim": "string",
  "flDt": "string",
  "flLeg": "string",
  "flID": "string",
  "fldQty": "string",
  "psCnv": "string",
  "qty": "string",
  "rjRsn": "string",
  "opTyp": "string",
  "sym": "string",
  "dpName": "string",
  "ordID": "string",
  "trsTyp": "string",
  "stkPrc": "string",
  "exc": "string",
  "chgP": "string",
  "sts": "string",
  "asTyp": "string",
  "tkSz": "string",
  "ordType": "string",
  "trdID": "string",
  "ltp": "string",
  "flQty": "string",
  "chg": "string",
  "srs": "string",
  "rcvTim": "string",
  "nstReqID": "string",
  "flPrc": "string",
  "exp": "string",
  "qtyUnits": "string",
  "epochTim": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            ordTim
            string
            false
            none
            none
          

          

            trdSym
            string
            false
            none
            none
          

          

            exONo
            string
            false
            none
            none
          

          

            dpInsTyp
            string
            false
            none
            none
          

          

            ntPrc
            string
            false
            none
            none
          

          

            rmk
            string
            false
            none
            none
          

          

            dpExpDt
            string
            false
            none
            none
          

          

            ltSz
            string
            false
            none
            none
          

          

            cpName
            string
            false
            none
            none
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            flTim
            string
            false
            none
            none
          

          

            flDt
            string
            false
            none
            none
          

          

            flLeg
            string
            false
            none
            none
          

          

            flID
            string
            false
            none
            none
          

          

            fldQty
            string
            false
            none
            none
          

          

            psCnv
            string
            false
            none
            none
          

          

            qty
            string
            false
            none
            none
          

          

            rjRsn
            string
            false
            none
            none
          

          

            opTyp
            string
            false
            none
            none
          

          

            sym
            string
            false
            none
            none
          

          

            dpName
            string
            false
            none
            none
          

          

            ordID
            string
            false
            none
            none
          

          

            trsTyp
            string
            false
            none
            none
          

          

            stkPrc
            string
            false
            none
            none
          

          

            exc
            string
            false
            none
            none
          

          

            chgP
            string
            false
            none
            none
          

          

            sts
            string
            false
            none
            none
          

          

            asTyp
            string
            false
            none
            none
          

          

            tkSz
            string
            false
            none
            none
          

          

            ordType
            string
            false
            none
            none
          

          

            trdID
            string
            false
            none
            none
          

          

            ltp
            string
            false
            none
            none
          

          

            flQty
            string
            false
            none
            none
          

          

            chg
            string
            false
            none
            none
          

          

            srs
            string
            false
            none
            none
          

          

            rcvTim
            string
            false
            none
            none
          

          

            nstReqID
            string
            false
            none
            none
          

          

            flPrc
            string
            false
            none
            none
          

          

            exp
            string
            false
            none
            none
          

          

            qtyUnits
            string
            false
            none
            none
          

          

            epochTim
            string
            false
            none
            none
          

        
      

      
TransferStatusObject

      

        
        
        
      

      
{
  "reqTyp": "string",
  "seg": "string",
  "instNo": "string",
  "dt": "string",
  "tm": "string",
  "trnsAmt": "string",
  "refNo": "string",
  "rmk": "string",
  "bnkName": "string",
  "sts": "string",
  "brcName": "string",
  "bnkAccNo": "string",
  "edit": "string",
  "cancel": "string",
  "verify": "string",
  "ldgrNm": "string",
  "upi": "string",
  "payMd": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            reqTyp
            string
            false
            none
            none
          

          

            seg
            string
            false
            none
            none
          

          

            instNo
            string
            false
            none
            none
          

          

            dt
            string
            false
            none
            none
          

          

            tm
            string
            false
            none
            none
          

          

            trnsAmt
            string
            false
            none
            none
          

          

            refNo
            string
            false
            none
            none
          

          

            rmk
            string
            false
            none
            none
          

          

            bnkName
            string
            false
            none
            none
          

          

            sts
            string
            false
            none
            none
          

          

            brcName
            string
            false
            none
            none
          

          

            bnkAccNo
            string
            false
            none
            none
          

          

            edit
            string
            false
            none
            none
          

          

            cancel
            string
            false
            none
            none
          

          

            verify
            string
            false
            none
            none
          

          

            ldgrNm
            string
            false
            none
            Ledger Name
          

          

            upi
            string
            false
            none
            upi used for transfer
          

          

            payMd
            string
            false
            none
            Payment Mode - Internet Banking/UPI
          

        
      

      
NetPositionsObject

      

        
        
        
      

      
{
  "sym": "string",
  "ltp": "string",
  "ltt": "string",
  "chg": "string",
  "chgP": "string",
  "exc": "string",
  "vol": "string",
  "dpName": "string",
  "trdSym": "string",
  "asTyp": "string",
  "ltSz": "string",
  "tkSz": "string",
  "dpInsTyp": "string",
  "desc": "string",
  "dpVal": "string",
  "stkPrc": "string",
  "opTyp": "string",
  "exp": "string",
  "dpExpDt": "string",
  "opInt": "string",
  "opIntChg": "string",
  "opIntChgP": "string",
  "spot": "string",
  "rlOvrP": "string",
  "rlCAbs": "string",
  "trsTyp": "string",
  "prdCode": "CNC",
  "avgSlPrc": "string",
  "avgByPrc": "string",
  "byAmt": "string",
  "byQty": "string",
  "slAmt": "string",
  "slQty": "string",
  "ntQty": "string",
  "ntAmt": "string",
  "rlzPL": "string",
  "urlzPL": "string",
  "ntPL": "string",
  "mtm": "string",
  "prc": "string",
  "sqOff": "string",
  "mul": "string",
  "cpName": "string",
  "rchFlg": "string",
  "nwsFlg": "string",
  "cfAvgSlPrc": "string",
  "cfAvgByPrc": "string",
  "cfSlQty": "string",
  "cfByQty": "string",
  "cfSlAmt": "string",
  "cfByAmt": "string",
  "ntSlQty": "string",
  "ntByQty": "string",
  "ntSlAmt": "string",
  "ntByAmt": "string",
  "brkEvnPrc": "string",
  "uniqKey": "string",
  "pn": "string",
  "gn": "string",
  "gd": "string",
  "pd": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            sym
            string
            false
            none
            none
          

          

            ltp
            string
            false
            none
            none
          

          

            ltt
            string
            false
            none
            none
          

          

            chg
            string
            false
            none
            none
          

          

            chgP
            string
            false
            none
            none
          

          

            exc
            string
            false
            none
            none
          

          

            vol
            string
            false
            none
            none
          

          

            dpName
            string
            false
            none
            none
          

          

            trdSym
            string
            false
            none
            none
          

          

            asTyp
            string
            false
            none
            none
          

          

            ltSz
            string
            false
            none
            none
          

          

            tkSz
            string
            false
            none
            none
          

          

            dpInsTyp
            string
            false
            none
            none
          

          

            desc
            string
            false
            none
            none
          

          

            dpVal
            string
            false
            none
            none
          

          

            stkPrc
            string
            false
            none
            none
          

          

            opTyp
            string
            false
            none
            none
          

          

            exp
            string
            false
            none
            none
          

          

            dpExpDt
            string
            false
            none
            none
          

          

            opInt
            string
            false
            none
            none
          

          

            opIntChg
            string
            false
            none
            none
          

          

            opIntChgP
            string
            false
            none
            none
          

          

            spot
            string
            false
            none
            none
          

          

            rlOvrP
            string
            false
            none
            none
          

          

            rlCAbs
            string
            false
            none
            none
          

          

            trsTyp
            string
            false
            none
            none
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            avgSlPrc
            string
            false
            none
            none
          

          

            avgByPrc
            string
            false
            none
            none
          

          

            byAmt
            string
            false
            none
            none
          

          

            byQty
            string
            false
            none
            none
          

          

            slAmt
            string
            false
            none
            none
          

          

            slQty
            string
            false
            none
            none
          

          

            ntQty
            string
            false
            none
            none
          

          

            ntAmt
            string
            false
            none
            none
          

          

            rlzPL
            string
            false
            none
            none
          

          

            urlzPL
            string
            false
            none
            none
          

          

            ntPL
            string
            false
            none
            none
          

          

            mtm
            string
            false
            none
            none
          

          

            prc
            string
            false
            none
            none
          

          

            sqOff
            string
            false
            none
            none
          

          

            mul
            string
            false
            none
            none
          

          

            cpName
            string
            false
            none
            none
          

          

            rchFlg
            string
            false
            none
            none
          

          

            nwsFlg
            string
            false
            none
            none
          

          

            cfAvgSlPrc
            string
            false
            none
            none
          

          

            cfAvgByPrc
            string
            false
            none
            none
          

          

            cfSlQty
            string
            false
            none
            none
          

          

            cfByQty
            string
            false
            none
            none
          

          

            cfSlAmt
            string
            false
            none
            none
          

          

            cfByAmt
            string
            false
            none
            none
          

          

            ntSlQty
            string
            false
            none
            none
          

          

            ntByQty
            string
            false
            none
            none
          

          

            ntSlAmt
            string
            false
            none
            none
          

          

            ntByAmt
            string
            false
            none
            none
          

          

            brkEvnPrc
            string
            false
            none
            none
          

          

            uniqKey
            string
            false
            none
            none
          

          

            pn
            string
            false
            none
            none
          

          

            gn
            string
            false
            none
            none
          

          

            gd
            string
            false
            none
            none
          

          

            pd
            string
            false
            none
            none
          

        
      

      
BasketOrder

      

        
        
        
      

      
{
  "exc": "string",
  "trdSym": "string",
  "action": "BUY",
  "prdCode": "CNC",
  "ordTyp": "LIMIT",
  "dur": "DAY",
  "price": "string",
  "trgPrc": "string",
  "qty": "string",
  "dscQty": "string",
  "gtdDt": "string",
  "rmk": "string",
  "vnCode": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            exc
            string
            false
            none
            Exchange
          

          

            trdSym
            string
            false
            none
            Trading Symbol
          

          

            action
            
            false
            none
            Action to be performed, BUY/SELL
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            ordTyp
            
            false
            none
            Order Type
          

          

            dur
            string
            false
            none
            Order duration / Retention
          

          

            price
            string
            false
            none
            Price to fill
          

          

            trgPrc
            string
            false
            none
            Trigger Price
          

          

            qty
            string
            false
            none
            Quantity
          

          

            dscQty
            string
            false
            none
            Disclosed Quantity
          

          

            gtdDt
            string
            false
            none
            GTD Date in dd-MM-yyyy Format
          

          

            rmk
            string
            false
            none
            Remark
          

          

            vnCode
            string
            false
            none
            Vendor code
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            dur
            DAY
          

          

            dur
            IOC
          

        
      

      
BracketOrderObject

      

        
        
        
      

      
{
  "flLg": {
    "lstPos": 0,
    "stkPrc": "string",
    "isCOSecLeg": "string",
    "dur": "DAY",
    "vlDt": "string",
    "rcvTim": "string",
    "rcvEpTim": "string",
    "sym": "string",
    "cpName": "string",
    "exit": "string",
    "syomID": "string",
    "exc": "string",
    "ntQty": "string",
    "dpName": "string",
    "cancel": "string",
    "sipID": "string",
    "nstReqID": "string",
    "ordTyp": "LIMIT",
    "qtyUnits": "string",
    "opTyp": "string",
    "trsTyp": "string",
    "srs": "string",
    "reqQty": "string",
    "prdCode": "CNC",
    "ogt": "string",
    "flQty": "string",
    "trdSym": "string",
    "edit": "string",
    "asTyp": "string",
    "trgPrc": "string",
    "avgPrc": "string",
    "dsQty": "string",
    "ordID": "string",
    "sts": "string",
    "dpInsTyp": "string",
    "rjRsn": "string",
    "userID": "string",
    "dpExpDt": "string",
    "ltSz": "string",
    "tkSz": "string",
    "desc": "string",
    "prc": "string",
    "exONo": "string",
    "exp": "string",
    "rcvDt": "string",
    "pdQty": "string",
    "userCmnt": "string",
    "isSL": false,
    "isTgt": false,
    "flId": "string",
    "rmk": "string",
    "boSeqId": "string",
    "epochTim": "string",
    "ordTim": "string",
    "trgId": "string",
    "dpVal": "string",
    "cta": "string",
    "ltp": "string",
    "vndSrc": "string",
    "bsktOrdId": "string",
    "bsktEpch": "string"
  },
  "slLg": {
    "lstPos": 0,
    "stkPrc": "string",
    "isCOSecLeg": "string",
    "dur": "DAY",
    "vlDt": "string",
    "rcvTim": "string",
    "rcvEpTim": "string",
    "sym": "string",
    "cpName": "string",
    "exit": "string",
    "syomID": "string",
    "exc": "string",
    "ntQty": "string",
    "dpName": "string",
    "cancel": "string",
    "sipID": "string",
    "nstReqID": "string",
    "ordTyp": "LIMIT",
    "qtyUnits": "string",
    "opTyp": "string",
    "trsTyp": "string",
    "srs": "string",
    "reqQty": "string",
    "prdCode": "CNC",
    "ogt": "string",
    "flQty": "string",
    "trdSym": "string",
    "edit": "string",
    "asTyp": "string",
    "trgPrc": "string",
    "avgPrc": "string",
    "dsQty": "string",
    "ordID": "string",
    "sts": "string",
    "dpInsTyp": "string",
    "rjRsn": "string",
    "userID": "string",
    "dpExpDt": "string",
    "ltSz": "string",
    "tkSz": "string",
    "desc": "string",
    "prc": "string",
    "exONo": "string",
    "exp": "string",
    "rcvDt": "string",
    "pdQty": "string",
    "userCmnt": "string",
    "isSL": false,
    "isTgt": false,
    "flId": "string",
    "rmk": "string",
    "boSeqId": "string",
    "epochTim": "string",
    "ordTim": "string",
    "trgId": "string",
    "dpVal": "string",
    "cta": "string",
    "ltp": "string",
    "vndSrc": "string",
    "bsktOrdId": "string",
    "bsktEpch": "string"
  },
  "tgtLg": {
    "lstPos": 0,
    "stkPrc": "string",
    "isCOSecLeg": "string",
    "dur": "DAY",
    "vlDt": "string",
    "rcvTim": "string",
    "rcvEpTim": "string",
    "sym": "string",
    "cpName": "string",
    "exit": "string",
    "syomID": "string",
    "exc": "string",
    "ntQty": "string",
    "dpName": "string",
    "cancel": "string",
    "sipID": "string",
    "nstReqID": "string",
    "ordTyp": "LIMIT",
    "qtyUnits": "string",
    "opTyp": "string",
    "trsTyp": "string",
    "srs": "string",
    "reqQty": "string",
    "prdCode": "CNC",
    "ogt": "string",
    "flQty": "string",
    "trdSym": "string",
    "edit": "string",
    "asTyp": "string",
    "trgPrc": "string",
    "avgPrc": "string",
    "dsQty": "string",
    "ordID": "string",
    "sts": "string",
    "dpInsTyp": "string",
    "rjRsn": "string",
    "userID": "string",
    "dpExpDt": "string",
    "ltSz": "string",
    "tkSz": "string",
    "desc": "string",
    "prc": "string",
    "exONo": "string",
    "exp": "string",
    "rcvDt": "string",
    "pdQty": "string",
    "userCmnt": "string",
    "isSL": false,
    "isTgt": false,
    "flId": "string",
    "rmk": "string",
    "boSeqId": "string",
    "epochTim": "string",
    "ordTim": "string",
    "trgId": "string",
    "dpVal": "string",
    "cta": "string",
    "ltp": "string",
    "vndSrc": "string",
    "bsktOrdId": "string",
    "bsktEpch": "string"
  }
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            flLg
            
            false
            none
            none
          

          

            slLg
            
            false
            none
            none
          

          

            tgtLg
            
            false
            none
            none
          

        
      

      
OrderBookCommonResponseObject

      

        
        
        
      

      
{
  "lstPos": 0,
  "stkPrc": "string",
  "isCOSecLeg": "string",
  "dur": "DAY",
  "vlDt": "string",
  "rcvTim": "string",
  "rcvEpTim": "string",
  "sym": "string",
  "cpName": "string",
  "exit": "string",
  "syomID": "string",
  "exc": "string",
  "ntQty": "string",
  "dpName": "string",
  "cancel": "string",
  "sipID": "string",
  "nstReqID": "string",
  "ordTyp": "LIMIT",
  "qtyUnits": "string",
  "opTyp": "string",
  "trsTyp": "string",
  "srs": "string",
  "reqQty": "string",
  "prdCode": "CNC",
  "ogt": "string",
  "flQty": "string",
  "trdSym": "string",
  "edit": "string",
  "asTyp": "string",
  "trgPrc": "string",
  "avgPrc": "string",
  "dsQty": "string",
  "ordID": "string",
  "sts": "string",
  "dpInsTyp": "string",
  "rjRsn": "string",
  "userID": "string",
  "dpExpDt": "string",
  "ltSz": "string",
  "tkSz": "string",
  "desc": "string",
  "prc": "string",
  "exONo": "string",
  "exp": "string",
  "rcvDt": "string",
  "pdQty": "string",
  "userCmnt": "string",
  "isSL": false,
  "isTgt": false,
  "flId": "string",
  "rmk": "string",
  "boSeqId": "string",
  "epochTim": "string",
  "ordTim": "string",
  "trgId": "string",
  "dpVal": "string",
  "cta": "string",
  "ltp": "string",
  "vndSrc": "string",
  "bsktOrdId": "string",
  "bsktEpch": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            lstPos
            integer(int32)
            false
            none
            none
          

          

            stkPrc
            string
            false
            none
            Strike price
          

          

            isCOSecLeg
            string
            false
            none
            Cover Order second leg flag
          

          

            dur
            
            false
            none
            Order validity, DAY/IOC/EOS(for BSE)
          

          

            vlDt
            string
            false
            none
            Order validity data -GTC/GTD
          

          

            rcvTim
            string
            false
            none
            Time
          

          

            rcvEpTim
            string
            false
            none
            Epoch time
          

          

            sym
            string
            false
            none
            Streaming symbol
          

          

            cpName
            string
            false
            none
            Company name
          

          

            exit
            string
            false
            none
            Exit flag
          

          

            syomID
            string
            false
            none
            Traded order id
          

          

            exc
            string
            false
            none
            Exchange
          

          

            ntQty
            string
            false
            none
            Net quantity
          

          

            dpName
            string
            false
            none
            Display scrip name
          

          

            cancel
            string
            false
            none
            Order Cancellatiion flag
          

          

            sipID
            string
            false
            none
            SIP Indicator
          

          

            nstReqID
            string
            false
            none
            Nest request id
          

          

            ordTyp
            
            false
            none
            Order Type
          

          

            qtyUnits
            string
            false
            none
            Quantity -- commodity
          

          

            opTyp
            string
            false
            none
            Option type
          

          

            trsTyp
            string
            false
            none
            Transaction type
          

          

            srs
            string
            false
            none
            Series
          

          

            reqQty
            string
            false
            none
            Requested quantity - not using
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            ogt
            string
            false
            none
            Order generation type
          

          

            flQty
            string
            false
            none
            Quantity traded
          

          

            trdSym
            string
            false
            none
            Trading symbol
          

          

            edit
            string
            false
            none
            Order modification flag
          

          

            asTyp
            string
            false
            none
            Asset type
          

          

            trgPrc
            string
            false
            none
            Trigger price
          

          

            avgPrc
            string
            false
            none
            Average price
          

          

            dsQty
            string
            false
            none
            Disclosed quantity
          

          

            ordID
            string
            false
            none
            Order number
          

          

            sts
            string
            false
            none
            Order Status
          

          

            dpInsTyp
            string
            false
            none
            Display instrument type
          

          

            rjRsn
            string
            false
            none
            Rejection reason
          

          

            userID
            string
            false
            none
            User id
          

          

            dpExpDt
            string
            false
            none
            Display expiry date
          

          

            ltSz
            string
            false
            none
            Lot size
          

          

            tkSz
            string
            false
            none
            Tick size
          

          

            desc
            string
            false
            none
            Order description
          

          

            prc
            string
            false
            none
            Price
          

          

            exONo
            string
            false
            none
            Exchange order number
          

          

            exp
            string
            false
            none
            Scrip expiry
          

          

            rcvDt
            string
            false
            none
            Order recieved date
          

          

            pdQty
            string
            false
            none
            Pending quantity
          

          

            userCmnt
            string
            false
            none
            Comment added by user while placing the order
          

          

            isSL
            boolean
            false
            none
            Bracket order SL leg flag
          

          

            isTgt
            boolean
            false
            none
            Flag for target leg of bracket order
          

          

            flId
            string
            false
            none
            Fill id comes when order is traded (fully or partially)
          

          

            rmk
            string
            false
            none
            Remark added by the small case user while placing the order
          

          

            boSeqId
            string
            false
            none
            Sequence id for bracket order legs
          

          

            epochTim
            string
            false
            none
            none
          

          

            ordTim
            string
            false
            none
            Time stamp
          

          

            trgId
            string
            false
            none
            Trigger ID
          

          

            dpVal
            string
            false
            none
            display real scrip name
          

          

            cta
            string
            false
            none
            Call to action based on rejection reason
          

          

            ltp
            string
            false
            none
            Last Traded Price
          

          

            vndSrc
            string
            false
            none
            Order source vendor (value may be null if unavailable)
          

          

            bsktOrdId
            string
            false
            none
            Basket Order Id
          

          

            bsktEpch
            string
            false
            none
            Basket Order Placement Time
          

        
      

      
EQConvertPositionReq

      

        
        
        
      

      
{
  "nstOID": "string",
  "flID": "string",
  "prdCodeCh": "CNC",
  "prdCode": "CNC",
  "exc": "string",
  "ordTyp": "LIMIT"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            nstOID
            string
            false
            none
            Nest Order ID .Order number received from Order book response. It is mandatory for modifying/cancelling
              an order
          

          

            flID
            string
            false
            none
            Fill Id of the trade obtained from TradeBook API
          

          

            prdCodeCh
            string
            false
            none
            New Product code of the trade
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            exc
            string
            true
            none
            Name of the exchange, BSE/NSE etc
          

          

            ordTyp
            
            true
            none
            Order Type
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            prdCodeCh
            CNC
          

          

            prdCodeCh
            MIS
          

          

            prdCodeCh
            NRML
          

        
      

      
EqConvertPositionDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» msg
            string
            false
            none
            none
          

        
      

      
SessionExpired

      

        
        
        
      

      
{
  "config": {},
  "error": {
    "actCd": "string",
    "errCd": "string",
    "errMsg": "Session Expired"
  },
  "msgID": "string",
  "srvTm": 0
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            config
            object
            false
            none
            none
          

          

            error
            object
            false
            none
            none
          

          

            » actCd
            string
            false
            none
            none
          

          

            » errCd
            string
            false
            none
            none
          

          

            » errMsg
            string
            false
            none
            none
          

          

            msgID
            string
            false
            none
            none
          

          

            srvTm
            number
            false
            none
            none
          

        
      

      
CommonResponseWrapper

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            appID
            string
            false
            none
            unique value internally generated by to identify the device of the source
          

          

            config
            object
            false
            none
            none
          

          

            msgID
            string
            false
            none
            unique key internally generated for a particular API request/response context
          

          

            srvTm
            string
            false
            none
            none
          

        
      

      
CommonErrorResponse

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "error": {
    "actCd": "string",
    "errCd": "string",
    "errMsg": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » error
            object
            false
            none
            none
          

          

            »» actCd
            string
            false
            none
            none
          

          

            »» errCd
            string
            false
            none
            none
          

          

            »» errMsg
            string
            false
            none
            none
          

        
      

      
TradeRequest

      

        
        
        
      

      
{
  "dur": "DAY",
  "vlDt": "string",
  "sym": "string",
  "lmPrc": "string",
  "ordTyp": "LIMIT",
  "action": "BUY",
  "prdCode": "CNC",
  "exc": "MCX",
  "qty": "string",
  "trdSym": "string",
  "trgPrc": "string",
  "dsQty": "string",
  "rmk": "string",
  "locInd": "MOB",
  "ordSrc": "MOB",
  "vnCode": "string",
  "flQty": "string",
  "nstOID": "string",
  "nstReqID": "string",
  "flID": "string",
  "prdCodeCh": "CNC"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            dur
            string
            false
            none
            Order duration / Retention
          

          

            vlDt
            string
            false
            none
            Validity Date of order (DD-MM-YYYY)
          

          

            sym
            string
            false
            none
            Symbol of the contract that is being traded (SYMBOL_EXCHANGE From MW)
          

          

            lmPrc
            string
            false
            none
            Limit Price()
          

          

            ordTyp
            
            true
            none
            Order Type
          

          

            action
            
            false
            none
            Action to be performed, BUY/SELL
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            exc
            string
            true
            none
            Exchanges
          

          

            qty
            string
            false
            none
            Quantity ()
          

          

            trdSym
            string
            false
            none
            Trading of the contract that is being traded (TRADINGSYMBOL From MW)
          

          

            trgPrc
            string
            false
            none
            Trigger Price ()
          

          

            dsQty
            string
            false
            none
            Disclosed Quantity ()
          

          

            rmk
            string
            false
            none
            Remarks. Any remarks that you may need to store against an order
          

          

            locInd
            string
            false
            none
            Location Indicator
          

          

            ordSrc
            string
            false
            none
            Location Indicator
          

          

            vnCode
            string
            false
            none
            Vendor Code (NA)
          

          

            flQty
            string
            false
            none
            Fill Quantity. . It is mandatory in case of Modify Order
          

          

            nstOID
            string
            true
            none
            Nest Order ID.Order number received from Order book response. It is mandatory for modifying/cancelling
              an order
          

          

            nstReqID
            string
            false
            none
            Nest Order Req ID.Order number received from Order book response. It is mandatory for
              modifying/cancelling an AMO order
          

          

            flID
            string
            false
            none
            FILL ID. FILL ID received from Order book response. It is mandatory for position conversion
          

          

            prdCodeCh
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            dur
            DAY
          

          

            dur
            IOC
          

          

            dur
            GTC
          

          

            dur
            GTD
          

          

            dur
            GTDys
          

          

            dur
            EOS
          

          

            exc
            MCX
          

          

            exc
            NCDEX
          

          

            locInd
            MOB
          

          

            locInd
            WEB
          

          

            locInd
            TOC
          

          

            ordSrc
            MOB
          

          

            ordSrc
            WEB
          

          

            ordSrc
            XMLAPI
          

          

            ordSrc
            TOC
          

        
      

      
ComOrderDetailsDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "ord": [
      {
        "exc": "string",
        "ordID": "string",
        "nstReqID": "string",
        "trsTyp": "string",
        "symName": "string",
        "scName": "string",
        "prcTF": "string",
        "avgPrc": "string",
        "trgPrc": "string",
        "qtyTF": "string",
        "unFlSz": "string",
        "dsQty": "string",
        "exOID": "string",
        "sts": "string",
        "tim": "string",
        "txt": "string",
        "prcTyp": "string",
        "dur": "string",
        "prdCode": "CNC"
      }
    ]
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» ord
            []
            false
            none
            none
          

        
      

      
ComOrderDetailsResponseObject

      

        
        
        
      

      
{
  "exc": "string",
  "ordID": "string",
  "nstReqID": "string",
  "trsTyp": "string",
  "symName": "string",
  "scName": "string",
  "prcTF": "string",
  "avgPrc": "string",
  "trgPrc": "string",
  "qtyTF": "string",
  "unFlSz": "string",
  "dsQty": "string",
  "exOID": "string",
  "sts": "string",
  "tim": "string",
  "txt": "string",
  "prcTyp": "string",
  "dur": "string",
  "prdCode": "CNC"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            exc
            string
            false
            none
            Name of the exchange, BSE/NSE/MCX/NCDEX
          

          

            ordID
            string
            false
            none
            Order Id
          

          

            nstReqID
            string
            false
            none
            none
          

          

            trsTyp
            string
            false
            none
            none
          

          

            symName
            string
            false
            none
            none
          

          

            scName
            string
            false
            none
            none
          

          

            prcTF
            string
            false
            none
            none
          

          

            avgPrc
            string
            false
            none
            none
          

          

            trgPrc
            string
            false
            none
            none
          

          

            qtyTF
            string
            false
            none
            none
          

          

            unFlSz
            string
            false
            none
            none
          

          

            dsQty
            string
            false
            none
            none
          

          

            exOID
            string
            false
            none
            none
          

          

            sts
            string
            false
            none
            none
          

          

            tim
            string
            false
            none
            none
          

          

            txt
            string
            false
            none
            none
          

          

            prcTyp
            string
            false
            none
            none
          

          

            dur
            string
            false
            none
            none
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

        
      

      
ComOrderHistoryDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "hstOrdBk": [
      {
        "exc": "string",
        "ordID": "string",
        "nstReqID": "string",
        "trsTyp": "string",
        "symName": "string",
        "prcTF": "string",
        "avgPrc": "string",
        "trgPrc": "string",
        "qtyTF": "string",
        "unFlSz": "string",
        "dsQty": "string",
        "exOID": "string",
        "sts": "string",
        "rjRsn": "string",
        "ordTyp": "LIMIT",
        "dur": "string",
        "prdCode": "CNC",
        "rpTyp": "string",
        "trdSym": "string",
        "cstFirm": "string",
        "flQty": "string",
        "exTimStm": "string",
        "ordSrc": "string",
        "flDtTim": "string",
        "ordGenTyp": "string",
        "ordEntTyp": "string"
      }
    ]
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» hstOrdBk
            []
            false
            none
            none
          

        
      

      
ComOrderHistoryResponseObject

      

        
        
        
      

      
{
  "exc": "string",
  "ordID": "string",
  "nstReqID": "string",
  "trsTyp": "string",
  "symName": "string",
  "prcTF": "string",
  "avgPrc": "string",
  "trgPrc": "string",
  "qtyTF": "string",
  "unFlSz": "string",
  "dsQty": "string",
  "exOID": "string",
  "sts": "string",
  "rjRsn": "string",
  "ordTyp": "LIMIT",
  "dur": "string",
  "prdCode": "CNC",
  "rpTyp": "string",
  "trdSym": "string",
  "cstFirm": "string",
  "flQty": "string",
  "exTimStm": "string",
  "ordSrc": "string",
  "flDtTim": "string",
  "ordGenTyp": "string",
  "ordEntTyp": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            exc
            string
            false
            none
            none
          

          

            ordID
            string
            false
            none
            none
          

          

            nstReqID
            string
            false
            none
            none
          

          

            trsTyp
            string
            false
            none
            none
          

          

            symName
            string
            false
            none
            none
          

          

            prcTF
            string
            false
            none
            none
          

          

            avgPrc
            string
            false
            none
            none
          

          

            trgPrc
            string
            false
            none
            none
          

          

            qtyTF
            string
            false
            none
            none
          

          

            unFlSz
            string
            false
            none
            none
          

          

            dsQty
            string
            false
            none
            none
          

          

            exOID
            string
            false
            none
            none
          

          

            sts
            string
            false
            none
            none
          

          

            rjRsn
            string
            false
            none
            none
          

          

            ordTyp
            
            false
            none
            Order Type
          

          

            dur
            string
            false
            none
            none
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            rpTyp
            string
            false
            none
            none
          

          

            trdSym
            string
            false
            none
            none
          

          

            cstFirm
            string
            false
            none
            none
          

          

            flQty
            string
            false
            none
            none
          

          

            exTimStm
            string
            false
            none
            none
          

          

            ordSrc
            string
            false
            none
            none
          

          

            flDtTim
            string
            false
            none
            none
          

          

            ordGenTyp
            string
            false
            none
            none
          

          

            ordEntTyp
            string
            false
            none
            none
          

        
      

      
ComPortfolioDetailDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "stkLst": [
      {
        "trdSym": "string",
        "sym": "string",
        "asTyp": "string",
        "yrLw": "string",
        "yrH": "string",
        "o": "string",
        "h": "string",
        "l": "string",
        "c": "string",
        "ltp": "string",
        "ltt": "string",
        "altt": "string",
        "lut": "string",
        "atp": "string",
        "bidPr": "string",
        "askPr": "string",
        "vol": "string",
        "loCt": "string",
        "hiCt": "string",
        "chg": "string",
        "chgP": "string",
        "ltSz": "string",
        "tkSz": "string",
        "dpNm": "string",
        "stkPrc": "string",
        "opTyp": "string",
        "exp": "string",
        "desc": "string",
        "exc": "string",
        "brdLotQty": "string",
        "qtyUnits": "string",
        "prcUnits": "string",
        "prcQtn": "string",
        "dpInsTyp": "string",
        "bdSz": "string",
        "akSz": "string",
        "dpExpDt": "string",
        "opInt": "string",
        "opIntChg": "string",
        "opIntChgP": "string",
        "spotSym": "string",
        "spot": "string",
        "spotChg": "string",
        "spotChgP": "string",
        "rlOvrP": "string",
        "rlCAbs": "string",
        "ltTQty": "string",
        "tdrStDt": "string",
        "tdrEndDt": "string",
        "srpStDt": "string",
        "mxLtSz": "string",
        "trdInfoId": [
          "string"
        ],
        "ntByQty": "string",
        "ntSlQty": "string",
        "onewkhi": "string",
        "onewklo": "string",
        "onemnhi": "string",
        "onemnlo": "string",
        "thrmnhi": "string",
        "thrmnlo": "string",
        "alltmhi": "string",
        "alltmlo": "string",
        "askivfut": "string",
        "askivspt": "string",
        "bidivfut": "string",
        "bidivspt": "string",
        "ltpivfut": "string",
        "ltpivspt": "string",
        "ntTrdVal": "string",
        "mns": "string",
        "isMTFEnabled": false,
        "rchFlg": "string",
        "nwsFlg": "string",
        "rlOvrCst": "string",
        "rlOvrCstPrc": "string",
        "rlOvrPrc": "string",
        "bta": "string",
        "pe": "string",
        "mktCap": "string",
        "delta": "string",
        "gamma": "string",
        "theta": "string",
        "vega": "string",
        "idxFutTrdSym": "string",
        "dpVal": "string",
        "pcr": "string",
        "pdVal": "string",
        "bas": "string",
        "qty": "string",
        "avgByPrc": "string",
        "avgSlPrc": "string",
        "urlzPL": "string",
        "dyGn": "string",
        "invVal": "string",
        "ttlPL": "string",
        "dpUnit": "string"
      }
    ],
    "smry": {
      "stkCnt": "string",
      "asOfDt": "string",
      "der": {
        "invVal": "string",
        "curVal": "string",
        "unRlGL": "string",
        "dayGL": "string"
      }
    }
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» stkLst
            []
            false
            none
            none
          

          

            »» smry
            
            false
            none
            none
          

        
      

      
ComPortfolioSummaryDao

      

        
        
        
      

      
{
  "stkCnt": "string",
  "asOfDt": "string",
  "der": {
    "invVal": "string",
    "curVal": "string",
    "unRlGL": "string",
    "dayGL": "string"
  }
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            stkCnt
            string
            false
            none
            none
          

          

            asOfDt
            string
            false
            none
            none
          

          

            der
            
            false
            none
            none
          

        
      

      
ComPortfolioSummaryDataDao

      

        
        
        
      

      
{
  "invVal": "string",
  "curVal": "string",
  "unRlGL": "string",
  "dayGL": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            invVal
            string
            false
            none
            none
          

          

            curVal
            string
            false
            none
            none
          

          

            unRlGL
            string
            false
            none
            none
          

          

            dayGL
            string
            false
            none
            none
          

        
      

      
CommPortfolioScrip

      

        
        
        
      

      
{
  "trdSym": "string",
  "sym": "string",
  "asTyp": "string",
  "yrLw": "string",
  "yrH": "string",
  "o": "string",
  "h": "string",
  "l": "string",
  "c": "string",
  "ltp": "string",
  "ltt": "string",
  "altt": "string",
  "lut": "string",
  "atp": "string",
  "bidPr": "string",
  "askPr": "string",
  "vol": "string",
  "loCt": "string",
  "hiCt": "string",
  "chg": "string",
  "chgP": "string",
  "ltSz": "string",
  "tkSz": "string",
  "dpNm": "string",
  "stkPrc": "string",
  "opTyp": "string",
  "exp": "string",
  "desc": "string",
  "exc": "string",
  "brdLotQty": "string",
  "qtyUnits": "string",
  "prcUnits": "string",
  "prcQtn": "string",
  "dpInsTyp": "string",
  "bdSz": "string",
  "akSz": "string",
  "dpExpDt": "string",
  "opInt": "string",
  "opIntChg": "string",
  "opIntChgP": "string",
  "spotSym": "string",
  "spot": "string",
  "spotChg": "string",
  "spotChgP": "string",
  "rlOvrP": "string",
  "rlCAbs": "string",
  "ltTQty": "string",
  "tdrStDt": "string",
  "tdrEndDt": "string",
  "srpStDt": "string",
  "mxLtSz": "string",
  "trdInfoId": [
    "string"
  ],
  "ntByQty": "string",
  "ntSlQty": "string",
  "onewkhi": "string",
  "onewklo": "string",
  "onemnhi": "string",
  "onemnlo": "string",
  "thrmnhi": "string",
  "thrmnlo": "string",
  "alltmhi": "string",
  "alltmlo": "string",
  "askivfut": "string",
  "askivspt": "string",
  "bidivfut": "string",
  "bidivspt": "string",
  "ltpivfut": "string",
  "ltpivspt": "string",
  "ntTrdVal": "string",
  "mns": "string",
  "isMTFEnabled": false,
  "rchFlg": "string",
  "nwsFlg": "string",
  "rlOvrCst": "string",
  "rlOvrCstPrc": "string",
  "rlOvrPrc": "string",
  "bta": "string",
  "pe": "string",
  "mktCap": "string",
  "delta": "string",
  "gamma": "string",
  "theta": "string",
  "vega": "string",
  "idxFutTrdSym": "string",
  "dpVal": "string",
  "pcr": "string",
  "pdVal": "string",
  "bas": "string",
  "qty": "string",
  "avgByPrc": "string",
  "avgSlPrc": "string",
  "urlzPL": "string",
  "dyGn": "string",
  "invVal": "string",
  "ttlPL": "string",
  "dpUnit": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            trdSym
            string
            false
            none
            Trading Symbol
          

          

            sym
            string
            false
            none
            Streaming Symbol : unique identifier for MW
          

          

            asTyp
            string
            false
            none
            Asset type
          

          

            yrLw
            string
            false
            none
            Year low
          

          

            yrH
            string
            false
            none
            Year high
          

          

            o
            string
            false
            none
            Open price
          

          

            h
            string
            false
            none
            Day high
          

          

            l
            string
            false
            none
            Day low
          

          

            c
            string
            false
            none
            Day close
          

          

            ltp
            string
            false
            none
            Last traded price
          

          

            ltt
            string
            false
            none
            Last traded time
          

          

            altt
            string
            false
            none
            Actual Last traded time
          

          

            lut
            string
            false
            none
            Last updated time in Date Format
          

          

            atp
            string
            false
            none
            average traded price
          

          

            bidPr
            string
            false
            none
            Bid price
          

          

            askPr
            string
            false
            none
            Ask price
          

          

            vol
            string
            false
            none
            Vol
          

          

            loCt
            string
            false
            none
            Lower circuit price
          

          

            hiCt
            string
            false
            none
            Higher circuit price
          

          

            chg
            string
            false
            none
            change from previous close
          

          

            chgP
            string
            false
            none
            change percent from previous close
          

          

            ltSz
            string
            false
            none
            Lot size
          

          

            tkSz
            string
            false
            none
            Tick size
          

          

            dpNm
            string
            false
            none
            Display name
          

          

            stkPrc
            string
            false
            none
            Strike price
          

          

            opTyp
            string
            false
            none
            Option type
          

          

            exp
            string
            false
            none
            Expiry date of contract in milliseconds
          

          

            desc
            string
            false
            none
            Description for the scrip / contract
          

          

            exc
            string
            false
            none
            Exchange of the scrip / contract
          

          

            brdLotQty
            string
            false
            none
            Board lot quantity
          

          

            qtyUnits
            string
            false
            none
            Quantity units / deliver units
          

          

            prcUnits
            string
            false
            none
            prc units
          

          

            prcQtn
            string
            false
            none
            prc units
          

          

            dpInsTyp
            string
            false
            none
            Display instrument type
          

          

            bdSz
            string
            false
            none
            Bid size
          

          

            akSz
            string
            false
            none
            Ask size
          

          

            dpExpDt
            string
            false
            none
            Display expiry date
          

          

            opInt
            string
            false
            none
            Open interest
          

          

            opIntChg
            string
            false
            none
            Change in Open interest
          

          

            opIntChgP
            string
            false
            none
            Percentage Change in Open interest
          

          

            spotSym
            string
            false
            none
            Spot price of underlying
          

          

            spot
            string
            false
            none
            Spot price of underlying
          

          

            spotChg
            string
            false
            none
            Spot Change of underlying
          

          

            spotChgP
            string
            false
            none
            Spot Change Percent of underlying
          

          

            rlOvrP
            string
            false
            none
            Rollover percentage
          

          

            rlCAbs
            string
            false
            none
            Absolute Cost for Rollover
          

          

            ltTQty
            string
            false
            none
            Last traded quantity
          

          

            tdrStDt
            string
            false
            none
            Tender start date in epoch (milliseconds)
          

          

            tdrEndDt
            string
            false
            none
            Tender end date in epoch (milliseconds)
          

          

            srpStDt
            string
            false
            none
            Scrip start date in epoch (milliseconds)
          

          

            mxLtSz
            string
            false
            none
            Max Lot size
          

          

            trdInfoId
            [string]
            false
            none
            t2t text info
          

          

            ntByQty
            string
            false
            none
            Total Buy Quantity
          

          

            ntSlQty
            string
            false
            none
            Total Sell Quantity
          

          

            onewkhi
            string
            false
            none
            One Week High
          

          

            onewklo
            string
            false
            none
            One Week Low
          

          

            onemnhi
            string
            false
            none
            One month high
          

          

            onemnlo
            string
            false
            none
            one month low
          

          

            thrmnhi
            string
            false
            none
            Three months high
          

          

            thrmnlo
            string
            false
            none
            Three months low
          

          

            alltmhi
            string
            false
            none
            All time high
          

          

            alltmlo
            string
            false
            none
            All time low
          

          

            askivfut
            string
            false
            none
            Ask IV for future
          

          

            askivspt
            string
            false
            none
            Ask IV for spot
          

          

            bidivfut
            string
            false
            none
            Bid IV for future
          

          

            bidivspt
            string
            false
            none
            Bid IV for spot
          

          

            ltpivfut
            string
            false
            none
            Bid IV for future
          

          

            ltpivspt
            string
            false
            none
            Bid IV for spot
          

          

            ntTrdVal
            string
            false
            none
            Total traded value
          

          

            mns
            string
            false
            none
            Moneyness Type, note:this field might be null as well i.e the key may not come in the response
          

          

            isMTFEnabled
            boolean
            false
            none
            MTF flag
          

          

            rchFlg
            string
            false
            none
            Research Flag
          

          

            nwsFlg
            string
            false
            none
            News Flag
          

          

            rlOvrCst
            string
            false
            none
            Roll Over Cost , can be null
          

          

            rlOvrCstPrc
            string
            false
            none
            Roll Over Cost Percentage, can be null
          

          

            rlOvrPrc
            string
            false
            none
            Roll Over Percentage, can be null
          

          

            bta
            string
            false
            none
            Beta Value, can be null
          

          

            pe
            string
            false
            none
            PE value for for Equity, can be null
          

          

            mktCap
            string
            false
            none
            Market Cap value for Equity, can be null
          

          

            delta
            string
            false
            none
            delta
          

          

            gamma
            string
            false
            none
            gamma
          

          

            theta
            string
            false
            none
            theta
          

          

            vega
            string
            false
            none
            vega
          

          

            idxFutTrdSym
            string
            false
            none
            Nifty future's nearest expiry trading symbol
          

          

            dpVal
            string
            false
            none
            DP Value --> Original symbol-name
          

          

            pcr
            string
            false
            none
            PC Ratio
          

          

            pdVal
            string
            false
            none
            Prem/Disc Value
          

          

            bas
            string
            false
            none
            Prem/Disc
          

          

            qty
            string
            false
            none
            none
          

          

            avgByPrc
            string
            false
            none
            none
          

          

            avgSlPrc
            string
            false
            none
            none
          

          

            urlzPL
            string
            false
            none
            none
          

          

            dyGn
            string
            false
            none
            none
          

          

            invVal
            string
            false
            none
            none
          

          

            ttlPL
            string
            false
            none
            none
          

          

            dpUnit
            string
            false
            none
            none
          

        
      

      
ComRMSLimitsDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "lmt": {
      "lrB": "string",
      "colVal": "string",
      "piAmt": "string",
      "poAmt": "string",
      "lmAvl": "string",
      "mrUzd": "string"
    }
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» lmt
            
            false
            none
            none
          

        
      

      
ComRMSLimitsObject

      

        
        
        
      

      
{
  "lrB": "string",
  "colVal": "string",
  "piAmt": "string",
  "poAmt": "string",
  "lmAvl": "string",
  "mrUzd": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            lrB
            string
            false
            none
            none
          

          

            colVal
            string
            false
            none
            none
          

          

            piAmt
            string
            false
            none
            none
          

          

            poAmt
            string
            false
            none
            none
          

          

            lmAvl
            string
            false
            none
            none
          

          

            mrUzd
            string
            false
            none
            none
          

        
      

      
CommAMODao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "sts": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» sts
            string
            false
            none
            none
          

        
      

      
ComOrderBookDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "ord": [
      {
        "exc": "string",
        "ordID": "string",
        "nstReqID": "string",
        "trsTyp": "string",
        "trdSym": "string",
        "sym": "string",
        "srs": "string",
        "cpName": "string",
        "prc": "string",
        "avgPrc": "string",
        "ntQty": "string",
        "dsQty": "string",
        "flQty": "string",
        "trgPrc": "string",
        "exONo": "string",
        "sts": "string",
        "rjRsn": "string",
        "ordTyp": "LIMIT",
        "rcvTim": "string",
        "dur": "string",
        "vlDt": "string",
        "prdCode": "CNC",
        "ogt": "string",
        "sipID": "string",
        "userID": "string",
        "pdQty": "string",
        "desc": "string",
        "dpInsTyp": "string",
        "dpExpDt": "string",
        "stkPrc": "string",
        "opTyp": "string",
        "edit": "string",
        "cancel": "string",
        "exit": "string",
        "asTyp": "string",
        "tkSz": "string",
        "ltSz": "string",
        "isCOSecLeg": "string",
        "exp": "string",
        "dpName": "string",
        "qtyUnits": "string",
        "rcvEpTim": "string",
        "rmk": "string",
        "trgId": "string",
        "userCmnt": "string",
        "cta": "string",
        "ltp": "string"
      }
    ]
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» ord
            []
            false
            none
            none
          

        
      

      
ComTradeBookDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "trade": [
      {
        "exc": "string",
        "ordID": "string",
        "ordTyp": "LIMIT",
        "trsTyp": "string",
        "trdSym": "string",
        "sym": "string",
        "cpName": "string",
        "srs": "string",
        "dsQty": "string",
        "exONo": "string",
        "rcvTim": "string",
        "prdCode": "CNC",
        "flQty": "string",
        "qty": "string",
        "trdID": "string",
        "flPrc": "string",
        "ltp": "string",
        "chg": "string",
        "chgP": "string",
        "asTyp": "string",
        "dpInsTyp": "string",
        "dpExpDt": "string",
        "stkPrc": "string",
        "opTyp": "string",
        "psCnv": "string",
        "ntPrc": "string",
        "sts": "string",
        "tkSz": "string",
        "ltSz": "string",
        "dpName": "string",
        "exp": "string",
        "qtyUnits": "string",
        "rmk": "string"
      }
    ]
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» trade
            []
            false
            none
            none
          

        
      

      
ComPositionBookDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "pos": [
      {
        "exc": "string",
        "trdSym": "string",
        "sym": "string",
        "cpName": "string",
        "byQty": "string",
        "avgByPrc": "string",
        "byAmt": "string",
        "slQty": "string",
        "avgSlPrc": "string",
        "slAmt": "string",
        "ntAmt": "string",
        "ntQty": "string",
        "prdCode": "CNC",
        "rlzPL": "string",
        "urlzPL": "string",
        "mtm": "string",
        "ltp": "string",
        "dpExpDt": "string",
        "brkEvnPrc": "string",
        "dpInsTyp": "string",
        "opTyp": "string",
        "stkPrc": "string",
        "sqOff": "string",
        "asTyp": "string",
        "ntPL": "string",
        "tkSz": "string",
        "ltSz": "string",
        "mul": "string",
        "trsTyp": "string",
        "dpName": "string",
        "prc": "string",
        "rchFlg": "string",
        "nwsFlg": "string",
        "gn": "string",
        "gd": "string",
        "pn": "string",
        "pd": "string"
      }
    ],
    "ntMTM": "string",
    "tdyMtm": "string",
    "urlMtm": "string",
    "npos": "string",
    "opn": "string",
    "cls": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» pos
            []
            false
            none
            none
          

          

            »» ntMTM
            string
            false
            none
            none
          

          

            »» tdyMtm
            string
            false
            none
            none
          

          

            »» urlMtm
            string
            false
            none
            none
          

          

            »» npos
            string
            false
            none
            none
          

          

            »» opn
            string
            false
            none
            none
          

          

            »» cls
            string
            false
            none
            none
          

        
      

      
ComOrderBookResponseObject

      

        
        
        
      

      
{
  "exc": "string",
  "ordID": "string",
  "nstReqID": "string",
  "trsTyp": "string",
  "trdSym": "string",
  "sym": "string",
  "srs": "string",
  "cpName": "string",
  "prc": "string",
  "avgPrc": "string",
  "ntQty": "string",
  "dsQty": "string",
  "flQty": "string",
  "trgPrc": "string",
  "exONo": "string",
  "sts": "string",
  "rjRsn": "string",
  "ordTyp": "LIMIT",
  "rcvTim": "string",
  "dur": "string",
  "vlDt": "string",
  "prdCode": "CNC",
  "ogt": "string",
  "sipID": "string",
  "userID": "string",
  "pdQty": "string",
  "desc": "string",
  "dpInsTyp": "string",
  "dpExpDt": "string",
  "stkPrc": "string",
  "opTyp": "string",
  "edit": "string",
  "cancel": "string",
  "exit": "string",
  "asTyp": "string",
  "tkSz": "string",
  "ltSz": "string",
  "isCOSecLeg": "string",
  "exp": "string",
  "dpName": "string",
  "qtyUnits": "string",
  "rcvEpTim": "string",
  "rmk": "string",
  "trgId": "string",
  "userCmnt": "string",
  "cta": "string",
  "ltp": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            exc
            string
            false
            none
            none
          

          

            ordID
            string
            false
            none
            none
          

          

            nstReqID
            string
            false
            none
            none
          

          

            trsTyp
            string
            false
            none
            none
          

          

            trdSym
            string
            false
            none
            none
          

          

            sym
            string
            false
            none
            none
          

          

            srs
            string
            false
            none
            none
          

          

            cpName
            string
            false
            none
            none
          

          

            prc
            string
            false
            none
            none
          

          

            avgPrc
            string
            false
            none
            none
          

          

            ntQty
            string
            false
            none
            none
          

          

            dsQty
            string
            false
            none
            none
          

          

            flQty
            string
            false
            none
            none
          

          

            trgPrc
            string
            false
            none
            none
          

          

            exONo
            string
            false
            none
            none
          

          

            sts
            string
            false
            none
            none
          

          

            rjRsn
            string
            false
            none
            none
          

          

            ordTyp
            
            false
            none
            Order Type
          

          

            rcvTim
            string
            false
            none
            none
          

          

            dur
            string
            false
            none
            none
          

          

            vlDt
            string
            false
            none
            Order validity data -GTC/GTD
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            ogt
            string
            false
            none
            none
          

          

            sipID
            string
            false
            none
            none
          

          

            userID
            string
            false
            none
            none
          

          

            pdQty
            string
            false
            none
            none
          

          

            desc
            string
            false
            none
            none
          

          

            dpInsTyp
            string
            false
            none
            none
          

          

            dpExpDt
            string
            false
            none
            none
          

          

            stkPrc
            string
            false
            none
            none
          

          

            opTyp
            string
            false
            none
            none
          

          

            edit
            string
            false
            none
            none
          

          

            cancel
            string
            false
            none
            none
          

          

            exit
            string
            false
            none
            none
          

          

            asTyp
            string
            false
            none
            none
          

          

            tkSz
            string
            false
            none
            none
          

          

            ltSz
            string
            false
            none
            none
          

          

            isCOSecLeg
            string
            false
            none
            none
          

          

            exp
            string
            false
            none
            none
          

          

            dpName
            string
            false
            none
            none
          

          

            qtyUnits
            string
            false
            none
            none
          

          

            rcvEpTim
            string
            false
            none
            none
          

          

            rmk
            string
            false
            none
            none
          

          

            trgId
            string
            false
            none
            Trigger ID
          

          

            userCmnt
            string
            false
            none
            Comment added by user while placing the order
          

          

            cta
            string
            false
            none
            Call to action based on rejection reason
          

          

            ltp
            string
            false
            none
            Last Traded Price
          

        
      

      
ComTradeBookResponseObject

      

        
        
        
      

      
{
  "exc": "string",
  "ordID": "string",
  "ordTyp": "LIMIT",
  "trsTyp": "string",
  "trdSym": "string",
  "sym": "string",
  "cpName": "string",
  "srs": "string",
  "dsQty": "string",
  "exONo": "string",
  "rcvTim": "string",
  "prdCode": "CNC",
  "flQty": "string",
  "qty": "string",
  "trdID": "string",
  "flPrc": "string",
  "ltp": "string",
  "chg": "string",
  "chgP": "string",
  "asTyp": "string",
  "dpInsTyp": "string",
  "dpExpDt": "string",
  "stkPrc": "string",
  "opTyp": "string",
  "psCnv": "string",
  "ntPrc": "string",
  "sts": "string",
  "tkSz": "string",
  "ltSz": "string",
  "dpName": "string",
  "exp": "string",
  "qtyUnits": "string",
  "rmk": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            exc
            string
            false
            none
            none
          

          

            ordID
            string
            false
            none
            none
          

          

            ordTyp
            
            false
            none
            Order Type
          

          

            trsTyp
            string
            false
            none
            none
          

          

            trdSym
            string
            false
            none
            none
          

          

            sym
            string
            false
            none
            none
          

          

            cpName
            string
            false
            none
            none
          

          

            srs
            string
            false
            none
            none
          

          

            dsQty
            string
            false
            none
            none
          

          

            exONo
            string
            false
            none
            none
          

          

            rcvTim
            string
            false
            none
            none
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            flQty
            string
            false
            none
            none
          

          

            qty
            string
            false
            none
            none
          

          

            trdID
            string
            false
            none
            none
          

          

            flPrc
            string
            false
            none
            none
          

          

            ltp
            string
            false
            none
            none
          

          

            chg
            string
            false
            none
            none
          

          

            chgP
            string
            false
            none
            none
          

          

            asTyp
            string
            false
            none
            none
          

          

            dpInsTyp
            string
            false
            none
            none
          

          

            dpExpDt
            string
            false
            none
            none
          

          

            stkPrc
            string
            false
            none
            none
          

          

            opTyp
            string
            false
            none
            none
          

          

            psCnv
            string
            false
            none
            none
          

          

            ntPrc
            string
            false
            none
            none
          

          

            sts
            string
            false
            none
            none
          

          

            tkSz
            string
            false
            none
            none
          

          

            ltSz
            string
            false
            none
            none
          

          

            dpName
            string
            false
            none
            none
          

          

            exp
            string
            false
            none
            none
          

          

            qtyUnits
            string
            false
            none
            none
          

          

            rmk
            string
            false
            none
            none
          

        
      

      
ComPositionBookObject

      

        
        
        
      

      
{
  "exc": "string",
  "trdSym": "string",
  "sym": "string",
  "cpName": "string",
  "byQty": "string",
  "avgByPrc": "string",
  "byAmt": "string",
  "slQty": "string",
  "avgSlPrc": "string",
  "slAmt": "string",
  "ntAmt": "string",
  "ntQty": "string",
  "prdCode": "CNC",
  "rlzPL": "string",
  "urlzPL": "string",
  "mtm": "string",
  "ltp": "string",
  "dpExpDt": "string",
  "brkEvnPrc": "string",
  "dpInsTyp": "string",
  "opTyp": "string",
  "stkPrc": "string",
  "sqOff": "string",
  "asTyp": "string",
  "ntPL": "string",
  "tkSz": "string",
  "ltSz": "string",
  "mul": "string",
  "trsTyp": "string",
  "dpName": "string",
  "prc": "string",
  "rchFlg": "string",
  "nwsFlg": "string",
  "gn": "string",
  "gd": "string",
  "pn": "string",
  "pd": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            exc
            string
            false
            none
            none
          

          

            trdSym
            string
            false
            none
            none
          

          

            sym
            string
            false
            none
            none
          

          

            cpName
            string
            false
            none
            none
          

          

            byQty
            string
            false
            none
            none
          

          

            avgByPrc
            string
            false
            none
            none
          

          

            byAmt
            string
            false
            none
            none
          

          

            slQty
            string
            false
            none
            none
          

          

            avgSlPrc
            string
            false
            none
            none
          

          

            slAmt
            string
            false
            none
            none
          

          

            ntAmt
            string
            false
            none
            none
          

          

            ntQty
            string
            false
            none
            none
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            rlzPL
            string
            false
            none
            none
          

          

            urlzPL
            string
            false
            none
            none
          

          

            mtm
            string
            false
            none
            none
          

          

            ltp
            string
            false
            none
            none
          

          

            dpExpDt
            string
            false
            none
            none
          

          

            brkEvnPrc
            string
            false
            none
            none
          

          

            dpInsTyp
            string
            false
            none
            none
          

          

            opTyp
            string
            false
            none
            none
          

          

            stkPrc
            string
            false
            none
            none
          

          

            sqOff
            string
            false
            none
            none
          

          

            asTyp
            string
            false
            none
            none
          

          

            ntPL
            string
            false
            none
            none
          

          

            tkSz
            string
            false
            none
            none
          

          

            ltSz
            string
            false
            none
            none
          

          

            mul
            string
            false
            none
            none
          

          

            trsTyp
            string
            false
            none
            none
          

          

            dpName
            string
            false
            none
            none
          

          

            prc
            string
            false
            none
            none
          

          

            rchFlg
            string
            false
            none
            none
          

          

            nwsFlg
            string
            false
            none
            none
          

          

            gn
            string
            false
            none
            none
          

          

            gd
            string
            false
            none
            none
          

          

            pn
            string
            false
            none
            none
          

          

            pd
            string
            false
            none
            none
          

        
      

      
ConvertPositionDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "msg": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» msg
            string
            false
            none
            none
          

        
      

      
MFTradeRequestDao

      

        
        
        
      

      
{
  "currentOrdSts": "ACCEPTED",
  "token": "string",
  "isin": "string",
  "txnTyp": "string",
  "clientCode": "string",
  "qty": 0,
  "amt": 0,
  "reInvFlg": "string",
  "reqstdBy": "string",
  "folioNo": "string",
  "ordTyp": "string",
  "txnId": 0,
  "schemeName": "string",
  "rmrk": "string",
  "mnRdmFlg": "string",
  "ordSrc": "string",
  "strtDy": 0,
  "strtDt": "string",
  "endDt": "string",
  "sipFrq": "string",
  "gfot": "string",
  "tnr": "string",
  "mdtId": "string",
  "sipregno": "string",
  "siporderno": "string",
  "schemePlan": "Direct",
  "schemeCode": "schemeCode",
  "closeAccountFlag": "string",
  "kycflag": "string",
  "dpc": "string",
  "euinflag": "string",
  "euinnumber": "string",
  "physicalFlag": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            currentOrdSts
            string
            false
            none
            Order Status in case of Modify or Cancel
          

          

            token
            string
            false
            none
            Token of scheme
          

          

            isin
            string
            false
            none
            ISIN of scheme
          

          

            txnTyp
            string
            false
            none
            FP – Fresh Purchase AP – Additional Purchase R – Redemption SIP – SIP XSIP - XSIP
          

          

            clientCode
            string
            false
            none
            Client code of user, mandatory for GPS
          

          

            qty
            number(double)
            false
            none
            Units to redeem
          

          

            amt
            number(double)
            false
            none
            for Fresh Purchase/ Additional Purchase/ SIP/XSIP/ISIP
          

          

            reInvFlg
            string
            false
            none
            Z- Growth Y- Div Reinvest N- Div Payout
          

          

            reqstdBy
            string
            false
            none
            DealerCode/Clientcode
          

          

            folioNo
            string
            false
            none
            Blank for Fresh Purchase For Redeem/Additional Purchase/ SWITCH
 For physical Order Type
              Mandatory,For Demat On mandatory		
          

          

            ordTyp
            string
            false
            none
            Order type : Fresh, Modify or Cancel
          

          

            txnId
            integer(int64)
            false
            none
            0 for New Order ,OrderID for Modify ,Order OrderID for Cancel Order
          

          

            schemeName
            string
            false
            none
            Scheme Name
          

          

            rmrk
            string
            false
            none
            remarks
          

          

            mnRdmFlg
            string
            false
            none
            Y/N (Y- for Full Redeem)
          

          

            ordSrc
            string
            false
            none
            WEB/EMT/Admin
          

          

            strtDy
            integer(int32)
            false
            none
            For SIP/XSIP - 09 (DAY of SIP Start Date) Mandatory for SIP/ISIP/XSIP/SWP/STP
          

          

            strtDt
            string
            false
            none
            SIP / XSIP/ISIP/STP/SWP Start Date (Mandatory for SIP/ISIP/XSIP/SWP/STP)
          

          

            endDt
            string
            false
            none
            SIP / XSIP/ISIP/STP/SWP Start Date (Mandatory for SIP/ISIP/XSIP/SWP/STP)
          

          

            sipFrq
            string
            false
            none
            Monthly – (SIP/ XSIP/ISIP/STP/SWP Frequency Mandatory for SIP/ISIP/XSIP/SWP/STP)
          

          

            gfot
            string
            false
            none
            Y/N – (Genrate first order today Mandatory for SIP/ISIP/XSIP/SWP/STP)
          

          

            tnr
            string
            false
            none
            Tenure Period Like 99 Mandatory for SIP/ISIP/XSIP/SWP/STP
          

          

            mdtId
            string
            false
            none
            Mandate id selected by client
          

          

            sipregno
            string
            false
            none
            SIP Registration Number
          

          

            siporderno
            string
            false
            none
            SIP Order Number
          

          

            schemePlan
            string
            false
            none
            Scheme Plan
          

          

            schemeCode
            string
            false
            none
            Scheme Code
          

          

            closeAccountFlag
            string
            false
            none
            none
          

          

            kycflag
            string
            false
            none
            none
          

          

            dpc
            string
            false
            none
            none
          

          

            euinflag
            string
            false
            none
            none
          

          

            euinnumber
            string
            false
            none
            none
          

          

            physicalFlag
            string
            false
            none
            none
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            currentOrdSts
            ACCEPTED
          

          

            currentOrdSts
            REJECTED
          

          

            currentOrdSts
            CANCELLED
          

          

            currentOrdSts
            AMO ...
          

          

            schemePlan
            Direct
          

          

            schemePlan
            Normal
          

          

            schemeCode
            schemeCode
          

        
      

      
TradeMFResponseDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "ordNo": "string",
    "msg": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» ordNo
            string
            false
            none
            Order number of the order created / edited
          

          

            »» msg
            string
            false
            none
            Message to be displayed to client
          

        
      

      
MFHoldingsResponseDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "type": "string",
    "mfHdgUsable": [
      {
        "nav": "string",
        "hdgVl": "string",
        "scName": "string",
        "sym": "string",
        "isin": "string",
        "srs": "string",
        "symName": "string",
        "usdQty": "string",
        "ct": "string",
        "prdCode": "CNC",
        "amc": "string",
        "hdgQty": "string",
        "trdSym": "string",
        "folioID": "string",
        "units": 0,
        "amount": 0,
        "mode": "string",
        "physHldQty": [
          {
            "units": 0,
            "folioNo": "string"
          }
        ]
      }
    ],
    "usableHld": "string",
    "nonUsable": [
      {
        "category": "string",
        "amc": "string",
        "companyName": "string",
        "pledgQty": "string",
        "lockedInQty": "string",
        "ltp": "string",
        "holdingValue": "string",
        "assetClass": "string",
        "isin": "string"
      }
    ],
    "nonUsableHld": "string",
    "mfHV": "string"
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» type
            string
            false
            none
            none
          

          

            »» mfHdgUsable
            []
            false
            none
            List of Usable holdings
          

          

            »» usableHld
            string
            false
            none
            Total holding value of usable holdings
          

          

            »» nonUsable
            []
            false
            none
            List of Non Usable holdings
          

          

            »» nonUsableHld
            string
            false
            none
            Total non usable holdings
          

          

            »» mfHV
            string
            false
            none
            Total mf holdings value
          

        
      

      
ReconciliationRespDao

      

        
        
        
      

      
{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "ordLst": [
      {
        "txnID": "string",
        "clientID": "string",
        "schemeID": "string",
        "txnType": "string",
        "units": "string",
        "amount": "string",
        "closeAccountFlag": "string",
        "reinvestmentFlag": "string",
        "toSchemeID": "string",
        "isNFO": false,
        "txnDate": "string",
        "txnTime": "string",
        "folioNo": "string",
        "checkDigNo": "string",
        "redPyMec": "string",
        "status": "string",
        "fileGeneratedFreq": "string",
        "remarks": "string",
        "orderedBy": "string",
        "lastModifiedBy": "string",
        "lastModifiedOn": "string",
        "sysRefNo": "string",
        "referenceNO": "string",
        "token": "string",
        "schemeCode": "string",
        "rnTSchemeCode": "string",
        "inBatchID": "string",
        "inSubBatchID": "string",
        "physicalFlag": "string",
        "minRedeemFlag": "string",
        "redeemDate": "string",
        "redeemAmount": "string",
        "vcOrderRemarks": "string",
        "clientCode": "string",
        "isSpread": "string",
        "orderSource": "string",
        "startDay": "string",
        "startDate": "string",
        "endDate": "string",
        "genrateToday": "string",
        "tenure": "string",
        "mandateID": "string",
        "brokerage": "string",
        "switchSchemeCode": "string",
        "switchISIN": "string",
        "createdBy": "string",
        "createdOn": "string",
        "exchangeRefNo": "string",
        "mode": "string",
        "validateMargin": "string",
        "brokerRefNo": "string",
        "limitValidation": "string",
        "checkHoldings": "string",
        "modelPortFolioName": "string",
        "orderType": "string",
        "uniqueNumber": "string",
        "subBrokerCode": "string",
        "paymentMode": "string",
        "mandateSts": "string",
        "ordStatus": "string",
        "isModify": false,
        "isCancel": false,
        "schemeName": "string",
        "isin": "string",
        "nav": 0,
        "sipfrequency": "string",
        "dpc": "string",
        "euinflag": "string",
        "mfimfdflag": "string",
        "arn": "string",
        "euinnumber": "string",
        "settlementType": "string",
        "sipregDate": "string",
        "rmcode": "string",
        "navasNoDate": "string",
        "kycflag": "string",
        "amcschemeCode": "string",
        "amccode": "string"
      }
    ]
  }
}



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» ordLst
            []
            false
            none
            List of orders
          

        
      

      
DIONReportReconciliation

      

        
        
        
      

      
{
  "txnID": "string",
  "clientID": "string",
  "schemeID": "string",
  "txnType": "string",
  "units": "string",
  "amount": "string",
  "closeAccountFlag": "string",
  "reinvestmentFlag": "string",
  "toSchemeID": "string",
  "isNFO": false,
  "txnDate": "string",
  "txnTime": "string",
  "folioNo": "string",
  "checkDigNo": "string",
  "redPyMec": "string",
  "status": "string",
  "fileGeneratedFreq": "string",
  "remarks": "string",
  "orderedBy": "string",
  "lastModifiedBy": "string",
  "lastModifiedOn": "string",
  "sysRefNo": "string",
  "referenceNO": "string",
  "token": "string",
  "schemeCode": "string",
  "rnTSchemeCode": "string",
  "inBatchID": "string",
  "inSubBatchID": "string",
  "physicalFlag": "string",
  "minRedeemFlag": "string",
  "redeemDate": "string",
  "redeemAmount": "string",
  "vcOrderRemarks": "string",
  "clientCode": "string",
  "isSpread": "string",
  "orderSource": "string",
  "startDay": "string",
  "startDate": "string",
  "endDate": "string",
  "genrateToday": "string",
  "tenure": "string",
  "mandateID": "string",
  "brokerage": "string",
  "switchSchemeCode": "string",
  "switchISIN": "string",
  "createdBy": "string",
  "createdOn": "string",
  "exchangeRefNo": "string",
  "mode": "string",
  "validateMargin": "string",
  "brokerRefNo": "string",
  "limitValidation": "string",
  "checkHoldings": "string",
  "modelPortFolioName": "string",
  "orderType": "string",
  "uniqueNumber": "string",
  "subBrokerCode": "string",
  "paymentMode": "string",
  "mandateSts": "string",
  "ordStatus": "string",
  "isModify": false,
  "isCancel": false,
  "schemeName": "string",
  "isin": "string",
  "nav": 0,
  "sipfrequency": "string",
  "dpc": "string",
  "euinflag": "string",
  "mfimfdflag": "string",
  "arn": "string",
  "euinnumber": "string",
  "settlementType": "string",
  "sipregDate": "string",
  "rmcode": "string",
  "navasNoDate": "string",
  "kycflag": "string",
  "amcschemeCode": "string",
  "amccode": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            txnID
            string
            false
            none
            none
          

          

            clientID
            string
            false
            none
            none
          

          

            schemeID
            string
            false
            none
            none
          

          

            txnType
            string
            false
            none
            none
          

          

            units
            string
            false
            none
            none
          

          

            amount
            string
            false
            none
            none
          

          

            closeAccountFlag
            string
            false
            none
            none
          

          

            reinvestmentFlag
            string
            false
            none
            none
          

          

            toSchemeID
            string
            false
            none
            none
          

          

            isNFO
            boolean
            false
            none
            none
          

          

            txnDate
            string
            false
            none
            none
          

          

            txnTime
            string
            false
            none
            none
          

          

            folioNo
            string
            false
            none
            none
          

          

            checkDigNo
            string
            false
            none
            none
          

          

            redPyMec
            string
            false
            none
            none
          

          

            status
            string
            false
            none
            none
          

          

            fileGeneratedFreq
            string
            false
            none
            none
          

          

            remarks
            string
            false
            none
            none
          

          

            orderedBy
            string
            false
            none
            none
          

          

            lastModifiedBy
            string
            false
            none
            none
          

          

            lastModifiedOn
            string
            false
            none
            none
          

          

            sysRefNo
            string
            false
            none
            none
          

          

            referenceNO
            string
            false
            none
            none
          

          

            token
            string
            false
            none
            none
          

          

            schemeCode
            string
            false
            none
            none
          

          

            rnTSchemeCode
            string
            false
            none
            none
          

          

            inBatchID
            string
            false
            none
            none
          

          

            inSubBatchID
            string
            false
            none
            none
          

          

            physicalFlag
            string
            false
            none
            none
          

          

            minRedeemFlag
            string
            false
            none
            none
          

          

            redeemDate
            string
            false
            none
            none
          

          

            redeemAmount
            string
            false
            none
            none
          

          

            vcOrderRemarks
            string
            false
            none
            none
          

          

            clientCode
            string
            false
            none
            none
          

          

            isSpread
            string
            false
            none
            none
          

          

            orderSource
            string
            false
            none
            none
          

          

            startDay
            string
            false
            none
            none
          

          

            startDate
            string
            false
            none
            none
          

          

            endDate
            string
            false
            none
            none
          

          

            genrateToday
            string
            false
            none
            none
          

          

            tenure
            string
            false
            none
            none
          

          

            mandateID
            string
            false
            none
            none
          

          

            brokerage
            string
            false
            none
            none
          

          

            switchSchemeCode
            string
            false
            none
            none
          

          

            switchISIN
            string
            false
            none
            none
          

          

            createdBy
            string
            false
            none
            none
          

          

            createdOn
            string
            false
            none
            none
          

          

            exchangeRefNo
            string
            false
            none
            none
          

          

            mode
            string
            false
            none
            none
          

          

            validateMargin
            string
            false
            none
            none
          

          

            brokerRefNo
            string
            false
            none
            none
          

          

            limitValidation
            string
            false
            none
            none
          

          

            checkHoldings
            string
            false
            none
            none
          

          

            modelPortFolioName
            string
            false
            none
            none
          

          

            orderType
            string
            false
            none
            none
          

          

            uniqueNumber
            string
            false
            none
            none
          

          

            subBrokerCode
            string
            false
            none
            none
          

          

            paymentMode
            string
            false
            none
            none
          

          

            mandateSts
            string
            false
            none
            none
          

          

            ordStatus
            string
            false
            none
            none
          

          

            isModify
            boolean
            false
            none
            Is modifiable True/False
          

          

            isCancel
            boolean
            false
            none
            Is cancellable True/False
          

          

            schemeName
            string
            false
            none
            schemeName
          

          

            isin
            string
            false
            none
            none
          

          

            nav
            number(double)
            false
            none
            none
          

          

            sipfrequency
            string
            false
            none
            none
          

          

            dpc
            string
            false
            none
            none
          

          

            euinflag
            string
            false
            none
            none
          

          

            mfimfdflag
            string
            false
            none
            none
          

          

            arn
            string
            false
            none
            none
          

          

            euinnumber
            string
            false
            none
            none
          

          

            settlementType
            string
            false
            none
            none
          

          

            sipregDate
            string
            false
            none
            none
          

          

            rmcode
            string
            false
            none
            none
          

          

            navasNoDate
            string
            false
            none
            none
          

          

            kycflag
            string
            false
            none
            none
          

          

            amcschemeCode
            string
            false
            none
            none
          

          

            amccode
            string
            false
            none
            none
          

        
      

      
MFSSHoldingsObject

      

        
        
        
      

      
{
  "nav": "string",
  "hdgVl": "string",
  "scName": "string",
  "sym": "string",
  "isin": "string",
  "srs": "string",
  "symName": "string",
  "usdQty": "string",
  "ct": "string",
  "prdCode": "CNC",
  "amc": "string",
  "hdgQty": "string",
  "trdSym": "string",
  "folioID": "string",
  "units": 0,
  "amount": 0,
  "mode": "string",
  "physHldQty": [
    {
      "units": 0,
      "folioNo": "string"
    }
  ]
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            nav
            string
            false
            none
            none
          

          

            hdgVl
            string
            false
            none
            none
          

          

            scName
            string
            false
            none
            none
          

          

            sym
            string
            false
            none
            none
          

          

            isin
            string
            false
            none
            none
          

          

            srs
            string
            false
            none
            none
          

          

            symName
            string
            false
            none
            none
          

          

            usdQty
            string
            false
            none
            none
          

          

            ct
            string
            false
            none
            none
          

          

            prdCode
            
            false
            none
            Margin product to use for the order (margins are blocked based on this), CNC/MIS/NRML/MTF/CO/BO
          

          

            amc
            string
            false
            none
            none
          

          

            hdgQty
            string
            false
            none
            none
          

          

            trdSym
            string
            false
            none
            none
          

          

            folioID
            string
            false
            none
            none
          

          

            units
            number(double)
            false
            none
            none
          

          

            amount
            number(double)
            false
            none
            none
          

          

            mode
            string
            false
            none
            none
          

          

            physHldQty
            []
            false
            none
            Physical Holdings Quantity
          

        
      

      
ELSSReportIndividualHoldings

      

        
        
        
      

      
{
  "category": "string",
  "amc": "string",
  "companyName": "string",
  "pledgQty": "string",
  "lockedInQty": "string",
  "ltp": "string",
  "holdingValue": "string",
  "assetClass": "string",
  "isin": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            category
            string
            false
            none
            none
          

          

            amc
            string
            false
            none
            none
          

          

            companyName
            string
            false
            none
            none
          

          

            pledgQty
            string
            false
            none
            none
          

          

            lockedInQty
            string
            false
            none
            none
          

          

            ltp
            string
            false
            none
            none
          

          

            holdingValue
            string
            false
            none
            none
          

          

            assetClass
            string
            false
            none
            none
          

          

            isin
            string
            false
            none
            none
          

        
      

      
PhysicalHoldingsQty

      

        
        
        
      

      
{
  "units": 0,
  "folioNo": "string"
}



      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            units
            number(double)
            false
            none
            none
          

          

            folioNo
            string
            false
            none
            none
          

        
      

  

      
Changelog

      
      
Python

      
All notable changes to this project will be documented in this file.


      
[2.0.11] - 2026-03-30 

      
Added

      
    
          
  • 2 New fields added to the orderbook and orderdetails APIs
    • 
      

      
Changed

      
    
          
  • API usage threshold
    • 
          
  • Static IP Mandatory
    • 
      

      
Removed

      
    
          
  • Removed Bracket Orders API
    • 
          
  • Removed Basket Orders API
    • 
      


      
[2.0.10] - 2026-01-11 

      
Changed

      
    
          
  • Removed commodity specific APIs
    • 
          
  • Now trade APIs are common for both commodity and equity
    • 
          
  • AMOFLAG API URL has been changed
    • 
      


      
[2.0.8] - 2024-06-28 

      
Added

      
    
          
  • Bug Fixes
    • 
      


      
[2.0.7] - 2024-03-18 

      
Added

      
    
          
  • Added exchange segment : BFO
    • 
      


      
[2.0.5] - 2023-12-29 

      
Added

      
    
          
  • Transaction History
    • 
      


      
[2.0.4] - 2023-11-03 

      
Added

      
    
          
  • Order slicing
    • 
          
  • PIT IRF
    • 
      

      
Changed

      
    
        
  • Request structure of Position square off api in equity segment
    • 
        
  • Response structure of Place trade (including amo) api in equity segment has changed for order which are getting sliced
    • 
        
  • Response structure of Modify trade (including amo) api in equity segment has changed for order which are getting sliced
    • 
        
  • Request structure of Modify trade (including amo) api in equity segment
    • 
        
  • Request structure of cancel trade (including amo) api in equity segment
    • 
      


      
[2.0.3] - 2023-07-28 

      
Added

      
    
          
  • MiniQuote Feed
    • 
          
  • Market Depth Feed and API
    • 
          
  • New Price Feed (reduced quote feed in human readable format)
    • 
          
  • Bug Fixes
    • 
      

      
Note

      
    
        
  • We shall keep existing price feed for some days so as to ensure smooth transition from the existing to the newer one
    • 
      


      
[2.0.2] - 2023-05-20 

      
Added

      
    
          
  • Commodity changes
    • 
          
  • Bug Fixes
    • 
      

      
Changed

      
    
        
  • Discontinuation of Reasearch calls
    • 
        
  • Changes in the Logout , ConvertPosition and AmoFlag API's
    • 
      

          
      
[2.0.0] - 2022-12-16 

      
Added

      
    
          
  • Added Live News Streaming feature
    • 
      

      
Changed

      
    
        
  • In view of brand name change from Edelweiss to nuvama, necessary changes were made in accordance.
    • 
        
  • Now Streamers would work after login only.
    • 
        
  • Code changes for calling Streamers subscribe and unsubscribe calls.
    • 
        

      

      
[1.0.3] - 2022-08-30 

      
Added

      
    
        
  • Added charting feature for NSE, BSE, NFO, CDS, MCX, NCDEX and INDEX exchanges 
    • 
        
  • Added Live News feature
    • 
        
  • Added Research Calls feature for Equity, Currency and Futures and Options  
    • 
        
  • Added Watchlist feature  
    • 
        
      

      
Changed

      
    
        
  • Most features now expect inputs as enums. Below methods will be impacted by this – PlaceTrade, ModifyTrade PlaceCoverTrade, PlaceBracketTrade, ModifyCoverTrade, PlaceGtcGtdTrade, CancelTrade, ConvertPosition, PlaceAMOTrade, ModifyAMOTrade, CancelAMOTrade, OrderDetails . Please refer to code examples in documentation for more details. 
    • 
        
  • PlaceBasketTrade and PositionSquareOff methods now take as input a list of instances of Order class. Please refer to code examples for more details.  
    • 
        
  • Feed class is now located in feed module. Please refer to code examples for more details. 
    • 
        

      
      

      
[1.0.2] - 2021-07-29 

      
Added

      
    
        
        
  • Added support for commodity trading with MCX and NCDEX exchanges
    • 
        
  • Added support for enabling proxy 
    • 
        
  • Added Logging functionality to library with configurable logging levels
    • 
        
  • Added configuration file for user configurable settings related to logging, proxy and streaming
    • 
      

      
Changed

      
    
        
        
  • APIConnect class will now take an additional input parameter 'conf' - path for
          configuration file
    • 
        
  • All responses will now be returned as JSON object
    • 
        
  • Most responses will now have a format of {"eq":...,"comm":...}, "eq" will
          contain details for NSE/BSE exchanges, whereas "comm" will relate to MCX/NCDEX. Check method
          responses in documentation for more details.
          Below methods will be impacted by this change - OrderBook, TradeBook, NetPosition, OrderHistory, Holdings,
          Limits and GetAMOStatus
          

        
    • 
        
  • OrderDetails will now have an additional input parameter for Exchange e.g. NSE, BSE, MCX or NCDEX
    • 
        
  • PlaceGtcGtdTrade will now have an additional input parameter for Streaming_Symbol
    • 
        
  • CancelTrade will now have additional input parameters for Exchange, Order_Type and Product_Code
    • 
        
  • CancelAMOTrade will now have additional input parameters for Exchange, Order_Type and Product_Code
    • 
        
  • ConvertPosition will now have additional input parameters for Exchange and Order_Type
    • 
        
  • PlaceMF will now have an additional input parameter for Mandate_Id
    • 
        
  • ModifyMF will now have an additional input parameter for Mandate_Id
    • 
        
  • Feed class will now take only three parameters accid, userid, 'conf' - path for configuration file
        
    • 
        
  • Feed class has new method 'subscribe', check documentation for details
    • 
      

      
     
      

      
      
Node

      
All notable changes to this project will be documented in this file.



      
[2.0.15] - 2026-03-30 

      
Added

      
    
          
  • 2 New fields added to the orderbook and orderdetails APIs
    • 
      

      
Changed

      
    
          
  • API usage threshold
    • 
          
  • Static IP Mandatory
    • 
      

      
Removed

      
    
          
  • Removed Bracket Orders API
    • 
          
  • Removed Basket Orders API
    • 
      


      
[2.0.14] - 2026-01-11 

      
Changed

      
    
          
  • Removed commodity specific APIs
    • 
          
  • Now trade APIs are common for both commodity and equity
    • 
          
  • AMOFLAG API URL has been changed
    • 
      


      
[2.0.12] - 2024-03-18 

      
Added

      
    
          
  • Added exchange segment : BFO
    • 
      


      
[2.0.11] - 2023-12-29 

      
Added

      
    
          
  • Transaction History
    • 
      


      
[2.0.10] - 2023-11-03 

      
Added

      
    
          
  • Order slicing
    • 
          
  • PIT IRF
    • 
      

      
Changed

      
    
        
  • Request structure of Position square off api in equity segment
    • 
        
  • Response structure of Place trade (including amo) api in equity segment has changed for order which are getting sliced
    • 
        
  • Response structure of Modify trade (including amo) api in equity segment has changed for order which are getting sliced
    • 
        
  • Request structure of Modify trade (including amo) api in equity segment
    • 
        
  • Request structure of cancel trade (including amo) api in equity segment
    • 
      


      
[2.0.5] - 2023-07-28 

      
Added

      
    
          
  • MiniQuote Feed
    • 
          
  • Market Depth Feed and API
    • 
          
  • New Price Feed (reduced quote feed in human readable format)
    • 
          
  • Bug Fixes
    • 
      

      
Note

      
    
        
  • We shall keep existing price feed for some days so as to ensure smooth transition from the existing to the newer one
    • 
      


      
[2.0.4] - 2023-05-20 

      
Added

      
    
          
  • Commodity changes
    • 
          
  • Bug Fixes
    • 
      

      
Changed

      
    
        
  • Discontinuation of Reasearch calls
    • 
        
  • Changes in the Logout , ConvertPosition and AmoFlag API's
    • 
      

      
      
[2.0.0] - 2022-12-16 

      
Added

      
    
          
  • Added Live News Streaming feature
    • 
      

      
Changed

      
    
        
  • In view of brand name change from to Nuvama, necessary changes were made in accordance to class names. Please refer to code examples in documentation for more details.
    • 
        
  • Streaming now requires to go through login flow.
    • 
        
  • Code changes for calling Streamers subscribe and unsubscribe calls. Please refer to code examples in documentation for more details.
    • 
        

      


      
[1.0.1] - 2022-08-30

      
Added

      
    
        
  • Added Charts Feature.
    • 
        
  • Added Live News Feature.
    • 
        
  • Added Research Calls Feature.
    • 
        
  • Added Watchlist Feature.
    • 
      

      
Changed

      
    
        
  • PlaceMF will now have an additional input parameter for Mandate_Id
    • 
        
  • ModifyMF will now have an additional input parameter for Mandate_Id
    • 
      

      

      
      
Java

      
All notable changes to this project will be documented in this file.



      
[2.0.10] - 2026-03-30 

      
Added

      
    
          
  • 2 New fields added to the orderbook and orderdetails APIs
    • 
      

      
Changed

      
    
          
  • API usage threshold
    • 
          
  • Static IP Mandatory
    • 
      

      
Removed

      
    
          
  • Removed Bracket Orders API
    • 2
          
  • Removed Basket Orders API
    • 
      


      
[2.0.9] - 2026-01-11 

      
Changed

      
    
          
  • Removed commodity specific APIs
    • 
          
  • Now trade APIs are common for both commodity and equity
    • 
          
  • AMOFLAG API URL has been changed
    • 
      


      
[2.0.7] - 2024-06-28 

      
Added

      
    
          
  • Bug Fixes
    • 
      


      
[2.0.6] - 2024-03-18 

      
Added

      
    
          
  • Added exchange segment : BFO
    • 
      


      
[2.0.5] - 2023-12-29 

      
Added

      
    
          
  • Transaction History
    • 
      


      
[2.0.4] - 2023-11-03 

      
Added

      
    
          
  • Order slicing
    • 
          
  • PIT IRF
    • 
      

      
Changed

      
    
        
  • Request structure of Position square off api in equity segment
    • 
        
  • Response structure of Place trade (including amo) api in equity segment has changed for order which are getting sliced
    • 
        
  • Response structure of Modify trade (including amo) api in equity segment has changed for order which are getting sliced
    • 
        
  • Request structure of Modify trade (including amo) api in equity segment
    • 
        
  • Request structure of cancel trade (including amo) api in equity segment
    • 
      


      
[2.0.2] - 2023-07-28 

      
Added

      
    
          
  • MiniQuote Feed
    • 
          
  • Market Depth Feed and API
    • 
          
  • New Price Feed (reduced quote feed in human readable format)
    • 
          
  • Bug Fixes
    • 
      

      
Note

      
    
        
  • We shall keep existing price feed for some days so as to ensure smooth transition from the existing to the newer one
    • 
      


      
[2.0.1] - 2023-05-20 

      
Added

      
    
          
  • Commodity changes
    • 
          
  • Bug Fixes
    • 
      

      
Changed

      
    
        
  • Discontinuation of Reasearch calls
    • 
        
  • Changes in the Logout , ConvertPosition and AmoFlag API's
    • 
      


      
[2.0.0] - 2022-12-16 

      
Added

      
    
          
  • Added Live News Streaming feature
    • 
      

      
Changed

      
    
        
  • In view of brand name change from to Nuvama, necessary changes were made in accordance to class names. Please refer to code examples in documentation for more details.
    • 
        
  • Streaming now requires to go through login flow.
    • 
        
  • Code changes for calling Streamers subscribe and unsubscribe calls. Please refer to code examples in documentation for more details.
    • 
        

      


      
[1.0.1] - 2022-08-30

      
Added

      
    
        
  • Added Charts Feature.
    • 
        
  • Added Live News Feature.
    • 
      

      
Changed

      
    
        
  • PlaceMF will now have an additional input parameter for Mandate_Id
    • 
        
  • ModifyMF will now have an additional input parameter for Mandate_Id
    • 
      

      
   
    


    


      


        Node


        Python


        Java