Official Java Bridge for accessing Stocknote API
This documentation covers details of the Java bridge / SDK provided by SAMCO, for accessing the SAMCO Trade API.
Java SDK is created for users to easily access our Stocknote API platform from Java based applications.
Java SDK will be exposed as a downloadable JAR file
Include the JAR file in your build path and access the trade APIs using the inbuilt classes in Java SDK
Different Java classes and methods are exposed in the SDK for handling different Trade API
As an initial step, users need to use the Login method for connecting to APIs and in the Java response bean object you will get user session identifier. Using the session identifier, users can access other API’s
With StockNote API being a REST based interface and it uses JSON request and response messages, Java SDK provides request and response objects as native Java beans (after appropriate serialisation / de-serialisation)
For specific details on parameters passed on the request, and details about API response, please refer our Trade API documentation.
Get StockNote Java Bridge Jar from the below link
Setup Jar File
For maven user
Install jar file into your local .m2 repository using the below command :
mvn install:install-file -Dfile="[path to jar]/java_sdk.jar" -DlocalRepositoryPath="[path to repo]/repo" -DgroupId=io.samco -DartifactId=stocknote-bridge-java -Dversion=3.0.0 -Dpackaging=jar
Add the below dependency into pom.xml file .
<dependency>
<groupId>io.samco</groupId>
<artifactId>stocknote-bridge-java</artifactId>
<version>3.0.0</version>
</dependency>For gradle user use the same maven command for install jar into local repository
repositories { mavenLocal() }
dependencies { implementation 'io.samco:stocknote-bridge-java:3.0.0' }
Adding jar to build path in eclipse based IDE's
Goto JavaBuild Path --> Libraries --> Add External JARs --> Include stocknote-bridge-java-3.0.0.jar
Java Bridge allows user authentication using UserLoginApi. A valid StockNote Trading Account and subscription to StockNote API Services is a pre-requisite for successful authentication.
userId, password, yobUserLoginApi userLoginApi = new UserLoginApi();
LoginRequest loginRequest = new LoginRequest();
loginRequest.setUserId(userId);
loginRequest.setPassword(password);
loginRequest.setYob(yob);
LoginResponse loginResponse = userLoginApi.login(loginRequest);{
"serverTime": "26/05/20 13:50:32",
"msgId": "c662bbd1-0b24-4e86-a3d9-8c89d7529f2c",
"sessionToken": "e0875f4aa3660b72ec636b0553acc7a9",
"accountID": "client_id",
"accountName": "client_name",
"exchangeList": [
"BSE",
"MCX",
"CDS",
"NSE"
],
"orderTypeList": [
"L",
"MKT",
"SL"
],
"productList": [
"CNC",
"CO",
"MIS"
]}
The Index Data API shows the user's personal index. It shows the overall profit and loss of all the trades done by the user.
IndexDataAPI indexdataApi = new IndexDataAPI();
IndexDataResponse indexresponse = indexdataApi.getindexData(xSessionToken);
{
"serverTime": "03/06/24 18:46:17",
"msgId": "0cb0cf30-4b27-494e-9048-6313671cf00a",
"status": "Success",
"statusMessage": "Index Data retrieved successfully",
"indexData": {
"indexName": "MOHAMMAD Index",
"networth": "269.53",
"indexData": {
"index": "1.72",
"indexChange": "0.05",
"indexChangePercentage": "3.01",
"latestTime": "2024-06-03 17:01:00",
"networthChange": "7.88",
"networthChangePercentage": "3.01",
"fundReceipt": "0.00"
}
}
}This API is used to search equity, derivatives and commodity scrips based on user provided search symbol and exchange name.
xSessionToken, exchange, searchSymbolNameSearchEquityDerivativeApi api = new SearchEquityDerivativeApi();
EquitySearchResponse searchEquityDerivative = api.searchEquityDerivative(xSessionToken, "GOLD", SamcoConstants.EXCHANGE_MFO);{
"msgId" : "7356eb6b-ab17-4b2c-84e7-46c9280e15d4",
"status" : "Success",
"statusMessage" : "Request Successful",
"commodityValues" : [ {
"tradingSymbol" : "GOLD20FEBFUT",
"instrumentName" : "FUTCOM",
"quantityInLots" : "9304",
"exchange" : "MFO"
}, {
"tradingSymbol" : "GOLDM20FEBFUT",
"instrumentName" : "FUTCOM",
"quantityInLots" : "15258",
"exchange" : "MFO"
}, {
"tradingSymbol" : "GOLDM20MARFUT",
"instrumentName" : "FUTCOM",
"quantityInLots" : "1650",
"exchange" : "MFO"
}, {
"tradingSymbol" : "GOLDPETAL20APRFUT",
"instrumentName" : "FUTCOM",
"quantityInLots" : "0",
"exchange" : "MFO"
} ]
}This API can be used to get market depth details for a specific equity scrip including but not limited to values like last trade price, previous close price, change value, change percentage, bids/asks, upper and lower circuit limits etc. This helps user with market picture of an equity scrip using which he will be able to place an order.
xSessionToken, exchange, symbolNameQuoteApi quoteApi = new QuoteApi();
MarketDepthResponse quote = quoteApi.getQuote(xSessionToken, "SBIN", SamcoConstants.EXCHANGE_NSE);{
"serverTime": "26/05/20 14:09:56",
"msgId": "70414ca5-230e-467b-81cb-62af0a5f2b95",
"status": "Success",
"statusMessage": "Quote details retrieved successfully",
"symbolName": "SBIN",
"tradingSymbol": "SBIN-EQ",
"exchange": "NSE",
"companyName": "STATE BANK OF INDIA",
"lastTradedTime": "26/05/2020 14:09:55",
"lastTradedPrice": "151.00",
"previousClose": "150.85",
"changeValue": "0.15",
"changePercentage": "0.10",
"lastTradedQuantity": "16",
"lowerCircuitLimit": "135.80",
"upperCircuitLimit": "165.90",
"averagePrice": "151.96",
"openValue": "152.40",
"highValue": "153.20",
"lowValue": "150.55",
"closeValue": "150.85",
"totalBuyQuantity": "3140492",
"totalSellQuantity": "9899407",
"totalTradedValue": "592.47019 (Crs)",
"totalTradedVolume": "38988562",
"yearlyHighPrice": "373.80",
"yearlyLowPrice": "149.45",
"bestBids": [
{
"number": "1",
"quantity": "9105",
"price": "150.95"
},
{
"number": "2",
"quantity": "16880",
"price": "150.90"
},
{
"number": "3",
"quantity": "20776",
"price": "150.85"
},
{
"number": "4",
"quantity": "38364",
"price": "150.80"
},
{
"number": "5",
"quantity": "23566",
"price": "150.75"
}
],
"listingId": "3045_NSE"
}Getting Index Quote details for a specific Indicies. This helps user with market picture of an specific Index Details.
xSessionToken, exchange, symbolNameQuoteApi quoteApi = new QuoteApi();
IndexDetailsResponse indexQuote = quoteApi.getIndexQuote(xSessionToken, "NIFTY 50");{
"serverTime": "03/06/24 18:19:04",
"msgId": "8c5dbe1f-cb01-4fd8-a5e9-49202bd4a121",
"status": "Success",
"statusMessage": "Index Quote details retrieved successfully",
"indexDetails": [
{
"indexName": "Nifty 50",
"listingId": "-21",
"lastTradedTime": "2024-06-03 15:32:05.0",
"spotPrice": 23263.9,
"changePercentage": 3.25,
"averagePrice": 0.0,
"openValue": 23337.9,
"highValue": 23338.7,
"lowValue": 23062.3,
"closeValue": 23263.9,
"totalBuyQuantity": 0,
"totalSellQuantity": 0,
"totalTradedValue": 0,
"totalTradedVolume": 0,
"change": 733.2
}
]
}
xSessionToken, BSE, NSE,NFO,BFO,INDEX,CDS,MFO,MCXMap<String, List<String>> multiQuoteRequest = new HashMap<>();
multiQuoteRequest.put("NSE", Arrays.asList("BAJAJ-AUTO"));
multiQuoteRequest.put("BSE", Arrays.asList("INFY"));
MultiQuoteAPI multiQuoteService = new MultiQuoteAPI();
MultiQuoteResponse response = multiQuoteService.postMultiQuote(xSessionToken, multiQuoteRequest);{
"serverTime": "03/06/24 18:49:07",
"msgId": "6dcbebfd-4d91-4b42-85c1-c8d094f705da",
"status": "Success",
"statusMessage": "Multiquotes data retrieved successfully",
"invalidSymbol": [
"BAJAJ-AUTOs"
],
"multiQuotes": [
{
"exchange": "BSE",
"symbolName": "INFY",
"tradingSymbol": "INFY",
"companyName": "INFOSYS LTD.",
"isin": "INE009A01021",
"lotSize": "1",
"averagePrice": "1404.00",
"totalTradeVolume": "182274",
"symbol": "500209_BSE",
"lastTradeTime": "03 Jun 2024, 04:01:44 PM",
"lastTradeQuantity": "14",
"lastTradePrice": "1405.90",
"misMultiplier": "4.00",
"change": "-0.35",
"changePercent": "-0.02",
"open": "1435.15",
"close": "1405.90",
"previousClose": "1406.25",
"low": "1404.00",
"high": "1439.05",
"tickSize": "0.05",
"bidSize": "0",
"bidPrice": "0.00",
"totalTradedValue": "257144870.02",
"askSize": "0",
"askPrice": "0.00"
}
]
}
xSessionToken, exchange, tradingSymbol, qtySpanMarginRequest spanMarginRequest = new SpanMarginRequest();
List<SpanMarginRequestItem> requestItems = new ArrayList<>();
requestItems.add(new SpanMarginRequestItem("NFO", "NIFTY06JUN2423200PE", "25"));
requestItems.add(new SpanMarginRequestItem("NFO", "NIFTY24JUNFUT", "25"));
spanMarginRequest.setRequest(requestItems);
SpanMarginAPI spanMarginService = new SpanMarginAPI();
SpanMarginResponse spanresponse = spanMarginService.postSpanMarginData(xSessionToken, spanMarginRequest);{
"serverTime": "03/06/24 19:31:08",
"msgId": "9988d21e-c5d6-4e18-a024-5cdc21004dda",
"status": "Success",
"statusMessage": "Span margin calculated",
"spanDetails": {
"totalRequirement": "13666.21",
"spanRequirement": "1941.21",
"exposureMargin": "11725.00",
"spreadBenefit": "00.00"
}
}To search OptionChain for equity, derivatives and commodity scrips based on user provided search symbol and exchange name.
xSessionToken, searchSymbolName, exchange, expiryDate, strikePrice, optionType
OptionApi optionApi = new OptionApi();
OptionChainResponse optionChainResponse = optionApi.getOptionContracts(xSessionToken, "INFY", SamcoConstants.EXCHANGE_NSE, "2020-06-25", "950", "CE");
{
"serverTime" : "01/06/20 18:49:55",
"msgId" : "5e1e2e47-6565-457e-9d10-4e2b7d09d15b",
"status" : "Success",
"statusMessage" : "OptionChain details retrived successfully. ",
"optionChainDetails" : [ {
"tradingSymbol" : "INFY20JUN950CE",
"exchange" : "NFO",
"symbol" : "74352_NFO",
"strikePrice" : "950.00",
"expiryDate" : "2020-06-25",
"instrument" : "OPTSTK",
"optionType" : "CE",
"underLyingSymbol" : "INFY",
"spotPrice" : "699.55",
"lastTradedPrice" : "0.00",
"openInterest" : "0",
"openInterestChange" : "0",
"volume" : "0"
}]
}
To search FutureChain for equity, derivatives and commodity scrips based on user provided search symbol and exchange name.
xSessionToken, searchSymbolName, exchange, expiryDate, strikePrice, optionType
FutureAPI futureApi = new FutureAPI();
FutureChainResponse futureChainResponse = futureApi.getFutureContracts(xSessionToken, "ITC","NFO", "2024-06-27");
{
"serverTime": "03/06/24 18:16:22",
"msgId": "8f9113de-bc27-4d14-be92-71426e024c32",
"status": "Success",
"statusMessage": "Future chain details retrived successfully. ",
"futureChainDetails": [
{
"tradingSymbol": "ITC24JUNFUT",
"exchange": "NFO",
"symbol": "52178_NFO",
"expiryDate": "2024-06-27",
"instrument": "FUTSTK",
"underLyingSymbol": "ITC",
"spotPrice": 430.35,
"lastTradedPrice": "426.75",
"openInterest": 107800000,
"openInterestInLot": 67375,
"openInterestChange": 1196800,
"openInterestChangeInLot": 748,
"oichangePer": "1.12",
"volume": 24145600,
"bestBids": [
{
"number": 1,
"quantity": "1600",
"price": "426.7000"
},
{
"number": 2,
"quantity": "1600",
"price": "426.5000"
},
{
"number": 3,
"quantity": "3200",
"price": "426.4500"
},
{
"number": 4,
"quantity": "17600",
"price": "426.4000"
},
{
"number": 5,
"quantity": "3200",
"price": "426.3500"
}
],
"bestAsks": [
{
"number": 1,
"quantity": "1600",
"price": "426.7500"
},
{
"number": 2,
"quantity": "4800",
"price": "426.8000"
},
{
"number": 3,
"quantity": "4800",
"price": "426.8500"
},
{
"number": 4,
"quantity": "4800",
"price": "426.9000"
},
{
"number": 5,
"quantity": "17600",
"price": "426.9500"
}
]
}
]
}
Gets the user cash balances, available margin for trading in equity and commodity segments.
xSessionToken
UserLimitsApi userLimitsApi = new UserLimitsApi();
LimitResponse limits = userLimitsApi.getLimits(xSessionToken);
{
"serverTime" : "29/05/20 15:34:05",
"msgId" : "7792c01b-618d-46b5-86d2-1a1c647c72d0",
"equityLimit" : {
"grossAvailableMargin" : "50000000000",
"payInToday" : "0",
"notionalCash" : "0",
"marginUsed" : "92",
"netAvailableMargin" : "49999999908"
},
"commodityLimit" : {
"grossAvailableMargin" : "0",
"payInToday" : "0",
"notionalCash" : "0",
"marginUsed" : "0",
"netAvailableMargin" : "0"
}
}
To place an equity/derivative order with the exchange i.e the place order request typically registers the order with OMS and when it happens successfully, a success response is returned. Successful placement of an order via the API does not imply its successful execution. So when an order is successfully placed the PlaceOrder API returns an OrderNumber in response, and the actual order status can be checked separately using the OrderStatus API call .This is for Placing CNC, MIS and NRML Orders.
xSessionToken, symbolName, exchange, transactionType, orderType, price, quantity, disclosedQuantity, orderValidity, productType, marketProtection, afterMarketOrderFlag
OrdersApi ordersApi = new OrdersApi();
OrderRequest orderRequest = new OrderRequest();
orderRequest.setSymbolName("RELIANCE");
orderRequest.setExchange(SamcoConstants.EXCHANGE_BSE);
orderRequest.setTransactionType(SamcoConstants.TRANSACTION_TYPE_BUY);
orderRequest.setOrderType(SamcoConstants.ORDER_TYPE_MARKET);
orderRequest.setQuantity("2");
orderRequest.setDisclosedQuantity("");
orderRequest.setOrderValidity(SamcoConstants.VALIDITY_DAY);
orderRequest.setProductType(SamcoConstants.PRODUCT_MIS);
orderRequest.setAfterMarketOrderFlag("NO");
OrderResponse placeOrder = ordersApi.placeOrder(xSessionToken, orderRequest);
{
"serverTime" : "29/05/20 12:43:06",
"msgId" : "f1330206-cb2f-42eb-9925-b7d825c07bdd",
"orderNumber" : "200529000000059",
"status" : "Success",
"statusMessage" : "MIS Order request placed successfully",
"exchangeOrderStatus" : "PENDING",
"orderDetails" : {
"pendingQuantity" : "2",
"avgExecutionPrice" : "0.00",
"orderPlacedBy" : "--",
"tradingSymbol" : "RELIANCE",
"triggerPrice" : "0.00",
"exchange" : "BSE",
"totalQuantity" : "2",
"transactionType" : "BUY",
"productType" : "MIS",
"orderType" : "L",
"quantity" : "2",
"filledQuantity" : "0",
"orderPrice" : "1600.0",
"filledPrice" : "0.00",
"exchangeOrderNo" : "1590728958294000024",
"orderValidity" : "DAY",
"orderTime" : "29/05/2020 12:43:04"
}
}To place an equity/derivative BO order with the exchange i.e the place order BO request typically registers the order with OMS and when it happens successfully, a success response is returned. Successful placement of an order via the API does not imply its successful execution. So when an order is successfully placed the placeOrderBO returns an orderNumber in response, and the actual order status can be checked separately using the orderStatus API call.
xSessionToken, exchange, symbolName, transactionType, orderType, quantity, disclosedQuantity, price, priceType, valueType, orderValidity, productType, squareOffValue, stopLossValue, trailingStopLoss
OrdersApi ordersApi = new OrdersApi();
OrderRequestBO orderRequest = new OrderRequestBO();
orderRequest.setSymbolName("TCS");
orderRequest.setExchange(SamcoConstants.EXCHANGE_BSE);
orderRequest.setTransactionType(SamcoConstants.TRANSACTION_TYPE_BUY);
orderRequest.setOrderType(SamcoConstants.ORDER_TYPE_MARKET);
orderRequest.setQuantity("10");
orderRequest.setDisclosedQuantity("1");
orderRequest.setPrice("2000");
orderRequest.setPriceType("LTP");
orderRequest.setValueType("Absolute");
orderRequest.setOrderValidity(SamcoConstants.VALIDITY_DAY);
orderRequest.setProductType(SamcoConstants.PRODUCT_BO);
orderRequest.setSquareOffValue("100");
orderRequest.setStopLossValue("50");
orderRequest.setTrailingStopLoss("30");
OrderResponseBO placeOrderBO = ordersApi.placeOrderBO(xSessionToken, orderRequest);
{
"serverTime" : "01/06/20 14:58:38",
"msgId" : "de2d8caf-b76d-4a24-bb6c-fa654ed355bb",
"orderNumber" : "200601000000133",
"status" : "Success",
"statusMessage" : "Bracket Order request placed successfully",
"exchangeOrderStatus" : "EXECUTED",
"orderDetails" : {
"pendingQuantity" : "0",
"avgExecutionPrice" : "669.00",
"orderPlacedBy" : "--",
"tradingSymbol" : "INFY-EQ",
"triggerPrice" : "0.00",
"exchange" : "NSE",
"totalQuantity" : "10",
"transactionType" : "BUY",
"productType" : "BO",
"orderType" : "L",
"quantity" : "10",
"filledQuantity" : "10",
"orderPrice" : "669.0",
"filledPrice" : "669.00",
"exchangeOrderNo" : "1100000000030886",
"orderValidity" : "DAY",
"orderTime" : "01/06/2020 14:58:36"
}
}To place an equity/derivative CO order with the exchange i.e the place order CO request typically registers the order with OMS and when it happens successfully, a success response is returned. Successful placement of an order via the API does not imply its successful execution. So when an order is successfully placed the placeOrderCO returns an orderNumber in response, and in scenarios as above the actual order status can be checked separately using the orderStatus API call.
xSessionToken, symbolName, exchange, transactionType, orderType, price, quantity, disclosedQuantity, orderValidity, productType, marketProtection, triggerPriceOrdersApi ordersApi = new OrdersApi();
OrderRequestCO orderRequest = new OrderRequestCO();
orderRequest.setSymbolName("RELIANCE");
orderRequest.setExchange(SamcoConstants.EXCHANGE_NSE);
orderRequest.setTransactionType(SamcoConstants.TRANSACTION_TYPE_BUY);
orderRequest.setOrderType(SamcoConstants.ORDER_TYPE_MARKET);
orderRequest.setQuantity("15");
orderRequest.setDisclosedQuantity("");
orderRequest.setOrderValidity(SamcoConstants.VALIDITY_DAY);
orderRequest.setProductType(SamcoConstants.PRODUCT_CO);
orderRequest.setTriggerPrice("1300");
OrderResponseCO placeOrderCO = ordersApi.placeOrderCO(xSessionToken, orderRequest);{
"serverTime" : "01/06/20 14:36:34",
"msgId" : "b0d3192d-824f-4493-90cf-4657e827742e",
"orderNumber" : "200601000000129",
"status" : "Success",
"statusMessage" : "CO Order request placed successfully",
"exchangeOrderStatus" : "EXECUTED",
"orderDetails" : {
"pendingQuantity" : "0",
"avgExecutionPrice" : "669.00",
"orderPlacedBy" : "--",
"tradingSymbol" : "INFY-EQ",
"triggerPrice" : "650.00",
"exchange" : "NSE",
"totalQuantity" : "15",
"transactionType" : "BUY",
"productType" : "CO",
"orderType" : "L",
"quantity" : "15",
"filledQuantity" : "15",
"orderPrice" : "689.05",
"filledPrice" : "669.00",
"exchangeOrderNo" : "1100000000030191",
"orderValidity" : "DAY",
"orderTime" : "01/06/2020 14:36:32"
}
}User would be able to modify some attributes of an order as long as it is with open/pending status in system. For modification order identifier is mandatory. With order identifier you need to send the optional parameter(s) which needs to be modified. In case the optional parameters aren't sent, the default will be considered from the original order. Modifiable attributes include quantity, Order Type (L,MKT, SL,SL-M). This API cannot be used for modifying attributes of an executed/rejected/cancelled order. Only the attribute that needs to be modified should be sent in the request alongwith the Order Identifier.
xSessionToken, orderNumber, orderType, quantity, disclosedQuantity, orderValidity, price, triggerPrice, parentOrderId, marketProtectionOrdersApi ordersApi = new OrdersApi();
ModifyOrderRequest modifyOrderRequest = new ModifyOrderRequest();
modifyOrderRequest.setQuantity("20");
OrderResponse modifyOrder = ordersApi.modifyOrder(xSessionToken, "200529000000059", modifyOrderRequest);{
"serverTime" : "29/05/20 14:12:42",
"msgId" : "773d0380-6f07-4269-93e5-a6d4b2b8c5d3",
"orderNumber" : "200529000000059",
"status" : "Success",
"statusMessage" : "Order 200529000000059 modified successfully",
"exchangeOrderStatus" : "PENDING",
"orderDetails" : {
"pendingQuantity" : "20",
"avgExecutionPrice" : "0.00",
"orderPlacedBy" : "DA35672",
"tradingSymbol" : "RELIANCE",
"triggerPrice" : "0.00",
"exchange" : "BSE",
"totalQuantity" : "20",
"transactionType" : "BUY",
"productType" : "MIS",
"orderType" : "L",
"quantity" : "20",
"filledQuantity" : "0",
"orderPrice" : "1600.0",
"filledPrice" : "0.00",
"exchangeOrderNo" : "1590728958294000024",
"orderValidity" : "DAY",
"orderTime" : "29/05/2020 14:12:39"
}
}Orderbook retrieves and displays details of all orders placed by the user on a specific day. This API returns all states of the orders, namely, open, pending, rejected and executed ones.
xSessionTokenOrdersApi ordersApi = new OrdersApi();
OrderBookResponse orderBook = ordersApi.getOrderBook(xSessionToken);{
"serverTime" : "29/05/20 15:43:49",
"msgId" : "d2b6770c-348b-4bd0-91fa-feb5b3d10d8d",
"status" : "Success",
"orderBookDetails" : [ {
"orderNumber" : "200529000000200",
"exchange" : "NSE",
"tradingSymbol" : "RELIANCE",
"transactionType" : "SELL",
"productCode" : "CO",
"orderValue" : "0.0",
"orderTime" : "29-May-2020 15:02:02",
"userId" : "DA35672",
"orderType" : "SL-M",
"orderPrice" : "1290.00",
"triggerPrice" : "1290.00",
"orderValidity" : "DAY",
"orderStatus" : "Trigger Pending",
"filledQuantity" : "0",
"fillPrice" : "0.00",
"averagePrice" : "0.00",
"rejectionReason" : "--",
"exchangeConfirmationTime" : "29-May-2020 15:02:02",
"coverOrderPercentage" : "0.05",
"orderRemarks" : "--",
"exchangeOrderNumber" : "1100000000085407",
"symbol" : "2885_NSE",
"displayStrikePrice" : "00.00",
"displayNetQuantity" : "1",
"status" : "Trigger Pending",
"exchangeStatus" : "trigger pending",
"expiry" : "NA",
"pendingQuantity" : "1",
"totalQuanity" : "1",
"optionType" : "XX",
"orderPlaceBy" : "--",
"orderSource" : "NEST_REST_TA"
} ]
}This API is used to get the trigger order numbers in case of BO and CO orders so that their attribute values can be modified. For BO orders, it will give the order identifiers for Stop loss leg and target leg. For CO orders, it will return order identifier of stop loss leg only. Using the order identifier, the user would be able to modify the order attributes using the modifyOrder API.
xSessionToken, orderNumberOrdersApi ordersApi = new OrdersApi();
TriggerOrdersResponse triggerOrderNumbers = ordersApi.getTriggerOrderNumbers(xSessionToken, "200514000000041");{
"serverTime" : "01/06/20 14:06:46",
"msgId" : "2172fc5c-a72b-4c79-bb43-398bebf85af4",
"status" : "Success",
"statusMessage" : "SubOrder details retrieved successfully.",
"triggerOrders" : [ {
"targetOrderNo" : "200601000000027",
"orderStatus" : "Open",
"orderPrice" : "760.10",
"triggerPrice" : "0.00",
"mainOrderNo" : "200601000000026"
}, {
"stopLossOrderNo" : "200601000000028",
"orderStatus" : "Cancelled",
"orderPrice" : "650.00",
"triggerPrice" : "650.00",
"mainOrderNo" : "200601000000026"
} ]
}Get status of an order placed previously. This API returns all states of the orders,but not limited to open, pending, and partially filled ones.
xSessionToken, orderNumberOrdersApi ordersApi = new OrdersApi();
OrderStatusResponse orderStatusResponse = ordersApi.getOrderStatus(xSessionToken, "200618000000010");{
"serverTime" : "29/05/20 13:31:37",
"msgId" : "a92ce76f-5970-44c5-a1b8-1038537b28c6",
"orderNumber" : "200529000000059",
"orderStatus" : "PENDING",
"orderDetails" : {
"pendingQuantity" : "2",
"avgExecutionPrice" : "0.00",
"orderPlacedBy" : "--",
"tradingSymbol" : "RELIANCE",
"triggerPrice" : "0.00",
"exchange" : "BSE",
"totalQuantity" : "2",
"transactionType" : "BUY",
"productType" : "MIS",
"orderType" : "L",
"quantity" : "2",
"filledQuantity" : "0",
"orderPrice" : "1600.0",
"filledPrice" : "0.00",
"exchangeOrderNo" : "1590728958294000024",
"orderValidity" : "DAY",
"orderTime" : "29/05/2020 12:43:04"
}
}An order which is open or pending in system can be cancelled. In other words, cancellation cannot be initiated for already Executed, Rejected orders.This is for CNC, MIS and NRML Orders.
xSessionToken, orderNumberOrdersApi ordersApi = new OrdersApi();
CancelOrderResponse cancelOrderResponse = ordersApi.cancelOrder(xSessionToken, "200529000000059");{
"serverTime" : "29/05/20 14:50:36",
"msgId" : "25d6d99b-3224-4a77-b129-a5d0bd38349b",
"status" : "Success",
"orderNumber" : "200529000000059",
"statusMessage" : "Order cancelled successfully"
}For Cancellation/exit of CO orders pass main leg Order number. If main leg is in Open/Pending state that order will be cancelled. If the main leg is executed and the sublegs are created and in open/Trigger pending state, the order will be exited. If the main leg is executed and if Stop loss is hit, API will return error message "SubOrder is in Executed status. Cannot exit/cancel such orders.
xSessionToken, orderNumberOrdersApi ordersApi = new OrdersApi();
CancelOrderResponse cancelOrderResponse = ordersApi.cancelOrderCO(xSessionToken, "200618000000075");{
"serverTime" : "01/06/20 16:06:25",
"msgId" : "3b7ed673-9a5b-4014-afdf-158c8490beba",
"status" : "Success",
"orderNumber" : "200601000000129",
"statusMessage" : "Cover Order 200601000000129exited successfully"
}For Cancellation/exit of BO orders pass main leg Order number. If main leg is in Open/Pending state that order will be cancelled. If the main leg is executed and the sublegs are created and in open/Trigger pending state, the order will be exited. If the main leg is executed and if either of Stop loss or target is hit, API will return error message "SubOrder is in Executed status. Cannot exit/cancel such orders.
xSessionToken, orderNumberOrdersApi ordersApi = new OrdersApi();
CancelOrderResponse cancelOrderResponse = ordersApi.cancelOrderBO(xSessionToken, "200619000000003");{
"serverTime" : "01/06/20 16:11:24",
"msgId" : "c02e4a34-cb58-4822-8988-3736b22831e5",
"status" : "Success",
"orderNumber" : "200601000000134",
"statusMessage" : "Bracket Order exited successfully"
}GTT (Good Till Triggered) is a feature that allows users to place buy or sell orders of any stock at market or limit price. These orders are executed (triggered) once the market price of the stock reaches your desired price i.e the price you mentioned in the GTT Order. Read More....
xSessionToken,symbolName,transactionType,quantity,productType,orderType,triggerPrice,limitPrice,marketProtection
GTTApi createGtt= new GTTApi();
GTTCreateRequest gttRequest = new GTTCreateRequest();
gttRequest.setExchange(SamcoConstants.EXCHANGE_NSE);
gttRequest.setSymbolName("IDEA");
gttRequest.setTransactionType(SamcoConstants.TRANSACTION_TYPE_BUY);
gttRequest.setOrderType(SamcoConstants.ORDER_TYPE_LIMIT);
gttRequest.setQuantity("10");
gttRequest.setProductType(SamcoConstants.PRODUCT_NRML);
gttRequest.setOrderType(SamcoConstants.ORDER_TYPE_LIMIT);
gttRequest.setTriggerPrice("14");
gttRequest.setLimitPrice("14.50");
gttRequest.setMarketProtection("3");
GTTCreateResponse createGttresponse = createGtt.postGTTRequest(xSessionToken, gttRequest);
{
"serverTime": "31/05/24 15:21:50",
"msgId": "06fb18e6-6790-4700-8f26-258f1e31fd76",
"status": "Success",
"statusMessage": "GTT CREATED",
"gttSummaryId": "944090",
"orderDetails": {
"productType": "NRML",
"orderType": "L",
"triggerPrice": "14",
"marketProtection": "",
"transactionType": "BUY",
"triggerId": "1344160",
"symbol": "14366_NSE",
"symbolName": "IDEA",
"createdAt": "2024-05-31 15:21:50"
}
}Modifying a GTT (Good Till Triggered) order allows investors to adjust the parameters of their existing GTT orders. This can include changing the trigger price, altering the quantity of the order, productType, limitPrice, marketProtection or modifying the order type.
xSessionToken,exchange,symbolName,transactionType,quantity,productType,orderType,triggerPrice,limitPrice,marketProtection,gttSummaryId
GTTApi modifyGtt = new GTTApi();
GTTModifyRequest modifyGttRequest = new GTTModifyRequest();
modifyGttRequest.setExchange(SamcoConstants.EXCHANGE_NSE);
modifyGttRequest.setSymbolName("IDEA");
modifyGttRequest.setTransactionType(SamcoConstants.TRANSACTION_TYPE_BUY);
modifyGttRequest.setQuantity("5");
modifyGttRequest.setProductType(SamcoConstants.PRODUCT_NRML);
modifyGttRequest.setOrderType(SamcoConstants.ORDER_TYPE_LIMIT);
modifyGttRequest.setTriggerPrice("14.8");
modifyGttRequest.setLimitPrice("14.8");
modifyGttRequest.setMarketProtection("3");
modifyGttRequest.setGttSummaryId(944090);
GTTModifyResponse modifyresponse = modifyGtt.putGTTRequest(xSessionToken, modifyGttRequest);
{
"serverTime": "31/05/24 15:23:29",
"msgId": "26eba130-ce8c-4c4e-b661-a1c90292bf11",
"status": "Success",
"statusMessage": "GTT MODIFIED",
"gttSummaryId": "944115",
"orderDetails": {
"productType": "NRML",
"orderType": "L",
"triggerPrice": "14.8",
"marketProtection": "",
"transactionType": "BUY",
"limitPrice": "14.8",
"symbol": "14366_NSE",
"symbolName": "IDEA",
"quantity": "5"
}
}Deleting a GTT order cancels it before execution, removing it from the exchange's order book and preventing future execution. Once GTT is triggered, deletion is not possible.
xSessionToken,gttSummaryId
GTTApi deleteGtt = new GTTApi();
GTTDeleteRequest requestBody = new GTTDeleteRequest(944115);
GTTDeleteResponse gttdeleteresponse = deleteGtt.deleteGTTRequest(xSessionToken, requestBody);
{
"serverTime": "31/05/24 15:25:07",
"msgId": "f8d8d409-affa-4251-9756-923c09e21294",
"status": "Success",
"statusMessage": "GTT Deleted successfully",
"gttSummaryId": "944115",
"orderDetails": {
"userId": "RXX12XX"
}
}GTT (Good Till Triggered) is a feature that allows users to place buy or sell orders of any stock at market or limit price. These orders are executed (triggered) once the market price of the stock reaches your desired price i.e the price you mentioned in the GTT Order. Read More....
xSessionToken,symbolName,transactionType,quantity,productType,orderType,targetTriggerPrice,targetLimitPrice,stoplossTriggerPrice,stoplossLimitPrice,marketProtection
GTTOCOApi gttOcoApi = new GTTOCOApi();
GTTOCOCreateRequest gttocoReq = new GTTOCOCreateRequest();
gttocoReq.setExchange("NSE");
gttocoReq.setSymbolName("IDEA");
gttocoReq.setTransactionType("SELL");
gttocoReq.setQuantity("1");
gttocoReq.setProductType("CNC");
gttocoReq.setOrderType("L");
gttocoReq.setTargetTriggerPrice("17");
gttocoReq.setTargetLimitPrice("16");
gttocoReq.setStoplossTriggerPrice("13");
gttocoReq.setStoplossLimitPrice("12");
gttocoReq.setMarketProtection("");
GTTOCOCreateResponse gttocoResponse = gttOcoApi.postGTTOCORequest(xSessionToken, gttocoReq);
{
"serverTime": "31/05/24 17:35:52",
"msgId": "eda2be26-8f8e-4319-9afc-2d256fafd2bb",
"status": "Success",
"statusMessage": "GTT CREATED",
"gttSummaryId": "944425",
"orderDetails": {
"transactionType": "SELL",
"symbol": "14366_NSE",
"symbolName": "IDEA",
"productType": "CNC",
"orderType": "L",
"target": {
"quantity": "1",
"triggerPrice": "17",
"limitPrice": "16",
"marketProtection": "",
"type": "TARGET",
"triggerId": "1344615"
},
"stopLoss": {
"quantity": "1",
"triggerPrice": "13",
"limitPrice": "12",
"marketProtection": "",
"type": "STOPLOSS",
"triggerId": "1344620"
}
}
}
Modifying a GTT (Good Till Triggered) order allows investors to adjust the parameters of their existing GTT orders. This can include changing the trigger price, altering the quantity of the order, productType, limitPrice, marketProtection or modifying the order type.
xSessionToken,exchange,symbolName,transactionType,quantity,productType,orderType,targetTriggerPrice,targetLimitPrice,stoplossTriggerPrice,stoplossLimitPrice,marketProtection,gttSummaryId
GTTOCOApi gttOcoApi = new GTTOCOApi();
GTTOCOModifyRequest gttModReq=new GTTOCOModifyRequest();
gttModReq.setExchange("NSE");
gttModReq.setSymbolName("IDEA");
gttModReq.setTransactionType("SELL");
gttModReq.setQuantity("2");
gttModReq.setProductType("NRML");
gttModReq.setOrderType("L");
gttModReq.setTargetTriggerPrice("18");
gttModReq.setTargetLimitPrice("17");
gttModReq.setStoplossTriggerPrice("14");
gttModReq.setStoplossLimitPrice("13");
gttModReq.setMarketProtection("");
gttModReq.setGttSummaryId("944425");
GTTOCOModifyResponse gttModifyResponse = gttOcoApi.putGTTOCORequest(xSessionToken,gttModReq);
{
"serverTime": "31/05/24 17:43:23",
"msgId": "2589a516-d3cd-4408-863c-99d5ba6de971",
"status": "Success",
"statusMessage": "GTT MODIFIED",
"gttSummaryId": "944430",
"orderDetails": {
"transactionType": "SELL",
"orderType": "L",
"symbol": "14366_NSE",
"symbolName": "IDEA",
"productType": "NRML",
"target": {
"limitPrice": "17",
"triggerId": "1344625",
"triggerPrice": "18",
"type": "TARGET",
"quantity": "2",
"marketProtection": ""
},
"stopLoss": {
"limitPrice": "13",
"triggerId": "1344630",
"triggerPrice": "14",
"type": "STOPLOSS",
"quantity": "2",
"marketProtection": ""
}
}
}
Deleting an OCO (One-Cancels-the-Other) order involves canceling both legs of the order simultaneously. In an OCO order, when one part of the order is executed, the other part is automatically canceled. However, if the investor decides to delete the entire OCO order before either part is executed, they can do so using the delete OCO API.
xSessionToken,gttSummaryId
GTTOCOApi delGttOco = new GTTOCOApi();
GTTOCODeleteRequest requestBody = new GTTOCODeleteRequest(944430);
GTTOCODeleteResponse gttdeleteresponse = delGttOco.deleteGTTOCORequest(xSessionToken, requestBody);
{
"serverTime": "31/05/24 19:05:44",
"msgId": "ddeb9d0e-aff8-4e50-8e8f-6d2189056dfd",
"status": "Success",
"statusMessage": "GTT Deleted successfully",
"gttSummaryId": "944430",
"orderDetails": {
"clientId": "RX31XXX"
}
}Using the list OCO, we can retrieve the list of active GTT OCO, triggered GTT OCO, and expired GTT OCO.
xSessionToken,listType
GTTApi listgtt = new GTTApi();
GTTOrderListResponse gttListResponse = listgtt.getGTTListRequest(xSessionToken);
{
"serverTime": "31/05/24 15:24:23",
"msgId": "b9637ccf-579a-4cd7-ac7b-4fa8ba11ee6e",
"status": "Success",
"statusMessage": "List of GTT / OCO orders received.",
"orderDetails": [
{
"summary": {
"id": 944115,
"userId": "RXX12XX",
"symbol": "14366_NSE",
"symbolName": "IDEA",
"orderType": "L",
"productType": "NRML",
"gttType": "SINGLE",
"validTill": "FOREVER",
"createdAt": "2024-05-31 15:23:30",
"deletedAt": "",
"gttSummaryId": "944115",
"isExpired": false
},
"triggers": {}
}
]
}Details of all successfully executed orders placed by the user.
xSessionTokenTradeBookApi tradeBookApi = new TradeBookApi();
TradeBookResponse tradeBook = tradeBookApi.getTradeBook(xSessionToken);{
"serverTime" : "29/05/20 15:43:49",
"msgId" : "d2b6770c-348b-4bd0-91fa-feb5b3d10d8d",
"status" : "Success",
"orderBookDetails" : [ {
"orderNumber" : "200529000000200",
"exchange" : "NSE",
"tradingSymbol" : "RELIANCE",
"transactionType" : "SELL",
"productCode" : "CO",
"orderValue" : "0.0",
"orderTime" : "29-May-2020 15:02:02",
"userId" : "DA35672",
"orderType" : "SL-M",
"orderPrice" : "1290.00",
"triggerPrice" : "1290.00",
"orderValidity" : "DAY",
"orderStatus" : "Complete",
"filledQuantity" : "0",
"fillPrice" : "0.00",
"averagePrice" : "0.00",
"rejectionReason" : "--",
"exchangeConfirmationTime" : "29-May-2020 15:02:02",
"coverOrderPercentage" : "0.05",
"orderRemarks" : "--",
"exchangeOrderNumber" : "1100000000085407",
"symbol" : "2885_NSE",
"displayStrikePrice" : "00.00",
"displayNetQuantity" : "1",
"status" : "Trigger Pending",
"exchangeStatus" : "trigger pending",
"expiry" : "NA",
"pendingQuantity" : "1",
"totalQuanity" : "1",
"optionType" : "XX",
"orderPlaceBy" : "--"
} ]
}Get position details of the user (The details of equity, derivative, commodity, currency borrowed or owned by the user).
xSessionToken, positionType
PositionsApi positionsApi = new PositionsApi();
PositionResponse positions = positionsApi.getPositions(xSessionToken, SamcoConstants.POSITION_TYPE_DAY);{
"serverTime" : "01/06/20 15:13:06",
"msgId" : "9e143fb4-f9cb-4ea7-bd6d-bad6008816db",
"positionDetails" : [ {
"averagePrice" : "669.00",
"exchange" : "NSE",
"markToMarketPrice" : "0.00",
"lastTradedPrice" : "669.00",
"previousClose" : "705.45",
"productCode" : "BO",
"tradingSymbol" : "INFY-EQ",
"calculatedNetQuantity" : "10.0",
"averageBuyPrice" : "669.00",
"averageSellPrice" : "0.00",
"boardLotQuantity" : "1",
"boughtPrice" : "6690.00",
"buyQuantity" : "10",
"carryForwardQuantity" : "0",
"carryForwardValue" : "0.00",
"multiplier" : "1",
"netPositionValue" : "-6690.00",
"netQuantity" : "10",
"netValue" : "-6690.00",
"positionType" : "DAY",
"sellQuantity" : "0",
"positionConversions" : [ "CNC", "NRML" ],
"soldValue" : "0.00",
"transactionType" : "BUY",
"realizedGainAndLoss" : "0.00",
"unrealizedGainAndLoss" : "0.00",
"companyName" : "INFOSYS LIMITED"
}]
}Convert an existing position of a margin product to a different margin product type. All or a subset of an existing position quantity can be converted to a different product type.The available margin product types are MARGIN_INTRADAY_SQUAREOFF(MIS), CASHNCARRY(CNC), NORMAL(NRML).
xSessionToken, exchange, symbolName, transactionType, positionType, quantityToConvert, fromProductType, toProductType, netQuantityPositionsApi positionsApi = new PositionsApi();
PositionConversionRequest conversionRequest = new PositionConversionRequest();
conversionRequest.setSymbolName("RELIANCE");
conversionRequest.setExchange(SamcoConstants.EXCHANGE_BSE);
conversionRequest.setTransactionType(SamcoConstants.TRANSACTION_TYPE_BUY);
conversionRequest.setPositionType(SamcoConstants.POSITION_TYPE_DAY);
conversionRequest.setQuantityToConvert("2");
conversionRequest.setFromProductType(SamcoConstants.PRODUCT_MIS);
conversionRequest.setToProductType(SamcoConstants.PRODUCT_CNC);
conversionRequest.setNetQuantity("2");
PositionConversionResponse positionConversionResponse = positionsApi.convertPosition(xSessionToken, conversionRequest);{
"serverTime" : "01/06/20 15:06:42",
"msgId" : "ba32c75f-ee4b-4af6-a580-f17ad36fefd4",
"status" : "Success",
"statusMsg" : "Position Conversion from MIS to CNC successful"
}The PositionsApi class helps the user to Square Off existing position. Mostly used in day trading, in which user buy or sell a particular quantity of a stock and later in the day reverse the transaction to earn a profit.
xSessionToken, symbolName,exchange,transactionType,productType,netQuantityPositionsApi positionsApi = new PositionsApi();
PositionSquareOffListRequest squareOffListRequest = new PositionSquareOffListRequest();
PositionSquareOffRequest squareOffRequest = new PositionSquareOffRequest();
squareOffRequest.setExchange(SamcoConstants.EXCHANGE_BSE);
squareOffRequest.setSymbolName("TCS");
squareOffRequest.setProductType(SamcoConstants.PRODUCT_MIS);
squareOffRequest.setNetQuantity("1");
squareOffRequest.setTransactionType(SamcoConstants.TRANSACTION_TYPE_BUY);
List<PositionSquareOffRequest> list = new ArrayList<>();
list.add(squareOffRequest);
squareOffListRequest.setPositionSquareOffRequestList(list);
PositionSquareOffListResponse squareOffPosition = positionsApi.squareOffPosition(xSessionToken, squareOffListRequest);{
"serverTime": "25/06/20 20:04:30",
"msgId": "fcb519b8-dd74-422a-8a65-1dc0a0caedb7",
"positionSquareOffResponseList": [
{
"status": "Success",
"statusMessage": "Position square off successful -TCS-EQ NetQty:1"
}
]
}Get the details of the Stocks which client is holding. Here, you will be able to get the Client holdings which are bought under ‘CNC’ product type and are not sold yet.
xSessionTokenHoldingsApi holdingsApi = new HoldingsApi();
HoldingResponse holding = holdingsApi.getHolding(xSessionToken);{
"serverTime": "25/06/20 13:46:16",
"msgId": "d58af813-8ed2-400d-b769-9d89f873376d",
"status": "Success",
"statusMessage": "User Holding details retrieved successfully",
"holdingSummary": {
"gainingTodayCount": "1",
"losingTodayCount": "2",
"totalGainAndLossAmount": "-17.15",
"portfolioValue": "13.40"
},
"holdingDetails": [
{
"averagePrice": "22.50",
"exchange": "BSE",
"lastTradedPrice": "0.00",
"previousClose": "23.00",
"productCode": "CNC",
"symbolDescription": "ASHOK ALCO-CHEM LTD.",
"tradingSymbol": "ASHOKALC",
"totalGainAndLoss": "-22.50",
"holdingsQuantity": "1",
"collateralQuantity": "-1",
"holdingsValue": "0.00",
"sellableQuantity": "0"
},
{
"averagePrice": "1.57",
"exchange": "NSE",
"lastTradedPrice": "2.30",
"previousClose": "2.10",
"productCode": "CNC",
"symbolDescription": "JAIPRAKASH ASSOCIATES LTD",
"tradingSymbol": "JPASSOCIAT-EQ",
"totalGainAndLoss": "1.45",
"holdingsQuantity": "2",
"collateralQuantity": "-2",
"holdingsValue": "4.60",
"sellableQuantity": "0"
}
]
}Gets the Intraday candle data such as Open, high, low, close and volume within specific time period per min for a specific symbol.
xSessionToken, exchange, symbolName, fromDate, toDateIntraDayCandleDataApi intraDayCandleDataApi = new IntraDayCandleDataApi();
IntraDayCandleResponses intraDayCandleResponses = intraDayCandleDataApi.getIntradayCandleData(xSessionToken, "INFY", "2020-04-27 11:50:00", SamcoConstants.EXCHANGE_BSE, "2020-04-27 12:29:00");{
"serverTime" : "31/05/20 20:46:52",
"msgId" : "ff875ecd-5f42-47f6-a81e-37e6920acefc",
"intradayCandleData" : [ {
"dateTime" : "2020-04-27 11:50:00.0",
"open" : "632.3",
"high" : "632.3",
"low" : "632.3",
"close" : "632.3",
"volume" : "1"
}, {
"dateTime" : "2020-04-27 12:28:00.0",
"open" : "632.3",
"high" : "632.3",
"low" : "632.3",
"close" : "632.3",
"volume" : "0"
}, {
"dateTime" : "2020-04-27 12:29:00.0",
"open" : "632.3",
"high" : "632.3",
"low" : "632.3",
"close" : "632.3",
"volume" : "0"
}]
}Gets the Index intraday candle data such as Open, high, low, close and volume within specific time period per min for a specific index.
xSessionToken, indexName, fromDate, toDateIntraDayCandleDataApi intraDayCandleDataApi = new IntraDayCandleDataApi();
IndexIntraDayCandleDataResponse indexIntradayCandleData = intraDayCandleDataApi.getIndexIntradayCandleData(xSessionToken, "NIFTY 200", "2019-08-26 09:07:00", "2019-08-26 09:16:00");{
"serverTime" : "02/06/20 18:19:42",
"msgId" : "6e6ad246-9808-4bfc-8cf3-724f4f745113",
"status" : "Success",
"statusMessage" : "Index IntraDay Candle data retrieved successfully ",
"indexIntraDayCandleData" : [ {
"dateTime" : "2019-08-26 09:07:00.0",
"open" : "5664.2",
"high" : "5664.2",
"low" : "5664.2",
"close" : "5664.2",
"volume" : "0"
}, {
"dateTime" : "2019-08-26 09:15:00.0",
"open" : "5662.15",
"high" : "5662.15",
"low" : "5632.1",
"close" : "5632.1",
"volume" : "0"
}, {
"dateTime" : "2019-08-26 09:16:00.0",
"open" : "5631.3",
"high" : "5638.55",
"low" : "5628.5",
"close" : "5638.55",
"volume" : "0"
} ]
}Gets the historical candle data such as Open, high, low, close, last traded price and volume within specific dates for a specific symbol. From date is mandatory. End date is optional and defaults to Today.
xSessionToken, exchange, symbolName, fromDate, toDateHistoricalCandleDataApi historicalCandleDataApi = new HistoricalCandleDataApi();
HistoricalCandleResponse historicalCandleData = historicalCandleDataApi.getHistoricalCandleData(xSessionToken, "INFY", "2019-01-01", SamcoConstants.EXCHANGE_BSE, "2020-02-01");{
"serverTime" : "31/05/20 20:18:07",
"msgId" : "07701e56-fb82-4315-bad0-449da8482549",
"historicalCandleData" : [ {
"date" : "2019-01-01",
"open" : "661.0",
"high" : "667.0",
"low" : "654.3",
"close" : "664.65",
"ltp" : "664.65",
"volume" : "221951"
}, {
"date" : "2019-01-02",
"open" : "668.0",
"high" : "673.7",
"low" : "662.45",
"close" : "669.3",
"ltp" : "669.3",
"volume" : "419594"
}, {
"date" : "2019-01-03",
"open" : "670.9",
"high" : "677.0",
"low" : "663.8",
"close" : "667.55",
"ltp" : "667.55",
"volume" : "355183"
}]
}Gets the Index historical candle data such as Open, high, low, close, last traded price and volume within specific dates for a specific index. From date is mandatory. End date is optional and defaults to Today.
xSessionToken, indexName, fromDate, toDateHistoricalCandleDataApi historicalCandleDataApi = new HistoricalCandleDataApi();
IndexCandleDataResponse indexCandleDataResponse = historicalCandleDataApi.getIndexCandleData(xSessionToken, "NIFTY 200", "2015-03-04", "2017-03-05");{
"serverTime" : "31/05/20 20:31:02",
"msgId" : "cf232a72-e7d3-42a3-a834-9e8cbd65aa20",
"status" : "Success",
"statusMessage" : "Index HistoricalCandle data retrieved successfully ",
"indexCandleData" : [ {
"date" : "2015-03-04",
"open" : "4702.2",
"high" : "4706.3",
"low" : "4594.3",
"close" : "4607.4",
"ltp" : "4607.4",
"volume" : "0"
}, {
"date" : "2015-03-05",
"open" : "4612.65",
"high" : "4630.65",
"low" : "4576.85",
"close" : "4621.7",
"ltp" : "4621.7",
"volume" : "0"
}, {
"date" : "2015-03-09",
"open" : "4598.15",
"high" : "4598.15",
"low" : "4527.4",
"close" : "4534.15",
"ltp" : "4534.15",
"volume" : "0"
}]
}Logging out user from the application
xSessionTokenUserLogoutApi logoutApi = new UserLogoutApi();
SimpleResponse logout = logoutApi.logout(xSessionToken);{
"serverTime" : "31/05/20 21:27:52",
"msgId" : "41627994-5c96-411c-b15c-dbda00029269",
"status" : "Success",
"statusMessage" : "User has successfully logged out"
}This section contains the list of possible constant values that can be passed for input attributes like exchanges, product types etc.
PRODUCT_MIS
PRODUCT_CNC
PRODUCT_NRML
PRODUCT_CO
PRODUCT_BO
Example:- setProductType(SamcoConstants.PRODUCT_MIS)EXCHANGE_NSE
EXCHANGE_BSE
EXCHANGE_NFO
EXCHANGE_CDS
EXCHANGE_MCX
Example:- setExchange(SamcoConstants.EXCHANGE_BSE)TRANSACTION_TYPE_BUY
TRANSACTION_TYPE_SELL
Example:- setTransactionType(SamcoConstants.TRANSACTION_TYPE_BUY)ORDER_TYPE_MARKET
ORDER_TYPE_LIMIT
ORDER_TYPE_SLM
ORDER_TYPE_SL
Example:- setOrderType(SamcoConstants.ORDER_TYPE_MARKET);VALIDITY_DAY
VALIDITY_IOC
Example:- setOrderValidity(SamcoConstants.VALIDITY_DAY)POSITION_TYPE_DAY
POSITION_TYPE_NET
Example:- setPositionType(SamcoConstants.POSITION_TYPE_DAY)