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
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

JAVA library for Accessing the Services Provided by Nuvama

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, 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.

Java JDK :

  • API version: v1
  • JDK version: 1.8

Dependencies

Set up the project

First you’ll need to setup a Java project for Maven to build. Create this structure in a project folder.

Maven is downloadable as a zip file at https://maven.apache.org/download.cgi. Only the binaries are required, so look for the link to apache-maven-{version}-bin.zip or apache-maven-{version}-bin.tar.gz.

Build Java code

Maven is now ready to build the project. You can execute several build lifecycle goals with Maven now, including goals to compile the project’s code, create a library package (such as a JAR file), and install the library in the local Maven dependency repository.

mvn compile

This will run Maven, telling it to execute the compile goal. When it’s finished, you should find the compiled .class files in the target/classes directory.

Packaging

mvn package

The package goal will compile Java code, run any tests, and finish by packaging the code up in a JAR file within the target directory. The name of the JAR file will be based on the project’s artifactId and version.

To execute the JAR file run:

java -jar target/apiconnect-maven-0.1.0.jar

Installing 3rd party JARs

To install a JAR in the local repository use the following command:

mvn install:install-file -Dfile= -DgroupId= -DartifactId= -Dversion= -Dpackaging= If there's a pom-file as well, you can install it with the following command:

mvn install:install-file -Dfile= -DpomFile= With version 2.5 of the maven-install-plugin, it can get even simpler: if the JAR was built by Apache Maven, it'll contain a pom.xml in a subfolder of the META-INF/ directory, which will be read by default. In that case, all you need to do is:

mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile=

Configuration from external INI file

When using APIConnect wrapper ,various parameters are read from the Settings.ini file.These parameters are configurable. Description for these parameters is given below.

Parameters Description Remarks
[GLOBAL] Contains global configuration  
[LOG] Contains logging related configuration  
Level Log level key. DEBUG
[PROXY] Contains PROXY related configuration  
Host Hostname for proxy settings.
Port Port number for proxy settings.
User Username for proxy settings.
Pass Password for proxy settings.
[Stream] Contains Streaming related configuration  
Host Hostname for Streamer. ncst.nuvamawealth.com
Port Port number for Streamer. 9443

APIConnect documentation

Getting Started

#!Java using APIConnect # Redirect the user to the login url - <https://www.nuvamawealth.com/api-connect/login?api_key=xxx> # after the login flow, You will get requestId. # Generate a session with this request id # as follows. APIConnect connect = new APIConnect("apiKey", "api_secret_password", "requestId", True, "File_path_to_external_INI_file"); # Place an order String response = connect.PlaceTrade("trdSymbol", "exchange","action", "duration","orderType", "quantity","streamingSymbol", "limitPrice","dscQty", "trgPrc", "productCode"); # Fetch all orders connect.orderBook(); #Fetch all trades connect.tradeBook();

NodeJS library for Accessing the Services Provided by Nuvama

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, 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.

NodeJS SDK :

  • API version: v1

NodeJS supported

  • Node v14.17.6 or later

NodeJS Dependencies

We recommend using npm to install the latest version of the packages:

npm install ini npm install fs npm install readline npm install net npm install jszip npm install log4js

Installation

Run the following command to install node packages

npm install api_connect_nodejs

Configuration from external INI file

When using APIConnect wrapper ,various parameters are read from the Settings.ini file.These parameters are configurable. Description for these parameters is given below. This ini file has to be present inside of conf directory.

Parameters Description Remarks
[GLOBAL] Contains global configuration  
LogLevel Contains logging related configuration All
hostName Host address of streaming socket. ncst.nuvamawealth.com
port Port of streaming socket. 9443

APIConnect documentation

Getting Started

#!node const { APIConnect } = require("api_connect_nodejs"); # Redirect the user to the login url - <https://www.nuvamawealth.com/api-connect/login?api_key=xxx> # after the login flow, You will get requestId. # Generate a session with this request id # as follows. apiConnect = new APIConnect("apiKey", "api_secret_password", "requestId", 'true'); # Place an order apiConnect.Init().then(()=>{ response = apiConnect.PlaceTrade('symbol', 'exchange', 'buy-sell', validity', 'orderType', 'quantity', 'exchangeCode', 'limitPrice', 'productCode'); # Fetch all orders apiConnect.OrderBook(); #Fetch all trades apiConnect.TradeBook(); }).catch((err) => console.log("Init Failed"+err))

Python library for Accessing the Services Provided by Nuvama

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, 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.

Python SDK :

  • API version: v1

Python supported

  • Python 3.7 or later [with optional venv]

PyPi Dependencies

We recommend using pip to install the latest version of the packages:

pip install urllib3==1.26.6 pip install requests==2.26.0

For Specific version Installation:

pip install APIConnect==2.0.0

NOTE: It is recommend to install dependencies after activating virtual enviroment, to avoid conflicts between installed packages. Here you can find, How to create virtual enviroment?

Configuration from external INI file

When using APIConnect wrapper ,various parameters are read from the Settings.ini file.These parameters are configurable. Description for these parameters is given below.

Parameters Description Remarks
[GLOBAL] Contains global configuration  
LOG_LEVEL Contains logging related configuration DEBUG
LOG_FILE Absolute path to the logging file. apiconnect.log
[PROXY] Contains proxy related configuration  
HTTP_PROXY HTTP connection proxy URL.
HTTPS_PROXY HTTP connection proxy URL.
SSL_VERIFY SSL Verification. False
[STREAM] Streaming socket proxy related configuration  
HOST Host address of streaming socket. ncst.nuvamawealth.com
PORT Port of streaming socket. 9443

APIConnect documentation

Getting Started

#!python from APIConnect.APIConnect import APIConnect # Redirect the user to the login url - <https://www.nuvamawealth.com/api-connect/login?api_key=xxx> # after the login flow, You will get requestId. # Generate a session with this request id # as follows. api_connect = APIConnect("apiKey", "api_secret_password", "requestId", True, "File_path_to_external_INI_file"); # Place an order response = api_connect.PlaceTrade('symbol', 'exchange', 'buy-sell', validity', 'orderType', 'quantity', 'exchangeCode', 'limitPrice', 'productCode'); # Fetch all orders api_connect.OrderBook(); #Fetch all trades api_connect.TradeBook();

C# library for Accessing the Services Provided by Nuvama

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, 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.

C# SDK :

  • API version: v1
  • SDK version: 1.0.0

Frameworks supported

  • .NET 4.0 or later
  • Windows Phone 7.1 (Mango)

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp Install-Package Newtonsoft.Json Install-Package JsonSubTypes Install-Package ini-parser Install-Package log4net Install-Package NUnit3TestAdapter Install-Package NUnit

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using .Api; using .Client; using .Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out .csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Configuration from external INI file

When using APIConnect wrapper ,various parameters are read from the Settings.ini file.These parameters are configurable. Description for these parameters is given below.

Parameters Description Remarks
[GLOBAL] Contains global configuration  
[LOG] Contains logging related configuration  
LogLevel Contains logging related configuration DEBUG
LogFilePath Absolute path to the logging file.
[SERVER] Contains Streaming related configuration  
Server Host address of streaming socket. ncst.nuvamawealth.com
Port Port of streaming socket. 9443

APIConnect documentation

Getting Started

#!cSharp using APIConnect # Redirect the user to the login url - <https://www.nuvamawealth.com/api-connect/login?api_key=xxx> # after the login flow, You will get requestId. # Generate a session with this request id # as follows. apiConnect = new APIConnect("apiKey", "api_secret_password", "requestId", True, "File_path_to_external_INI_file"); # Place an order response = apiConnect.PlaceTrade('symbol', 'exchange', 'buy-sell', validity', 'orderType', 'quantity', 'exchangeCode', 'limitPrice', 'productCode'); # Fetch all orders apiConnect.OrderBook(); #Fetch all trades apiConnect.TradeBook();

Authentication

Common-Login

User's Phone and Email API

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

To validate vendor id and password & generate session

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "source": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("POST", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/accounts/loginvendor/{vendorID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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 ValidateUidPwdRequest true none

Example responses

200 Response

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

Responses

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

Returns login data for requested request id

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{

}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.GetLoginData()


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
JSONObject data = connect.getLoginData();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "SourceToken": []string{"string"},
        "AppIdKey": []string{"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHAiOjAsImZmIjoiVyIsImJkIjoid2ViLXBjIiwibmJmIjoxNjE2Mzk3NDQxLCJzcmMiOiJlbXRtdyIsImF2IjoiMS4wLjAiLCJhcHBpZCI6IjE2OTExYTA1ZDU4ZTI5YjVmNTMyZTE3MzRkYzQyMjI2IiwiaXNzIjoiZW10IiwiZXhwIjoxNjE2NDM3ODAwLCJpYXQiOjE2MTYzOTc3NDF9.X2L9kMZjK2yzK5wLiOk2gnF73j5q4WnQtAq26W9XFM4"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("POST", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/accounts/logindata", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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 LoginAuthDataRequestDto 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 LoginAuthDataResponse
222 Unknown Request id expired CommonErrorResponse
default Default unexpected error CommonErrorResponse

logs out user

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
const logout = apiConnect.logout().then(function(result) {

}).catch((err) => {console.log("Error logout",err);throw err});


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
logout = api_connect.Logout()


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String logOutResp=connect.logout();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("PUT", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/accounts/{userID}/logout", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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 LogOutDao
default Default unexpected error CommonErrorResponse

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const PlaceTrade = apiConnect.PlaceTrade(Trading_Symbol,
		Exchange,
		Action,
		Duration,
		Order_Type,
		Quantity,
		Streaming_Symbol,
		Limit_Price,
		Disclosed_Quantity = "0",
		TriggerPrice = "0",
		ProductCode = "CNC").then(function(result) {

  }).catch((err) => {console.log("Error PlaceTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect 
        
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum
from constants.action import ActionEnum

response = api_connect.PlaceTrade(Trading_Symbol = "INE090A01021", Exchange = ExchangeEnum.NSE, Action = ActionEnum.BUY, Duration = DurationEnum.DAY, Order_Type = OrderTypeEnum.MARKET, Quantity = 1, Streaming_Symbol = "4963_NSE", Limit_Price = "400", Disclosed_Quantity="0", TriggerPrice="0", ProductCode = ProductCodeENum.CNC)
      
      
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String placeTradeResponse = connect.placeTrade(Trading_Symbol, Exchange, Action, Duration, Order_Type, Quantity, Streaming_Symbol, Limit_Price, Disclosed_Quantity='0', TriggerPrice='0', ProductCode='CNC');

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
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 EQPlaceTradeRequestDao true none

Example responses

200 Response

//Order after slice 
        {
  "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
        {
  "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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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 );



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const ModifyTrade = apiConnect.ModifyTrade(Trading_Symbol,
		Exchange,
		Action,
		Duration,
		Order_Type,
		Quantity,
		Streaming_Symbol,
		Limit_Price,
		Order_ID,
		Disclosed_Quantity = "0",
		TriggerPrice = "0",
		ProductCode = "CNC",
    CurrentQuantity = "0").then(function(result) {

  }).catch((err) => {console.log("Error ModifyTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect 
        
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
        
from constants.exchange import ExchangeEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum
from constants.action import ActionEnum
        
response = api_connect.ModifyTrade(Trading_Symbol="INE090A01021", Exchange=ExchangeEnum.NSE, Action=ActionEnum.BUY, Duration=DurationEnum.DAY, Order_Type=OrderTypeEnum.LIMIT, Quantity=1, CurrentQuantity=1, Streaming_Symbol="4963_NSE", Limit_Price="620.00", Order_ID=211101000000001, Disclosed_Quantity="0", TriggerPrice="0", ProductCode=ProductCodeENum.CNC)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String modifyTradeResp = connect.modifyTrade(Trading_Symbol, Exchange, Action, Duration, Order_Type, Quantity, Streaming_Symbol, Limit_Price, Order_ID, Disclosed_Quantity='0', TriggerPrice='0', ProductCode='CNC',CurrentQuantity);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("PUT", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/modifytrade/v1/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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
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 EQModifyTradeRequestDao false none

Example responses

200 Response

//Order after slice 
        {
  "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
        {
  "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 ModifyTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Bracket Place trade for a client in equity

This is a 3 leg order where you can specify your original order, a profit booking order and a stop loss order all at one go. Here the main functionality will involve placing a limit order (either buy or sell) and then specifying the trigger prices at which you will look to book profit and limit your loss, these will be specified in the form of trigger prices and will end up placing market orders squaring off whenever a particular trigger is breached. In case of one of the trigger orders getting placed the pending trigger order will get auto cancelled. So in case you placed a bracket order for reliance industries with 1000 as limit and 100 as trigger for profit and 50 as trigger for stop loss, it means that in case the LTP goes above 1100 or goes below 950 the respective profit or stop loss trigger will get invoked and close out the entire position. Please note that bracket orders are intraday orders.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.PlaceBracketTrade(exchange, streamingSymbol, transactionType, quantity, duration, disclosedQuantity, limitPrice, target, stopLoss, trailingStopLoss, trailingStopLossValue);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const PlaceBracketTrade = apiConnect.PlaceBracketTrade(Exchange,
		Streaming_Symbol,
		Transaction_Type,
		Quantity,
		Duration,
		Disclosed_Quantity,
		Limit_Price,
		Target,
		StopLoss,
		Trailing_Stop_Loss = "Y",
		Trailing_Stop_Loss_Value = "1").then(function(result) {

  }).catch((err) => {console.log("Error PlaceBracketTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect 
        
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum
from constants.action import ActionEnum
        
response = api_connect.PlaceBracketTrade(Exchange=ExchangeEnum.BSE, Streaming_Symbol="531716_BSE", Transaction_Type= ActionEnum.BUY, Quantity=10, Duration=DurationEnum.DAY, Disclosed_Quantity="0",Limit_Price="100", Target="5", StopLoss="1", Trailing_Stop_Loss= "Y", Trailing_Stop_Loss_Value= "1")
        


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String placeBracketTradeResp =   connect.placeBracketTrade(Exchange, Streaming_Symbol, Transaction_Type, Quantity, Duration, Disclosed_Quantity, Limit_Price, Target, StopLoss, Trailing_Stop_Loss='Y', Trailing_Stop_Loss_Value='1');


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("POST", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/placebrackettrade/v1/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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

Body parameter

{
  "exc": "BSE",
  "sym": "TRICOMFRU",
  "trnsTyp": "BUY",
  "qty": 10,
  "dur": "DAY",
  "dsQty": 0,
  "prc": 100,
  "trdBsdOn": "LTP",
  "sqOffBsdOn": "Absolute",
  "sqOffVal": 5,
  "slBsdOn": "Absolute",
  "slVal": 5,
  "trlSl": "Y",
  "trlSlVal": 1,
  "ordSrc": "API"
}

Parameters

Parameter
Exchange Name of the exchange, BSE/NSE/CDS/MCX/NCDEX/NFO/BFO
Streaming_Symbol exchangetoken to be obtained from Contract file downloaded
Transaction_Type BUY/SELL
Quantity Quantity of the scrip to transact
Duration Order validity, DAY/IOC/EOS(for BSE)
Disclosed_Quantity Quantity to be disclosed publicly while order placement (default 0)
Limit_Price Limit price of scrip
Target Absolute Target value, e.g. 5, if you want to keep the target price Rs. 5 over the Limit price
StopLoss Absolute Stop Loss value, e.g. 3, if you want to keep the StopLoss price Rs. 5 below the Limit price
Trailing_Stop_Loss Y/N (default Y)
Trailing_Stop_Loss_Value Number (default 1)
Name In Type Required Description
userID path string true UserId of the client
body body EQBracketTradeRequestDao true none

Example responses

200 Response

{
  "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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Place Basket Order

Basket order allows user to place multiple orders at one time. User can place orders for multiple scrips all at once. One just creates multiple orders for same or different securities and club these orders together to be placed in one go. This helps save time.

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
	   var orderlist = new Array(new Order( {values} ));
	   orderlist.push(order);
       const PlaceBasketTrade = apiConnect.PlaceBasketTrade(orderlist).then(function(result) {

  }).catch((err) => {console.log("Error PlaceBasketTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect 
    
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
        
from constants.exchange import ExchangeEnum
from constants.action import ActionEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum
from APIConnect.order import Order

orderlist = [ 
  Order(
    Exchange=ExchangeEnum.NSE,
    TradingSymbol="TATCHE",
    StreamingSymbol="3405_NSE",
    Action=ActionEnum.BUY,
    ProductCode=ProductCodeENum.CNC,
    OrderType=OrderTypeEnum.LIMIT,
    Duration=DurationEnum.DAY,
    Price="307",
    TriggerPrice="307",
    Quantity=2,
    DisclosedQuantity="1",
    GTDDate="NA",
    Remark="UserRemarksTesting"
  ),
  Order(
    TradingSymbol="TATCHE",
    Exchange=ExchangeEnum.NSE,
    StreamingSymbol="3405_NSE",
    Action=ActionEnum.BUY,
    ProductCode=ProductCodeENum.CNC,
    OrderType=OrderTypeEnum.LIMIT,
    Duration=DurationEnum.DAY,
    Price="306",
    TriggerPrice="306",
    Quantity=2,
    DisclosedQuantity="1",
    GTDDate="NA",
    Remark="UserRemarksTesting"
  )
]

response = api_connect.PlaceBasketTrade(orderlist = orderlist)


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String placeBasketTradeResp = connect.placeBasketTrade(orderlist);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("POST", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/basketorder/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /eq/trade/basketorder/{userID}

Body parameter

{
  "ordLst": [
    {
      "exc": "NSE",
      "trdSym": "INE092A01019",
      "action": "BUY",
      "prdCode": "CNC",
      "ordTyp": "LIMIT",
      "dur": "DAY",
      "price": "306",
      "trgPrc": "306",
      "qty": "2",
      "dscQty": "1",
      "gtdDt": "NA",
      "rmk": "UserRemarksTesting"
    },
    {
      "exc": "NSE",
      "trdSym": "INE793A01012",
      "action": "BUY",
      "prdCode": "CNC",
      "ordTyp": "LIMIT",
      "dur": "DAY",
      "price": "990",
      "trgPrc": "990",
      "qty": "2",
      "dscQty": "1",
      "gtdDt": "NA",
      "rmk": ""
    }
  ],
  "vnCode": "118",
  "ordSrc": "EMT3"
}

Parameters

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

Example responses

200 Response

{
  "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 PlaceTradeBaseketDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

To Exit a Bracket trade for a client in equity

Similar to Exit Cover order the functionality will ensure that any non executed open order will be cancelled. However for any orders which are executed it will automatically cancel one of the target or stop loss legs and modify the other leg to be placed as a market order. This will ensure that any executed orders will be squared off in position terms.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.ExitBracketTrade(orderId, syomId, status);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const ExitBracketTrade = apiConnect.ExitBracketTrade(Order_Id, Syom_Id, Status).then(function(result) {

  }).catch((err) => {console.log("Error ExitBracketTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
        
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini'

response = api_connect.ExitBracketTrade(Order_Id=211101000000001, Syom_Id="68767", Status = "PENDING")


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String exitBracketTradeResp =   connect.exitBracketTrade(Order_Id, Syom_Id, Status);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("DELETE", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/exitbrackettrade/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /eq/trade/exitbrackettrade/{userID}

Body parameter

{
  "nstOrdNo": "7658755",
  "syomID": "68767",
  "sts": "PENDING"
}

Parameters

Parameter
OrderId Order Id
Syom_Id Syom_Id for leg orders. Can be obtained post placing Bracket Order from OrderBook
Status Current Status of the Bracket Order
Name In Type Required Description
userID path string true UserId of the client
body body EQBracketExitRequestDao false none

Example responses

200 Response

{
  "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 CancelTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Place gtd/gtc trade for a client in equity

Good Till Cancel (GTC) orders refers to orders where the validity period of the order is up to execution, cancellation by user or 90 days whichever comes first. This is a validity period used when you want to fire and forget an order and is usually an order placed with a limit price. Good Till Date (GTD) orders are similar to GTC orders, however here the validity period is set by the user (max validity period of 90 days), rest of the functionality is the same, this too is a limit order.

GTC order is active until the trade is executed or trader cancels the order. GTD orders remains active until a user specified date/7 days whichever is earlier or it has been filled or cancelled.

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const PlaceGtcGtdTrade = apiConnect.PlaceGtcGtdTrade(Trading_Symbol,
		Exchange,
		Action,
		Duration,
		Order_Type,
		Quantity,
		Limit_Price,
		streaming_symbol,
		Product_Code,
		DTDays).then(function(result) {

  }).catch((err) => {console.log("Error PlaceGtcGtdTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.action import ActionEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum

response = api_connect.PlaceGtcGtdTrade(Trading_Symbol= "INE683A01023", Exchange= ExchangeEnum.NSE, Action= ActionEnum.BUY, Duration= DurationEnum.GTC, Order_Type= OrderTypeEnum.LIMIT, Quantity=1, streaming_symbol= "5948_NSE", Limit_Price= "10.5", Product_Code= ProductCodeENum.CNC, DTDays= "")

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String placeGtcGtdTradeResp = connect.placeGtcGtdTrade(Trading_Symbol, Exchange, Action, Duration, Order_Type, Quantity, streaming_symbol, Limit_Price, Product_Code, DTDays);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("POST", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/placegtcgtdtrade/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /eq/trade/placegtcgtdtrade/{userID}

Body parameter

{
  "dtDays": "",
  "ordSrc": "MOB",
  "vnCode": "NA",
  "oprtn": "<=",
  "srcExp": "",
  "tgtId": "",
  "brnchNm": "",
  "brk": "",
  "amo": false,
  "dur": "GTC",
  "exc": "NSE",
  "lmPrc": "870.00",
  "ordTyp": "LIMIT",
  "sym": "7053_NSE",
  "trdSym": "INE793A01012",
  "qty": "1",
  "action": "BUY",
  "prdCode": "NRML"
}

Parameters

Parameter
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
Action BUY/SELL
Duration Order validity, GTD/GTC
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
DTDays Date for GTD Orders in dd-MM-yyyy format
Name In Type Required Description
userID path string true UserId of the client
body body PlaceGtcGtdTradeRequestDao true none

Example responses

200 Response

{
  "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 PlaceGtcGtdTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Cancel trade for a client in equity.

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const CancelTrade = apiConnect.CancelTrade(OrderId, Exchange, Order_Type, ProductCode, Trading_Symbol, Action, streaming_symbol, CurrentQuantity).then(function(result) {

  }).catch((err) => {console.log("Error CancelTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
        
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum

response = api_connect.CancelTrade(Order_ID=211101000000001, Exchange=ExchangeEnum.NSE, Order_Type=OrderTypeEnum.LIMIT, Product_Code=ProductCodeENum.CNC, Trading_Symbol= "INE793A01012", Action= ActionEnum.BUY, streaming_symbol= "7053_NSE", CurrentQuantity= "1")

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String cancelTradeResp = connect.cancelTrade(OrderId, Exchange, Order_Type, Product_Code, Trading_Symbol, Action, streaming_symbol, CurrentQuantity);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("PUT", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/canceltrade/v1/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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
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 EQCancelTradeReq true nstOID, exc, ordTyp, prdCode are mandatory

Example responses

200 Response

{
  "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 CancelTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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();



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const GetAMOStxatus = apiConnect.GetAMOStxatus().then(function(result) {

  }).catch((err) => {console.log("Error GetAMOStxatus",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.GetAMOStatus()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.GetAMOStatus();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/amoflag", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /eq/trade/amoflag

Example responses

200 Response

{
  "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 CommAMODao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Position squareOff API For Equity

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
	   var orderlist = new Array(new Order( {values} ));
	   orderlist.push(order);
       const PositionSquareOff = apiConnect.PositionSquareOff(orderlist).then(function(result) {

  }).catch((err) => {console.log("Error PositionSquareOff",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.action import ActionEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum
from APIConnect.order import Order

orderlist = [
 Order(
  Exchange=ExchangeEnum.NSE,
  TradingSymbol="TATCHE",
  StreamingSymbol="3405_NSE",
  Action=ActionEnum.BUY,
  ProductCode=ProductCodeENum.CNC,
  Duration=DurationEnum.DAY,
  Price="307",
  TriggerPrice="307",
  OrderType=OrderTypeEnum.LIMIT,          	
  Quantity=2,
  DisclosedQuantity="1",
  GTDDate="NA",
  Remark="UserRemarksTesting"             	
  ),             	      	
  Order(
  Exchange=ExchangeEnum.NSE,
  TradingSymbol="TATCHE",
  StreamingSymbol="TATACHEM",
  Action=ActionEnum.BUY,
  ProductCode=ProductCodeENum.CNC,
  OrderType=OrderTypeEnum.LIMIT,
  Duration=DurationEnum.DAY,
  Price="306",
  TriggerPrice="306",
  Quantity=2,
  DisclosedQuantity="1",
  GTDDate="NA",
  Remark="UserRemarksTesting"
  )          	
]

response = api_connect.PositionSquareOff(orderlist=orderlist)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.positionSquareOff(OrderList);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("POST", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/position/sqroff/v1/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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 PositionSquareOffRequestDto true Position square off Request Fields

Example responses

200 Response

{
  "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 PositionSquareOffResponseDto
401 Unauthorized Session Expired SessionExpired
403 Forbidden Invalid AppID Key ErrorResponseDao
500 Internal Server Error Something went wrong, please try again later ErrorResponseDao
default Default unexpected error CommonErrorResponse

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const ConvertPosition = apiConnect.ConvertPosition(Order_Id, Fill Id, New_Product_Code, Old_Product_Code, Exchange, orderType).then(function(result) {

  }).catch((err) => {console.log("Error ConvertPosition",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum

response = api_connect.ConvertPosition(Order_ID=211101000000001, Fill_Id= "30414", New_Product_Code= ProductCodeENum.MIS, Old_Product_Code= ProductCodeENum.CNC, Exchange= ExchangeEnum.NSE, Order_Type= OrderTypeEnum.MARKET)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.convertPosition(Order_Id, Fill Id, New_Product_Code, Old_Product_Code, Exchange, orderType);



package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("PUT", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/convertposition/v1/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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

Body parameter

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

Parameters

Parameter
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 EQConvertPositionReq false none

Example responses

200 Response

{
  "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 EqConvertPositionDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Place AMO trade for a client in equity

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const PlaceAMOTrade = apiConnect.PlaceAMOTrade(Trading_Symbol,
		Exchange,
		Action,
		Duration,
		Order_Type,
		Quantity,
		Streaming_Symbol,
		Limit_Price,
		Disclosed_Quantity = "0",
		TriggerPrice = "0",
		ProductCode = "CNC").then(function(result) {

  }).catch((err) => {console.log("Error PlaceAMOTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.action import ActionEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum

response = api_connect.PlaceAMOTrade(Trading_Symbol= "INE793A01012", Exchange= ExchangeEnum.NSE, Action= ActionEnum.BUY, Duration= DurationEnum.DAY, Order_Type= OrderTypeEnum.MARKET, Quantity=1, Streaming_Symbol= "7053_NSE", Limit_Price= "1220.50", Disclosed_Quantity="0", TriggerPrice="0", ProductCode=ProductCodeENum.CNC)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.placeAMOTrade(Trading_Symbol, Exchange, Action, Duration, Order_Type, Quantity, Streaming_Symbol, Limit_Price, Disclosed_Quantity='0', TriggerPrice='0', ProductCode='CNC');


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("POST", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/amo/placetrade/v1/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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
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 EQPlaceTradeRequestDao false none

Example responses

200 Response

//Order after slice 
        {
  "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
        {
  "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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const ModifyAMOTrade = apiConnect.ModifyAMOTrade(Trading_Symbol,
		Exchange,
		Action,
		Duration,
		Order_Type,
		Quantity,
		Streaming_Symbol,
		Limit_Price,
		Order_ID,
		Disclosed_Quantity = "0",
		TriggerPrice = "0",
		ProductCode = "CNC",
    CurrentQuantity = "0").then(function(result) {

  }).catch((err) => {console.log("Error ModifyAMOTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.action import ActionEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum

response = api_connect.ModifyAMOTrade(Trading_Symbol="INE094I01018", Exchange=ExchangeEnum.NSE, Action=ActionEnum.SELL, Duration=DurationEnum.DAY, Order_Type=OrderTypeEnum.MARKET, Quantity=1, CurrentQuantity =1, Streaming_Symbol="15124_NSE", Limit_Price="0", Order_ID=211101000000001, Disclosed_Quantity="0", TriggerPrice="0", ProductCode=ProductCodeENum.CNC)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.modifyAMOTrade(Trading_Symbol, Exchange, Action, Duration, Order_Type, Quantity, Streaming_Symbol, Limit_Price, Order_ID, Disclosed_Quantity='0', TriggerPrice='0', ProductCode='CNC',CurrentQuantity='0');


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("PUT", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/amo/modifytrade/v1/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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
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 EQModifyTradeRequestDao false none

Example responses

200 Response

//Order after slice 
        {
  "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
        {
  "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 ModifyTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Cancel AMO trade for a client in equity

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const CancelAMOTrade = apiConnect.CancelAMOTrade(OrderId, Exchange, Order_Type, Product_Code, Trading_Symbol, Action, streaming_symbol, CurrentQuantity).then(function(result) {

  }).catch((err) => {console.log("Error CancelAMOTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum

response = api_connect.CancelAMOTrade(Order_ID=211101000000001, Exchange=ExchangeEnum.NSE, Order_Type=OrderTypeEnum.LIMIT, ProductCode=ProductCodeENum.CNC, Trading_Symbol= "INE793A01012", Action= ActionEnum.BUY, streaming_symbol= "7053_NSE", CurrentQuantity= "1")


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.cancelAMOTrade(OrderId, Exchange, Order_Type, Product_Code, Trading_Symbol, Action, streaming_symbol, CurrentQuantity);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("PUT", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/amo/canceltrade/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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
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 EQCancelTradeRequestDao false none

Example responses

200 Response

{
  "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 CancelTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Equity-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)

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
   const orderBook = apiConnect.OrderBook().then(function(result) {

  }).catch((err) => {console.log("Error orderBook",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.OrderBook()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.orderBook();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/order/book/{userID}/v1", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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

This method will retrieve the equity Order Book.

Parameters

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

Enumerated Values

Parameter Value
rTyp PAYOUT
rTyp PAYIN

Example responses

200 Response

{
  "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"
            }
          }
        ]
      }
    ]
  }
}

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 OrderBookResponse
222 Unknown Empty order book CommonErrorResponse
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Shows order details for a client in equity

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const OrderDetails = apiConnect.OrderDetails(orderId, Exchange).then(function(result) {

  }).catch((err) => {console.log("Error OrderDetails",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
        
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum

response = api_connect.OrderDetails(OrderId= 211101000000001, Exchange=ExchangeEnum.NSE)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.orderDetails(OrderId,Exchange);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/order/details/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /eq/order/details/{userID}

Parameters

Parameter
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

{
  "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"
      }
    ]
  }
}

Responses

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

Shows order history for a client in equity

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const OrderHistory = apiConnect.OrderHistory(StartDate, EndDate).then(function(result) {

  }).catch((err) => {console.log("Error OrderHistory",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.OrderHistory(StartDate, EndDate)


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.orderHistory(StartDate, EndDate);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/order/history/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /eq/order/history/{userID}

Parameters

Parameter
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

{
  "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 EqOrderHistoryDao
222 Unknown No data available CommonErrorResponse
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Equity-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();



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const Holdings = apiConnect.Holdings().then(function(result) {

  }).catch((err) => {console.log("Error Holdings",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.Holdings()


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.holdings();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/holdings/v1/rmsholdings/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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

Parameters

Name In Type Required Description
userID path string true none

Example responses

200 Response

{
  "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 HoldingsRMSDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Equity-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();



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const Limits = apiConnect.Limits().then(function(result) {

  }).catch((err) => {console.log("Error Limits",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.Limits()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.limits();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/limits/rmssublimits/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /eq/limits/rmssublimits/{userID}

Parameters

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

Example responses

200 Response

{
  "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 EQLimitsDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Equity-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();



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const NetPosition = apiConnect.NetPosition().then(function(result) {

  }).catch((err) => {console.log("Error NetPosition",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.NetPosition()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.netPosition();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/positions/net/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /eq/positions/net/{userID}

Parameters

Name In Type Required Description
userID path string true none

Example responses

200 Response

{
  "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 NetPositionsDao
222 Unknown No positions CommonErrorResponse
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Equity-TradeBook

Retrieving Equity TradeBook for a particular client

Shows trade book for a client in equity

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
     const tradeBook = apiConnect.TradeBook().then(function(result) {

  }).catch((err) => {console.log("Error tradeBook",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.TradeBook()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.tradeBook();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/tradebook/v1/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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

{
  "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 EqTradeBookDao
222 Unknown Empty trade book CommonErrorResponse
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Transaction-History

Retrieving Transaction History for a particular client

Shows transaction history for a client

Code samples


const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
     const tradeBook = apiConnect.getTransactionHistory(
      "EQUITY",
      "2023-10-06",
      "2023-11-06"
).then(function(result) {

  }).catch((err) => {console.log("Error TransactionHistory",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.GetAllTransactionHistory(segment = SegmentTypeEnum.EQUITY, fromDate = "2023-10-06", toDate = "2023-11-06")

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.getTransactionHistory(
  Segment.EQUITY, "2023-10-06",
  "2023-11-06"
);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/tradebook/v1/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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

{
  "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 TransactionHistoryDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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();



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
     const depth = apiConnect.GetMarketDepth().then(function(result) {

  }).catch((err) => {console.log("Error depth",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.GetMarketDepth()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.getMarketDepth();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/tradebook/v1/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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

{
  "appID": "663051cfbac7d699a1c59b96048b50e7",
  "config": {},
  "msgID": "aeae1389-9784-4b23-9774-f0a63f3074d6",
  "srvTm": "string",
  "data": {
    "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"
  }
}

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 MarketDepthDao
222 Unknown Empty reponse CommonErrorResponse
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

MF-Holdings

MF holdings section of particular client

Retrieving All of clients holdings

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const HoldingsMF = apiConnect.HoldingsMF().then(function(result) {

  }).catch((err) => {console.log("Error HoldingsMF",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.HoldingsMF()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.holdingsMF();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/mf/holding/{userId}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /mf/holding/{userId}

Parameters

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

Example responses

200 Response

{
  "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"
  }
}

Responses

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

MF-Trade

Trade APIs

Modify/Cancel order Method

Code samples

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

apiConnect.ModifyMF(token, ISINCode, transactionType, clientCode, quantity, amount, reInvFlag, folioNumber, schemeName, startDate, endDate, SIPFrequency, generateFirstOrderToday, schemePlan, schemeCode, transactionId ,mandateId); 

apiConnect.CancelMF(token, ISINCode, transactionType, clientCode, quantity, amount, reInvFlag, folioNumber, schemeName, startDate, endDate, SIPFrequency, generateFirstOrderToday, schemePlan, schemeCode, transactionId ,mandateId);


const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const ModifyMF = apiConnect.ModifyMF(Token,
		ISIN_Code,
		Transaction_Type,
		Client_Code,
		Quantity,
		Amount,
		ReInv_Flag,
		Folio_Number,
		Scheme_Name,
		Start_Date,
		End_Date,
		SIP_Frequency,
		Generate_First_Order_Today,
		Scheme_Plan,
		Scheme_Code,
		Transaction_Id).then(function(result) {
	   
  }).catch((err) => {console.log("Error ModifyMF",err);throw err});
  
	   const CancelMF = apiConnect.CancelMF(Token,
		ISIN_Code,
		Transaction_Type,
		Client_Code,
		Quantity,
		Amount,
		ReInv_Flag,
		Folio_Number,
		Scheme_Name,
		Start_Date,
		End_Date,
		SIP_Frequency,
		Generate_First_Order_Today,
		Scheme_Plan,
		Scheme_Code,
		Transaction_Id).then(function(result) {
	   
  }).catch((err) => {console.log("Error CancelMF",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

response = api_connect.ModifyMF(Token, ISIN_Code, Transaction_Type, Client_Code, Quantity, Amount, ReInv_Flag, Folio_Number, Scheme_Name, Start_Date, End_Date, SIP_Frequency, Generate_First_Order_Today, Scheme_Plan, Scheme_Code, Transaction_Id, Mandate_Id)

response = api_connect.CancelMF(Token, ISIN_Code, Transaction_Type, Client_Code, Quantity, Amount, ReInv_Flag, Folio_Number, Scheme_Name, Start_Date, End_Date, SIP_Frequency, Generate_First_Order_Today, Scheme_Plan, Scheme_Code, Transaction_Id)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.modifyMF(Token, ISIN_Code, Transaction_Type, Client_Code, Quantity, Amount, ReInv_Flag, Folio_Number, Scheme_Name, Start_Date, End_Date, SIP_Frequency, Generate_First_Order_Today, Scheme_Plan, Scheme_Code, Transaction_Id);
String response = connect.cancelMF(Token, ISIN_Code, Transaction_Type, Client_Code, Quantity, Amount, ReInv_Flag, Folio_Number, Scheme_Name, Start_Date, End_Date, SIP_Frequency, Generate_First_Order_Today, Scheme_Plan, Scheme_Code, Transaction_Id);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("PUT", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/mf/trade/{userId}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /mf/trade/{userId}

Body parameter

{
  "rmrk": "",
  "txnTyp": "FP",
  "reInvFlg": "Z",
  "ordTyp": "MODIFY",
  "reqstdBy": "EB003311",
  "qty": 0,
  "schemeName": "ADITYA BIRLA SUN LIFE BALANCED ADVANTAGE FUND - GROWTH OPTION",
  "amt": 200000,
  "ordSrc": "EMT",
  "isin": "INF084M01AB8",
  "token": "16378",
  "txnId": 0,
  "clientCode": Client_Code,
  "closeAccountFlag": "N",
  "currentOrdSts": "",
  "dpc": "Y",
  "endDt": End_Date,
  "euinflag": "N",
  "euinnumber": "",
  "folioNo": Folio_Number,
  "gfot": Generate_First_Order_Today,
  "kycflag": "1",
  "mdtId": "",
  "mnRdmFlg": "",
  "physicalFlag": "D",
  "schemeCode": Scheme_Code,
  "schemePlan": Scheme_Plan,
  "sipFrq": SIP_Frequency,
  "siporderno": "",
  "sipregno": "",
  "strtDt": Start_Date,
  "strtDy": "1",
  "tnr": "",
}

Parameters

Parameter
Token Token to be obtained from MF Contract file downloaded
ISIN_Code ISIN_Code to be obtained from MF Contract file downloaded
Transaction_Type FP (Fresh Purchase), AP (Additional Purchase), R (Redemption), SIP, XSIP
Client_Code Client code of user
Quantity Units to redeem
Amount for Fresh Purchase/ Additional Purchase/ SIP/ XSIP/ ISIP
ReInv_Flag Z (Growth), Y (Div Reinvest), N (Div Payout)
Folio_Number Blank for Fresh Purchase, Redeem / Additional Purchase
Scheme_Name Scheme Name (to be obtained from MF Contract file downloaded)
Start_Date SIP Start Date
End_Date SIP End Date
SIP_Frequency MONTHLY
Generate_First_Order_Today Y/N
Scheme_Plan Direct, Normal
Scheme_Code schemeCode to be obtained from MF Contract file downloaded
Transaction_Id OrderID for Modify Order
Name In Type Required Description
userId path string true UserId of the client
body body MFTradeRequestDao false Place Trade Request

Example responses

200 Response

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

Responses

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

Place trade Method

Code samples

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

apiConnect.PlaceMF(token, ISINCode, transactionType, clientCode, quantity, amount, reInvFlag, folioNumber, schemeName, startDate, endDate, SIPFrequency, generateFirstOrderToday, schemePlan, schemeCode, mandateId);

const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const PlaceMF = apiConnect.PlaceMF(Token,
		ISIN_Code,
		Transaction_Type,
		Client_Code,
		Quantity,
		Amount,
		ReInv_Flag,
		Folio_Number,
		Scheme_Name,
		Start_Date,
		End_Date,
		SIP_Frequency,
		Generate_First_Order_Today,
		Scheme_Plan,
		Scheme_Code).then(function(result) {

  }).catch((err) => {console.log("Error PlaceMF",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

response = api_connect.PlaceMF(Token, ISIN_Code, Transaction_Type, Client_Code, Quantity, Amount, ReInv_Flag, Folio_Number, Scheme_Name, Start_Date, End_Date, SIP_Frequency, Generate_First_Order_Today, Scheme_Plan, Scheme_Code, Mandate_Id)

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.placeMF(Token, ISIN_Code, Transaction_Type, Client_Code, Quantity, Amount, ReInv_Flag, Folio_Number, Scheme_Name, Start_Date, End_Date, SIP_Frequency, Generate_First_Order_Today, Scheme_Plan, Scheme_Code);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("POST", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/mf/trade/{userId}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /mf/trade/{userId}

Body parameter

{
  "rmrk": "",
  "txnTyp": "FP",
  "reInvFlg": "Z",
  "ordTyp": "Fresh",
  "reqstdBy": "EB003311",
  "qty": 0,
  "schemeName": "ADITYA BIRLA SUN LIFE BALANCED ADVANTAGE FUND - GROWTH OPTION",
  "amt": 200000,
  "ordSrc": "EMT",
  "isin": "INF084M01AB8",
  "token": "16378",
  "txnId": 0,
  "clientCode": Client_Code,
  "closeAccountFlag": "N",
  "currentOrdSts": "",
  "dpc": "Y",
  "endDt": End_Date,
  "euinflag": "N",
  "euinnumber": "",
  "folioNo": Folio_Number,
  "gfot": Generate_First_Order_Today,
  "kycflag": "1",
  "mdtId": "",
  "mnRdmFlg": "",
  "physicalFlag": "D",
  "schemeCode": Scheme_Code,
  "schemePlan": Scheme_Plan,
  "sipFrq": SIP_Frequency,
  "siporderno": "",
  "sipregno": "",
  "strtDt": Start_Date,
  "strtDy": "1",
  "tnr": "",
}

Parameters

Parameter
Token Token to be obtained from MF Contract file downloaded
ISIN_Code ISIN_Code to be obtained from MF Contract file downloaded
Transaction_Type FP (Fresh Purchase), AP (Additional Purchase), R (Redemption), SIP, XSIP
Client_Code Client code of user
Quantity Units to redeem
Amount for Fresh Purchase/ Additional Purchase/ SIP/ XSIP/ ISIP
ReInv_Flag Z (Growth), Y (Div Reinvest), N (Div Payout)
Folio_Number Blank for Fresh Purchase, Redeem / Additional Purchase
Scheme_Name Scheme Name (to be obtained from MF Contract file downloaded)
Start_Date SIP Start Date
End_Date SIP End Date
SIP_Frequency MONTHLY
Generate_First_Order_Today Y/N
Scheme_Plan Direct, Normal
Scheme_Code schemeCode to be obtained from MF Contract file downloaded
Name In Type Required Description
userId path string true UserId of the client
body body MFTradeRequestDao false Place Trade Request

Example responses

200 Response

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

Responses

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

MF-Order book

Retrieving the list of orders in client's account. In order to get current day orders

Retrieving the list of orders in client's account. In order to get current day orders

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.MFOrderBookURL(fromDate, toDate);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const MFOrderBook = apiConnect.MFOrderBook(fromDate, toDate).then(function(result) {

  }).catch((err) => {console.log("Error MFOrderBook",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.MFOrderBook(fromDate, toDate)

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.MFOrderBook(fromDate, toDate);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/mf/order/{userId}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /mf/order/{userId}

Parameters

Parameter
fromDate From Date
toDate To Date
Name In Type Required Description
userId path string true UserId of the client
frDt query string false From date in format dd/MM/yyyy
toDt query string false To date in format dd/MM/yyyy

Example responses

200 Response

{
  "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"
      }
    ]
  }
}

Responses

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

Commodity-Trade

Place a Trade / Place GTC/GTD Order for a client in commodity

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.

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);
apiConnect.PlaceGtcGtdTrade(tradingSymbol, exchange, action, duration, orderType, quantity, streamingSymbol, limitPrice, productCode, DTDays);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const PlaceTrade = apiConnect.PlaceTrade(Trading_Symbol,
		Exchange,
		Action,
		Duration,
		Order_Type,
		Quantity,
		Streaming_Symbol,
		Limit_Price,
		Disclosed_Quantity = "0",
		TriggerPrice = "0",
		ProductCode = "CNC").then(function(result) {
	   
  }).catch((err) => {console.log("Error PlaceTrade",err);throw err});
       const PlaceGtcGtdTrade = apiConnect.PlaceGtcGtdTrade(Trading_Symbol,
		Exchange,
		Action,
		Duration,
		Order_Type,
		Quantity,
		Limit_Price,
		streaming_symbol,
		Product_Code,
		DTDays).then(function(result) {
	   
  }).catch((err) => {console.log("Error PlaceGtcGtdTrade",err);throw err});  
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum
from constants.action import ActionEnum

response = api_connect.PlaceTrade(Trading_Symbol = "SILVER21DECFUT", Exchange = ExchangeEnum.MCX, Action = ActionEnum.BUY, Duration = DurationEnum.DAY, Order_Type = OrderTypeEnum.LIMIT, Quantity = 1, Streaming_Symbol = "224571_MCX", Limit_Price = "63000", Disclosed_Quantity="0", TriggerPrice="0", ProductCodeENum = ProductCodeENum.CNC)

response = api_connect.PlaceGtcGtdTrade(Trading_Symbol= "SILVER21DECFUT", Exchange= ExchangeEnum.MCX, Action= ActionEnum.BUY, Duration= DurationEnum.GTC, Order_Type= OrderTypeEnum.LIMIT, Quantity=1, streaming_symbol= "224571_MCX", Limit_Price= "1220.50", Product_Code= ProductCodeENum.NRML, DTDays= "")
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.PlaceTrade(Trading_Symbol, Exchange, Action, Duration, Order_Type, Quantity, Streaming_Symbol, Limit_Price, Disclosed_Quantity='0', TriggerPrice='0', ProductCode='CNC');
String response = connect.PlaceGtcGtdTrade(Trading_Symbol, Exchange, Action, Duration, Order_Type, Quantity, Streaming_Symbol, Limit_Price, Product_Code, DTDays);


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://emtuat.edelweiss.in/edelmw-eq-uat/comm/trade/placetrade/{userID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...

POST /comm/trade/placetrade/{userID}

Body parameter

{
  "dur": "DAY",
  "vlDt": "string",
  "sym": "string",
  "lmPrc": "string",
  "ordTyp": "LIMIT",
  "action": "BUY",
  "prdCode": "CNC",
  "exc": "BSE",
  "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"
}

Parameters

Parameter
Trading_Symbol Trading Symbol of the Scrip, to be obtained from Contract file downloaded
Exchange Name of the exchange, MCX/NCDEX
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 USER ID of the client
body body TradeRequest true dur, sym, lmPrc, orTyp, action, prCode, exc, qty, trSym are mandatory parameters

Example responses

200 Response

{
  "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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Modify a Trade for a client in commodity

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const ModifyTrade = apiConnect.ModifyTrade(Trading_Symbol,
		Exchange,
		Action,
		Duration,
		Order_Type,
		Quantity,
		Streaming_Symbol,
		Limit_Price,
		Order_ID,
		Disclosed_Quantity = "0",
		TriggerPrice = "0",
		ProductCode = "CNC").then(function(result) {

  }).catch((err) => {console.log("Error ModifyTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum
from constants.action import ActionEnum

response = api_connect.ModifyTrade(Trading_Symbol="SILVER21DECFUT",
Exchange=ExchangeEnum.MCX, Action=ActionEnum.BUY, Duration=DurationEnum.DAY, Order_Type=OrderTypeEnum.LIMIT, Quantity=1, Streaming_Symbol="224571_MCX", Limit_Price="63000", Order_ID=211101000000001, Disclosed_Quantity="0", TriggerPrice="0", ProductCode=ProductCodeENum.CNC)


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.ModifyTrade(Trading_Symbol, Exchange, Action, Duration, Order_Type, Quantity, Streaming_Symbol, Limit_Price, Order_ID, Disclosed_Quantity='0', TriggerPrice='0', ProductCode='CNC');


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://emtuat.edelweiss.in/edelmw-eq-uat/comm/trade/modifytrade/{userID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /comm/trade/modifytrade/{userID}

Body parameter

{
  "dur": "DAY",
  "vlDt": "string",
  "sym": "string",
  "lmPrc": "string",
  "ordTyp": "LIMIT",
  "action": "BUY",
  "prdCode": "CNC",
  "exc": "BSE",
  "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"
}

Parameters

Parameter
Trading_Symbol Trading Symbol of the Scrip, to be obtained from Contract file downloaded
Exchange Name of the exchange, MCX/NCDEX
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
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 TradeRequest true nstOID is mandatory, At least one of dur, sym, lmPrc, orTyp, action, prCode, exc, qty, trSym is required for successfull modification

Example responses

200 Response

{
  "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 ModifyTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Cancel a 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, Order_Type, ProductCode);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const CancelTrade = apiConnect.CancelTrade(OrderId, Exchange, Order_Type, ProductCode).then(function(result) {
	   
  }).catch((err) => {console.log("Error CancelTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum

response = api_connect.CancelTrade(Order_ID=211101000000001, Exchange=ExchangeEnum.MCX, Order_Type=OrderTypeEnum.LIMIT, Product_Code=ProductCodeENum.CNC)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.CancelTrade(OrderId, Exchange, Order_Type, ProductCode);


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://emtuat.edelweiss.in/edelmw-eq-uat/comm/trade/canceltrade/v1/{userID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

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

Body parameter

{
  "dur": "DAY",
  "vlDt": "string",
  "sym": "string",
  "lmPrc": "string",
  "ordTyp": "LIMIT",
  "action": "BUY",
  "prdCode": "CNC",
  "exc": "BSE",
  "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"
}

Parameters

Name In Type Required Description
userID path string true USER ID of the client
body body TradeRequest true nstOID , exc, prdCode & ordTyp are mandatory

Example responses

200 Response

{
  "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 CancelTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Place a AMO Trade for a client in 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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const PlaceAMOTrade = apiConnect.PlaceAMOTrade(Trading_Symbol,
		Exchange,
		Action,
		Duration,
		Order_Type,
		Quantity,
		Streaming_Symbol,
		Limit_Price,
		Disclosed_Quantity = "0",
		TriggerPrice = "0",
		ProductCode = "CNC").then(function(result) {

  }).catch((err) => {console.log("Error PlaceAMOTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect class.

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.action import ActionEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum

response = api_connect.PlaceAMOTrade(Trading_Symbol= "SILVER21DECFUT", Exchange= ExchangeEnum.MCX, Action= ActionEnum.BUY, Duration= DurationEnum.DAY, Order_Type= OrderTypeEnum.LIMIT, Quantity=1, Streaming_Symbol= "224571_MCX", Limit_Price= "45999.00", Disclosed_Quantity="0", TriggerPrice="0", ProductCode=ProductCodeENum.NRML)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.placeAMOTrade(Trading_Symbol, Exchange, Action, Duration, Order_Type, Quantity, Streaming_Symbol, Limit_Price, Disclosed_Quantity='0', TriggerPrice='0', ProductCode='CNC');


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("POST", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/trade/amo/placetrade/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /comm/trade/amo/placetrade/{userID}

Body parameter

{
  "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"
}

Parameters

Parameter
Trading_Symbol Trading Symbol of the Scrip, to be obtained from Contract file downloaded
Exchange Name of the exchange, MCX/NCDEX
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 USER ID of the client
body body TradeRequest true dur, sym, lmPrc, orTyp, action, prCode, exc, qty, trSym are mandatory parameters

Example responses

200 Response

{
  "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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Modify a 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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const ModifyAMOTrade = apiConnect.ModifyAMOTrade(Trading_Symbol,
		Exchange,
		Action,
		Duration,
		Order_Type,
		Quantity,
		Streaming_Symbol,
		Limit_Price,
		Order_ID,
		Disclosed_Quantity = "0",
		TriggerPrice = "0",
		ProductCode = "CNC").then(function(result) {

  }).catch((err) => {console.log("Error ModifyAMOTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.action import ActionEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum

response = api_connect.ModifyAMOTrade(Trading_Symbol="SILVER21DECFUT", Exchange=ExchangeEnum.MCX, Action=ActionEnum.BUY, Duration=DurationEnum.DAY, Order_Type=OrderTypeEnum.LIMIT, Quantity=1, Streaming_Symbol="224571_MCX", Limit_Price="0", Order_ID=211101000000001, Disclosed_Quantity="0", TriggerPrice="0", ProductCode=ProductCodeENum.NRML)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.modifyAMOTrade(Trading_Symbol, Exchange, Action, Duration, Order_Type, Quantity, Streaming_Symbol, Limit_Price, Order_ID, Disclosed_Quantity='0', TriggerPrice='0', ProductCode='CNC');


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("PUT", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/trade/amo/modifytrade/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /comm/trade/amo/modifytrade/{userID}

Body parameter

{
  "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"
}

Parameters

Parameter
Trading_Symbol Trading Symbol of the Scrip, to be obtained from Contract file downloaded
Exchange Name of the exchange, MCX/NCDEX
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
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 TradeRequest true nstOID is mandatory, At least one of dur, sym, lmPrc, orTyp, action, prCode, exc, qty, trSym is required for successful modification

Example responses

200 Response

{
  "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 ModifyTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Cancel a amo trade for a client

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const CancelAMOTrade = apiConnect.CancelAMOTrade(OrderId, Exchange, Order_Type, Product_Code).then(function(result) {

  }).catch((err) => {console.log("Error CancelAMOTrade",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum

response = api_connect.CancelAMOTrade(Order_ID=211101000000001, Exchange=ExchangeEnum.MCX, Order_Type=OrderTypeEnum.LIMIT, ProductCode=ProductCodeENum.NRML)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.cancelAMOTrade(OrderId, Exchange, Order_Type, Product_Code);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("PUT", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/trade/amo/canceltrade/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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

Body parameter

{
   "nstOID": "210623000000155",
   "exc": "MCX",
   "prdCode": "CNC",
   "ordTyp": "MARKET"
  }

Parameters

Parameter
OrderId Parent order Id
Exchange Name of the exchange, MCX/NCDEX
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)
Name In Type Required Description
userID path string true USER ID of the client
body body TradeRequest true nstOID is mandatory

Example responses

200 Response

{
  "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 CancelTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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(exchange);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const GetAMOStxatus = apiConnect.GetAMOStxatus(exchange).then(function(result) {

  }).catch((err) => {console.log("Error GetAMOStxatus",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.GetAMOStatus(Exchange : ExchangeEnum = None)

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = GetAMOStatus(exchange)


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/trade/amostatus/{exchange}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /comm/trade/amostatus/{exchange}

Example responses

200 Response

{
  "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 CommAMODao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Position squareOff API For 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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
	   var orderlist = new Array(new Order( {values} ));
	   orderlist.push(order);
       const PositionSquareOff = apiConnect.PositionSquareOff(orderlist).then(function(result) {

  }).catch((err) => {console.log("Error PositionSquareOff",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum
from constants.action import ActionEnum
from constants.order_type import OrderTypeEnum
from constants.product_code import ProductCodeENum
from constants.duration import DurationEnum
from APIConnect.order import Order

orderlist = [
 Order(
  Exchange=ExchangeEnum.NSE,
  TradingSymbol="TATCHE",
  StreamingSymbol="3405_NSE",
  Action=ActionEnum.BUY,
  ProductCode=ProductCodeENum.CNC,
  Duration=DurationEnum.DAY,
  Price="307",
  TriggerPrice="307",
  OrderType=OrderTypeEnum.LIMIT,          	
  Quantity=2,
  DisclosedQuantity="1",
  GTDDate="NA",
  Remark="UserRemarksTesting"             	
  ),             	      	
  Order(
  Exchange=ExchangeEnum.NSE,
  TradingSymbol="TATCHE",
  StreamingSymbol="TATACHEM",
  Action=ActionEnum.BUY,
  ProductCode=ProductCodeENum.CNC,
  OrderType=OrderTypeEnum.LIMIT,
  Duration=DurationEnum.DAY,
  Price="306",
  TriggerPrice="306",
  Quantity=2,
  DisclosedQuantity="1",
  GTDDate="NA",
  Remark="UserRemarksTesting"
  )          	
]

response = api_connect.PositionSquareOff(orderlist=orderlist)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.positionSquareOff(OrderList);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("POST", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/eq/trade/position/sqroff/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

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

Body parameter

[
  {
    "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 PositionSquareOffRequestDto true Position square off Request Fields

Example responses

200 Response

{
  "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 PositionSquareOffResponseDto
401 Unauthorized Session Expired SessionExpired
403 Forbidden Invalid AppID Key ErrorResponseDao
500 Internal Server Error Something went wrong, please try again later ErrorResponseDao
default Default unexpected error CommonErrorResponse

Convert a position for a client

Convert Position : converts your holding position from MIS to CNC and vice-versa.

Code samples


APIConnect apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract, iniFilePath);
apiConnect.ConvertPositionCOMM(orderId, fillId,newProductCode, oldProductCode, exchange, trdSym, sym, cnvTyp, action, qty, ordSrc)



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const ConvertPosition = apiConnect.ConvertPositionCOMM = (
        streamingSymbol,
        conversionType,
        quantity,
        action,
        oldProductCode,
        newProductCode,
        exchange,
        tradingSymbol
      ) {

  }).catch((err) => {console.log("Error ConvertPosition",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.action import ActionEnum
from constants.exchange import ExchangeEnum
from constants.product_code import ProductCodeENum

response = api_connect.ConvertPositionCOMM(Streaming_Symbol, Conversion_Type, Quantity, Action : ActionEnum, Old_Product_Code : ProductCodeENum, New_Product_Code : ProductCodeENum, Exchange : ExchangeEnum, Trading_Symbol)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.convertPositionComm(newPrdCode,oldPrdCode,exchange,streamingSym,tradingSym,cnvTyp,action,qty);

package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("PUT", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/trade/positionconversion/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /comm/trade/positionconversion/{userID}

Body parameter

{
  "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"
}

Parameters

Parameter
Symbol Each Symbol is unique and represents the stock identity. This is the exchange token to be obtained from the contract file downloaded
ConversionType ConversionType
New_Product_Code New Product code of the trade
Old_Product_Code Existing Product Code of the trade
Exchange Name of the exchange, MCX/NCDEX etc
Action Action [B => BUY / S => SELL]
Quantity Quantity of the scrip to transact
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 TradeRequest true nstOID, prdCode prCodeCh , exc and ordTyp are mandatory

Example responses

200 Response

{
  "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 ConvertPositionDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Commodity-OrderDetails

To get Order Details for a perticular order-id for a particular client

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const OrderDetails = apiConnect.OrderDetails(orderId, Exchange).then(function(result) {

  }).catch((err) => {console.log("Error OrderDetails",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

from constants.exchange import ExchangeEnum

response = api_connect.OrderDetails(OrderId= 211101000000001, Exchange=ExchangeEnum.MCX)
APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.orderDetails(OrderId,Exchange);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/orderdetails/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /comm/orderdetails/{userID}

Parameters

Parameter
OrderId Order Id
Exchange Name of the exchange, MCX/NCDEX
Name In Type Required Description
userID path string true UserId of the client
oID query string false Order Number of the order for which client wants to see details

Example responses

200 Response

{
  "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"
      }
    ]
  }
}

Responses

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

Commodity-OrderHistory

To get Order History in a given time interval for a particular client

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);



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const OrderHistory = apiConnect.OrderHistory(StartDate, EndDate).then(function(result) {

  }).catch((err) => {console.log("Error OrderHistory",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.OrderHistory(StartDate, EndDate)

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.orderHistory(StartDate, EndDate);


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/orderhistory/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /comm/orderhistory/{userID}

Parameters

Name In Type Required Description
userID path string true UserId of the client
sDt query string false From Date(MM/DD/YYYY)
eDt query string false To Date((MM/DD/YYYY)

Example responses

200 Response

{
  "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"
      }
    ]
  }
}

Responses

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

Commodity-Reports

Retrieves the client's portfolio with individual position information.

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const Holdings = apiConnect.Holdings().then(function(result) {

  }).catch((err) => {console.log("Error Holdings",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.Holdings()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.holdings();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/reports/detail/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /comm/reports/detail/{userID}

Parameters

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

Example responses

200 Response

{
  "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"
      }
    }
  }
}

Responses

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

Commodity-Limits

To get RMSLimits 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();



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const Limits = apiConnect.Limits().then(function(result) {

  }).catch((err) => {console.log("Error Limits",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.Limits()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.limits();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/limits/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /comm/limits/{userID}

Parameters

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

Example responses

200 Response

{
  "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"
    }
  }
}

Responses

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

Commodity-OrderBook

To get Order details for a particular client

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
   const orderBook = apiConnect.OrderBook().then(function(result) {

  }).catch((err) => {console.log("Error orderBook",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.OrderBook()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.orderBook();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/orderbook/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /comm/orderbook/{userID}

Parameters

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

Enumerated Values

Parameter Value
rTyp PAYOUT
rTyp PAYIN

Example responses

200 Response

{
  "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"
      }
    ]
  }
}

Responses

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

Commodity-TradeBook

To get Trade history for a particular client

Code samples


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



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
     const tradeBook = apiConnect.TradeBook().then(function(result) {

  }).catch((err) => {console.log("Error tradeBook",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.TradeBook()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.tradeBook();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/tradebook/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /comm/tradebook/{userID}

Parameters

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

Example responses

200 Response

{
  "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"
      }
    ]
  }
}

Responses

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

Commodity-PositionBook

To get Positions 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();



const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract)
apiConnect.Init().then(()=>{
       const NetPosition = apiConnect.NetPosition().then(function(result) {

  }).catch((err) => {console.log("Error NetPosition",err);throw err});
}).catch(console.log("Init Failed"))


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
api_connect.NetPosition()

APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
String response = connect.netPosition();


package main

import (
       "bytes"
       "net/R"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := R.NewRequest("GET", "Rs://emtuat.edelweiss.in/edelmw-eq-uat/comm/positions/{userID}", data)
    req.Header = headers

    client := &R.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /comm/positions/{userID}

Parameters

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

Example responses

200 Response

{
  "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"
  }
}

Responses

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

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);


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const intradayChart = apiConnect
      .getIntradayChart(
        interval,
        assetType,
        symbol,
        exchangeType,
        tillDate,
        includeContinuousFuture
      )
      .then(function (result) {})
      .catch((err) => {
        console.log("Error intradayChart", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err));


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
from constants.asset_type import AssetTypeEnum
from constants.chart_exchange import ChartExchangeEnum
from constants.intraday_interval import IntradayIntervalEnum
response = api_connect.getIntradayChart(ChartExchangeEnum.NSE, AssetTypeEnum.EQUITY, "11423_NSE", IntradayIntervalEnum.H1, TillDate = "2022-01-01", IncludeContinuousFutures = False)


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
connect.getIntradayChart(ChartExchangeEnum exchange, ChartAssetTypeEnum assetType,ChartIntradayIntervalEnum interval, String streamingSymbol,String tillDate, Boolean includeContinuousFuture)

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

Parameters

Parameter
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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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)


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const eodChart = apiConnect
      .getEODChart(
        interval,
        assetType,
        symbol,
        exchangeType,
        tillDate,
        includeContinuousFuture
      )
      .then(function (result) {})
      .catch((err) => {
        console.log("Error eodChart", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err));


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
from constants.asset_type import AssetTypeEnum
from constants.chart_exchange import ChartExchangeEnum
from constants.eod_Interval import EODIntervalEnum
response = api_connect.getEODChart(ChartExchangeEnum.NSE, AssetTypeEnum.EQUITY, "11423_NSE", EODIntervalEnum.D1, TillDate = "2022-01-01", IncludeContinuousFutures = False)


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
connect.getEODChart(ChartExchangeEnum exchange, ChartAssetTypeEnum assetType,ChartEODIntervalEnum interval, String streamingSymbol,String tillDate, Boolean includeContinuousFuture)

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

Parameters

Parameter
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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Live News

Api's related to Live News

News Categories

Categories that user can chose based on his/her discretion

Code samples





 const { APIConnect } = require("api_connect_nodejs");
 const apiConnect = new APIConnect(
   apiKey,
   password,
   reqId,
   downloadContract
 );
 apiConnect
   .Init()
   .then(() => {
     const newsCategories = apiConnect
       .getNewsCategories()
       .then(function (result) {})
       .catch((err) => {
         console.log("Error newsCategories", err);
         throw err;
       });
   })
   .catch((err) => console.log("Init Failed", err));
        
 

from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.getNewsCategories()


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
connect. getNewsCategories();

GET /liveNews/getfiltersandcatagories

Example responses

200 Response


   {
     "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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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);


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const liveNews = apiConnect
      .getLiveNews(category, searchText, holdings, pageNumber)
      .then(function (result) {})
      .catch((err) => {
        console.log("Error liveNews", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err));


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.getLiveNews(holdings = False, category = "Budget", searchText = "price", pageNumber = 1)


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
connect.getLiveNews(String category, boolean holdings, String searchText , String fromDate , int pgNum);

POST /liveNews/general

Parameters

Parameter
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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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);


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const resultAndStocksNews = apiConnect
      .getResultsAndStocksNews(searchText, holdings, pageNumber)
      .then(function (result) {})
      .catch((err) => {
        console.log("Error resultAndStocksNews", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err));


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.getNewsForResultsAndStocks(holdings = False, searchText = "price", pageNumber = 1)


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
connect.getResultsAndStocksNews(boolean holdings, String searchText , String fromDate , int pgNum);

POST /liveNews/general

Parameters

Parameter
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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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);


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const corporateAction = apiConnect
      .getCorporateAction(symbol)
      .then(function (result) {})
      .catch((err) => {
        console.log("Error corporateAction", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err)); 


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.getLatestCorporateActions(symbol = "14977_NSE")


APIConnect connect = new APIConnect(apiKey, api_secret_password, reqID, downloadContract, iniFilePath);
connect.getCorporateActions(String symbol);

GET /events/latestcorpactions/{sym}

Parameters

Parameter
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


  {
    "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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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();


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const watchlistGroups = apiConnect
      .getWatchlistGroups()
      .then(function (result) {})
      .catch((err) => {
        console.log("Error watchlistGroups", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err));        


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.getWatchlistGroups()

GET /accounts/groups

Example responses

200 Response


  {
    "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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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);        


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const watchlistScrips = apiConnect
      .getWatchlistScrips(groupName)
      .then(function (result) {})
      .catch((err) => {
        console.log("Error watchlistScrips", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err));               


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.getWatchlistScrips(GroupName = "MyGroup")

GET /accounts/groups/symbols

Parameters

Parameter
Group_Name Watchlist group

Example responses

200 Response


  {
    "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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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);               


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const createWatchlistGroup = apiConnect
      .createWatchlistGroup(groupName, symLst)
      .then(function (result) {})
      .catch((err) => {
        console.log("Error createWatchlistGroup", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err));                       


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.createWatchlistGroup(GroupName = "MyGroup", Symbols = ["3045_NSE","3456_NSE"])

POST /accounts/groups/{groupName}

Parameters

Parameter
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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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);                


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const deleteWatchlistGroups = apiConnect
      .deleteWatchlistGroups(groups)
      .then(function (result) {})
      .catch((err) => {
        console.log("Error deleteWatchlistGroups", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err));                    


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.deleteWatchlistGroups(GroupNames = ["MyGroup"])

DELETE /accounts/groups

Parameters

Parameter
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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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);               


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const renameWatchlistGroup = apiConnect
      .renameWatchlistGroup(groupName, newGroupName)
      .then(function (result) {})
      .catch((err) => {
        console.log("Error renameWatchlistGroup", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err));                      


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.renameWatchlistGroup(GroupName = "MyGroup", NewGroupName = "MyNewGroup")

PUT /accounts/groups/{groupName}

Parameters

Parameter
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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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);              


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const addSymbolWatchlist = apiConnect
      .addSymbolWatchlist(groupName, symLst)
      .then(function (result) {})
      .catch((err) => {
        console.log("Error addSymbolWatchlist", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err));                   


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.addSymbolsWatchlist(GroupName = "MyGroup", Symbols = ["3495_NSE","-29"])

PUT /accounts/groups/{groupName}

Parameters

Parameter
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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

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);               


const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(
  apiKey,
  password,
  reqId,
  downloadContract
);
apiConnect
  .Init()
  .then(() => {
    const deleteSymbolWatchlist = apiConnect
      .deleteSymbolWatchlist(groupName, symLst)
      .then(function (result) {})
      .catch((err) => {
        console.log("Error deleteSymbolWatchlist", err);
        throw err;
      });
  })
  .catch((err) => console.log("Init Failed", err));                      


from APIConnect.APIConnect import APIConnect
api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')
response = api_connect.deleteSymbolsWatchlist(GroupName = "MyGroup", Symbols = ["3495_NSE","-29"])

PUT /accounts/groups/{groupName}

Parameters

Parameter
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 PlaceTradeDao
401 Unauthorized Session Expired SessionExpired
default Default unexpected error CommonErrorResponse

Instruments

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

instruments and mfInstruments 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);





#Callback Method Sample

const callBackMethod = (error, data, socketClose) => {
if (error) {
console.log('error is ',error)
}

if (data) {
console.log('data is ',data)
}

if (socketClose) {
console.log('socket closed ')
}
}

const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract);
apiConnect.Init().then(() => {
const quotesStreamer = apiConnect.initQuotesStreaming();
quotesStreamer.subscribeReducedQuotesFeed(symbols, callBack);
quotesStreamer.unsubscribeReducedQuotesFeed();
})
.catch(console.log("Init Failed"));




  
#Callback Method Sample

def callBack(response)
print(response)

from APIConnect.APIConnect import APIConnect
from feed.reduced_quotes_feed import ReducedQuotesFeed

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

quotes_streamer = api_connect.initReducedQuotesStreaming()
quotes_streamer.subscribeReducedQuotesFeed(symbols,  callBack)



#Callback Method Sample

import com.apiconnect.lib.interfaces.CallBack;
private class SubscriberCallback implements CallBack {
      @Override
      public void subscribeStreaming(String response) throws IOException {
          try{
              System.out.println("Streaming response is " + response);
          }catch (Exception ex){
              out.println("Error inside SubscriberCallback subscribeStreaming method" + ex.getMessage());
          }
      }
  }

import com.apiconnect.lib.APIConnect;
APIConnect connect = new APIConnect(apiKey,password,reqId,true,iniFilePath);
IQuotesFeed quotesFeed = connect.initQuotesStreaming();
quotesFeed.subscribeReducedQuotesFeed(symbols,callback);



Parameters



  
    

      Parameter
      
    

  
  
    

      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();        









quotes_streamer.unsubscribeReducedQuotesFeed()



quotesFeed.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":"--",
         "spotPrc":"0.00",
         "sym":"2885_NSE",
         "tBQ":"297310",
         "tSQ":"571992",
         "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);





#Callback Method Sample

const callBackMethod = (error, data, socketClose) => {
if (error) {
console.log('error is ',error)
}

if (data) {
console.log('data is ',data)
}

if (socketClose) {
console.log('socket closed ')
}
}

const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract);
apiConnect.Init().then(() => {
const miniquotesStreamer = apiConnect.initMiniQuoteStreaming();
miniquotesStreamer.subscribeMiniQuoteFeed(symbols, callBack);
miniquotesStreamer.unsubscribeMiniQuoteFeed();
})
.catch(console.log("Init Failed"));




  
#Callback Method Sample

def callBack(response)
print(response)

from APIConnect.APIConnect import APIConnect
from feed.miniQuote_feed import MiniQuoteFeed

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

mini_quotes_streamer = api_connect.initMiniQuoteStreaming()
mini_quotes_streamer.subscribeMiniQuoteFeed(symbols,  callBack)



#Callback Method Sample

import com.apiconnect.lib.interfaces.CallBack;
private class SubscriberCallback implements CallBack {
      @Override
      public void subscribeStreaming(String response) throws IOException {
          try{
              System.out.println("Streaming response is " + response);
          }catch (Exception ex){
              out.println("Error inside SubscriberCallback subscribeStreaming method" + ex.getMessage());
          }
      }
  }

import com.apiconnect.lib.APIConnect;
APIConnect connect = new APIConnect(apiKey,password,reqId,true,iniFilePath);
IMiniQuoteFeed miniquotesFeed = connect.initMiniQuoteStreaming();
miniquotesFeed.subscribeMiniQuoteFeed(symbols,callback);



Parameters



  
    

      Parameter
      
    

  
  
    

      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_streamer.unsubscribeMiniQuoteFeed()



miniquotesFeed.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":"--",
         "sym":"2885_NSE",
         "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);





#Callback Method Sample

const callBackMethod = (error, data, socketClose) => {
if (error) {
console.log('error is ',error)
}

if (data) {
console.log('data is ',data)
}

if (socketClose) {
console.log('socket closed ')
}
}

const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract);
apiConnect.Init().then(() => {
const depthStreamer = apiConnect.initDepthStreaming();
depthStreamer.subscribeDepthFeed(symbols, callBack);
depthStreamer.unsubscribeDepthFeed();
})
.catch(console.log("Init Failed"));




  
#Callback Method Sample

def callBack(response)
print(response)

from APIConnect.APIConnect import APIConnect
from feed.depth_feed import DepthFeed

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

depth_streamer = api_connect.initDepthStreaming()
depth_streamer.subscribeDepthFeed(symbols,  callBack)



#Callback Method Sample

import com.apiconnect.lib.interfaces.CallBack;
private class SubscriberCallback implements CallBack {
      @Override
      public void subscribeStreaming(String response) throws IOException {
          try{
              System.out.println("Streaming response is " + response);
          }catch (Exception ex){
              out.println("Error inside SubscriberCallback subscribeStreaming method" + ex.getMessage());
          }
      }
  }

import com.apiconnect.lib.APIConnect;
APIConnect connect = new APIConnect(apiKey,password,reqId,true,iniFilePath);
IDepthFeed depthFeed = connect.initDepthStreaming();
depthFeed.subscribeDepthFeed(symbols,callback);



Parameters



  
    

      Parameter
      
    

  
  
    

      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_streamer.unsubscribeDepthFeed()



depthFeed.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);


    
    

  #Callback Method Sample

  const callBack = (error, data, socketClose) => {
  if (error) {
    console.log('error is ',error)
  }

  if (data) {
    console.log('data is ',data)
  }

  if (socketClose) {
    console.log('socket closed ')
  }
}

const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract);
apiConnect.Init().then(() => {
const ordersStreamer = apiConnect.initOrdersStreaming(accId, userId);
ordersStreamer.subscribeOrdersFeed(callBack);
ordersStreamer.unsubscribeOrdersFeed();
})
.catch(console.log("Init Failed"));


    
    
      
#Callback Method Sample

def callBack(response)
    print(response)

from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

orders_streamer = api_connect. initOrdersStreaming(acc_id, user_id)
orders_streamer.subscribeOrdersFeed(callBack)


    


#Callback Method Sample

  import com.apiconnect.lib.interfaces.CallBack;
  private class SubscriberCallback implements CallBack {
              @Override
              public void subscribeStreaming(String response) throws IOException {
                  try{
                      System.out.println("Streaming response is " + response);
                  }catch (Exception ex){
                      out.println("Error inside SubscriberCallback subscribeStreaming method" + ex.getMessage());
                  }
              }
  
import com.apiconnect.lib.APIConnect;
APIConnect connect = new APIConnect(apiKey,password,reqId,true,iniFilePath);
IOrdersFeed ordersFeed = connect.initOrdersStreaming(accId,userId);
ordersFeed.subscribeOrdersFeed(callback);


    
Parameters

    

      
        

          Parameter
          
        

      
      
        

          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();


  
  



  
  
    orders_streamer.unsubscribeOrdersFeed()


  

ordersFeed.unsubscribeOrdersFeed(callback);





Live News Streamer




Properties

      

        
          

            Parameter
            
            
          

        
        
          

            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);
  

    
    

#Callback Method Sample

  const callBack = (error, data, socketClose) => {
  if (error) {
    console.log('error is ',error)
  }

  if (data) {
    console.log('data is ',data)
  }

  if (socketClose) {
    console.log('socket closed ')
  }
}

const { APIConnect } = require("api_connect_nodejs");
const apiConnect = new APIConnect(apiKey, api_secret_password, reqId, downloadContract);
apiConnect.Init().then(() => {
const newsStreamer = apiConnect.initLiveNewsStreaming();
newsStreamer.subscribeLiveNewsFeed(callBack);
newsStreamer.unsubscribeLiveNewsFeed();
})
.catch(console.log("Init Failed"));
  

    
    
      
 #Callback Method Sample

def callBack(response)
    print(response)  

from APIConnect.APIConnect import APIConnect

api_connect = APIConnect(apiKey, api_secret_password, reqId, downloadContract=True, 'settings.ini')

news_streamer = api_connect.initLiveNewsStreaming()
news_streamer.subscribeLiveNewsFeed(callBack)


    

#Callback Method Sample

    import com.apiconnect.lib.interfaces.CallBack;
    private class SubscriberCallback implements CallBack {
                @Override
                public void subscribeStreaming(String response) throws IOException {
                    try{
                        System.out.println("Streaming response is " + response);
                    }catch (Exception ex){
                        out.println("Error inside SubscriberCallback subscribeStreaming method" + ex.getMessage());
                    }
                }
    
import com.apiconnect.lib.APIConnect;
APIConnect connect = new APIConnect(apiKey,password,reqId,true,iniFilePath);
ILiveNewsFeed liveNewsFeed = connect.initLiveNewsStreaming();
liveNewsFeed.subscribeLiveNewsFeed(callback);
  

  
Unsubscribe

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




apiconnect.initLiveNewsStreaming().UnsubscribeLiveNewsFeed();









  news_streamer.unsubscribeLiveNewsFeed()




liveNewsFeed.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
          

        
      

      
GTCGTD

      

        
        
        
      

      
"GTC"



      
Order validity, GTD/GTC

      
Properties

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            string
            false
            none
            Order validity, GTD/GTC
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            anonymous
            GTC
          

          

            anonymous
            GTD
          

        
      

      
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
            CommonResponseWrapper
            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
            VerifyAnswersResponseDao
            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
            CommonResponseWrapper
            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
            OtherAccountDetailsResponseObject
            false
            none
            none
          

          

            mrgPopUp
            boolean
            false
            none
            none
          

          

            mrgAccDts
            MergeAccountDetailsResponseObject
            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
            DefaultProductTypesObject
            false
            none
            none
          

          

            dfPrdsMTF
            DefaultProductTypesObject
            false
            none
            none
          

          

            ordTypes
            [KeyValueResponseObject]
            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
            AccountDetailsResponeObject
            false
            none
            none
          

          

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

          

            mtf
            CommonConsentStatusDao
            false
            none
            none
          

          

            comOpCnst
            CommonConsentStatusDao
            false
            none
            none
          

          

            adhrEQ
            AadharStatusDao
            false
            none
            none
          

          

            adhrCOM
            AadharStatusDao
            false
            none
            none
          

          

            cnsntLst
            [ConsentStatusDao]
            false
            none
            consent priority List
          

          

            prdcts
            object
            false
            none
            none
          

          

            » additionalProperties
            object
            false
            none
            none
          

          

            »» additionalProperties
            [string]
            false
            none
            none
          

          

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

          

            val
            [ValidityExchangeObject]
            false
            none
            List of validity corresponding to exchange
          

          

            gtdGtcValDays
            string
            false
            none
            Validity days for GTC/GTD product
          

          

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

          

            optCnsts
            [ConsentStatusDao]
            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
            [SegmentType]
            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
            BuySellObject
            false
            none
            none
          

          

            bse
            BuySellObject
            false
            none
            none
          

          

            nfo
            BuySellObject
            false
            none
            none
          

          

            bfo
            BuySellObject
            false
            none
            none
          

          

            cds
            BuySellObject
            false
            none
            none
          

          

            mcx
            BuySellObject
            false
            none
            none
          

          

            ncdex
            BuySellObject
            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
            [ProductValueResponseObject]
            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
            [ValidityObject]
            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
            [ValidityObject]
            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
            CommonResponseWrapper
            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
            CommonResponseWrapper
            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
          

        
      

      
PlaceGtcGtdTradeRequestDao

      

        
        
        
      

      
{
  "trdSym": "string",
  "exc": "string",
  "action": "BUY",
  "dur": "GTC",
  "ordTyp": "LIMIT",
  "qty": "string",
  "lmPrc": "string",
  "prdCode": "CNC",
  "dtDays": "string",
  "ordSrc": "MOB",
  "vnCode": "NA",
  "oprtn": "<=",
  "srcExp": "string",
  "tgtId": "string",
  "brnchNm": "string",
  "brk": "string",
  "amo": false
}



      
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
            Action
            false
            none
            Action to be performed, BUY/SELL
          

          

            dur
            GTCGTD
            false
            none
            Order validity, GTD/GTC
          

          

            ordTyp
            OrderType
            false
            none
            Order Type
          

          

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

          

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

          

            prdCode
            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 for Orders in dd-MM-yyyy format
          

          

            ordSrc
            string
            false
            none
            Location Indicator
          

          

            vnCode
            string
            false
            none
            Vendor Code
          

          

            oprtn
            string
            false
            none
            Operation
          

          

            srcExp
            string
            false
            none
            Source Expiry
          

          

            tgtId
            string
            false
            none
            Target ID
          

          

            brnchNm
            string
            false
            none
            Branch Name
          

          

            brk
            string
            false
            none
            Broker
          

          

            amo
            boolean
            false
            none
            After Market Order
          

        
      

      
Enumerated Values

      

        
          

            Property
            Value
          

        
        
          

            ordSrc
            MOB
          

          

            ordSrc
            WEB
          

          

            ordSrc
            XMLAPI
          

          

            ordSrc
            TOC
          

          

            vnCode
            NA
          

          

            oprtn
            <=
          

        
      

      
PlaceGtcGtdTradeDao

      

        
        
        
      

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



      
Properties

      
allOf

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            CommonResponseWrapper
            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
            CommonResponseWrapper
            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
            [OrderDetailsResponseObject]
            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
            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
            CommonResponseWrapper
            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
            [EqOrderHistoryResponseObject]
            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
            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
            Action
            false
            none
            Action to be performed, BUY/SELL
          

          

            dur
            Duration
            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
            OrderType
            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
            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
            CommonResponseWrapper
            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
            OrderType
            true
            none
            Order Type
          

          

            prdCode
            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
            CommonResponseWrapper
            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
            [CNCMTFHoldingBlock]
            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
            HoldingRMSObject
            false
            none
            none
          

          

            mtfRmsHdg
            HoldingRMSObject
            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
            CommonResponseWrapper
            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
            ShortFallDao
            false
            none
            Short fall
          

          

            »» mrgAvl
            MarginAvailableDao
            false
            none
            Margin Available
          

          

            »» mrgUtd
            MarginUtilized
            false
            none
            Margin Utilized
          

          

            »» unPstdChrgs
            UnpostedObject
            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
            UnpostedCollectionDao
            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
            Action
            false
            none
            Action to be performed, BUY/SELL
          

          

            dur
            Duration
            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
            OrderType
            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
            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
            CommonResponseWrapper
            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
            [PositionSquareOffResponseObject]
            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
            CommonResponseWrapper
            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
            [OrderBookResponseObject]
            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
            CommonResponseWrapper
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» trade
            [EqTradeBookResponseObject]
            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
            CommonResponseWrapper
            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
            TransferStatusObject
            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
            CommonResponseWrapper
            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
            [NetPositionsObject]
            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
            Action
            false
            none
            Action to be performed, BUY/SELL
          

          

            dur
            Duration
            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
            OrderType
            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
            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
            CommonResponseWrapper
            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
            CommonResponseWrapper
            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
            Action
            false
            none
            Action to be performed, BUY/SELL
          

          

            qty
            string
            false
            none
            Quantity of the scrip to transact
          

          

            dur
            Duration
            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
            [BasketOrder]
            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
            OrderType
            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
            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
            [BracketOrderObject]
            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
            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
            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
            Action
            false
            none
            Action to be performed, BUY/SELL
          

          

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

          

            ordTyp
            OrderType
            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
            OrderBookCommonResponseObject
            false
            none
            none
          

          

            slLg
            OrderBookCommonResponseObject
            false
            none
            none
          

          

            tgtLg
            OrderBookCommonResponseObject
            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
            Duration
            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
            OrderType
            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
            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
            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
            OrderType
            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
            CommonResponseWrapper
            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
            CommonResponseWrapper
            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
            OrderType
            true
            none
            Order Type
          

          

            action
            Action
            false
            none
            Action to be performed, BUY/SELL
          

          

            prdCode
            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
            PrdCode
            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
            CommonResponseWrapper
            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
            [ComOrderDetailsResponseObject]
            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
            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
            CommonResponseWrapper
            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
            [ComOrderHistoryResponseObject]
            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
            OrderType
            false
            none
            Order Type
          

          

            dur
            string
            false
            none
            none
          

          

            prdCode
            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
            CommonResponseWrapper
            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
            [CommPortfolioScrip]
            false
            none
            none
          

          

            »» smry
            ComPortfolioSummaryDao
            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
            ComPortfolioSummaryDataDao
            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
            CommonResponseWrapper
            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
            ComRMSLimitsObject
            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
            CommonResponseWrapper
            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
            CommonResponseWrapper
            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
            [ComOrderBookResponseObject]
            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
            CommonResponseWrapper
            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
            [ComTradeBookResponseObject]
            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
            CommonResponseWrapper
            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
            [ComPositionBookObject]
            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
            OrderType
            false
            none
            Order Type
          

          

            rcvTim
            string
            false
            none
            none
          

          

            dur
            string
            false
            none
            none
          

          

            vlDt
            string
            false
            none
            Order validity data -GTC/GTD
          

          

            prdCode
            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
            OrderType
            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
            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
            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
            CommonResponseWrapper
            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
            CommonResponseWrapper
            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
            CommonResponseWrapper
            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
            [MFSSHoldingsObject]
            false
            none
            List of Usable holdings
          

          

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

          

            »» nonUsable
            [ELSSReportIndividualHoldings]
            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
            CommonResponseWrapper
            false
            none
            none
          

        
      

      
and

      

        
          

            Name
            Type
            Required
            Restrictions
            Description
          

        
        
          

            anonymous
            object
            false
            none
            none
          

          

            » data
            object
            false
            none
            none
          

          

            »» ordLst
            [DIONReportReconciliation]
            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
            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
            [PhysicalHoldingsQty]
            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.8] - 2024-06-28 

      
Added

      

      
[2.0.7] - 2024-03-18 

      
Added

      

      
[2.0.5] - 2023-12-29 

      
Added

      

      
[2.0.4] - 2023-11-03 

      
Added

      
      
Changed

      

      
[2.0.3] - 2023-07-28 

      
Added

      
      
Note

      

      
[2.0.2] - 2023-05-20 

      
Added

      
      
Changed

      
          
      
[2.0.0] - 2022-12-16 

      
Added

      
      
Changed

      
      

      
[1.0.3] - 2022-08-30 

      
Added

      
      
Changed

      
      
      

      
[1.0.2] - 2021-07-29 

      
Added

      
      
Changed

      
      
     
      

      
      
Node

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


      
[2.0.13] - 2024-06-28 

      
Added

      

      
[2.0.12] - 2024-03-18 

      
Added

      

      
[2.0.11] - 2023-12-29 

      
Added

      

      
[2.0.10] - 2023-11-03 

      
Added

      
      
Changed

      

      
[2.0.5] - 2023-07-28 

      
Added

      
      
Note

      

      
[2.0.4] - 2023-05-20 

      
Added

      
      
Changed

      
      
      
[2.0.0] - 2022-12-16 

      
Added

      
      
Changed

      
      


      
[1.0.1] - 2022-08-30

      
Added

      
      
Changed

      
      
      

      
      
      
      

      
      
Java

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


      
[2.0.7] - 2024-06-28 

      
Added

      

      
[2.0.6] - 2024-03-18 

      
Added

      

      
[2.0.5] - 2023-12-29 

      
Added

      

      
[2.0.4] - 2023-11-03 

      
Added

      
      
Changed

      

      
[2.0.2] - 2023-07-28 

      
Added

      
      
Note

      

      
[2.0.1] - 2023-05-20 

      
Added

      
      
Changed

      

      
[2.0.0] - 2022-12-16 

      
Added

      
      
Changed

      
      


      
[1.0.1] - 2022-08-30

      
Added

      
      
Changed

      
      
   
    


    


      


        

        Node


        Python


        Java