ICICI IDIRECT API DOC

Overview


ICICI direct API are a set of JSON REST api which enable user to transact on ICICI direct platform. Authentication is done following the oauth 2.0 protocol. In case you are not familiar with oauth 2.0, you can read the same from blog here.
User will need to come and register on ICICI direct developer portal.
User will need to input below fields:
  1. App Name
  2. Registered URL
  3. Redirect URL
After this user will create AppKey and client_secret which will be unique to app.
All requests need to have parameter of AppKey , Checksum and Timestamp.

Registration Details

User Registration Page

URL:https://api.icicidirect.com/apiuser/reguserlogin

Login Page

URL:https://api.icicidirect.com/apiuser/userlogin

Registration APP

URL:https://api.icicidirect.com/apiuser/appregistration

Customer Login

Request:-Following input parameters need to post on URL: https://api.icicidirect.com/apiuser/tradelogin and it will redirect you to Customer Login Page.
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
ChecksumStringN/AYesCombination of ( AppKey + Time Stamp + secret_key )

NOTE:Output of Customer Login will provide API_Session which need to provide as a request parameters in Customer Details to get Customer Details

Customer Login Page

URL:https://api.icicidirect.com/apiuser/tradelogin

Customer Details

API URL:https://api.icicidirect.com/customer/customerdetails

Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData StringN/AYesData in JSONPostData has to be stringify 
 UserID StringN/AYes 
 API_Session StringN/AYes 
 APPKey StringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )
Output Parameters:-
Parameter TypeDescription/Remark
Status   200 Success,500 Failure
Error   null if no error else Applicable error
Success    
 Idirect_UseridStringICICI direct userid
 SessionTokenStringToken which needs to be passed to all other api for validation.
 idirect_user_nameStringUser name in ICICI direct system.
 exg_trade_dateString[]NSE/BSE/NFO/NDX trade date
 exg_statusString[]NSE/BSE/NFO/NDX exchange status
 segments_allowedString[]Segments allowed for user.
 idirect_lastlogin_timeStringLast login time of user on ICICI direct platform.
Request Example:-
{"AppKey":"45$4O04v5388Y1x14633245K_9r6106j","time_stamp":"03-Jul-2019 12:47:23",
"JSONPostData":{"UserID":"test","API_Session":"36","APPKey":"45$4O04v5388Y1x14633245K_9r6106j"},
"Checksum":"4A05E57572862484A48543FA2418CBE12117534DD28600A028F829441D008179"} 

Response Example:-
{
	"Status": 200,
	"Error": null,
	"Success": {
		"exg_trade_date": {
			"NSE": "20-Jun-2019",
			"BSE": "20-Jun-2019",
			"FNO": "03-Jul-2019",
			"NDX": "02-Jul-2019"
		},
		"exg_status": {
			"NSE": "O",
			"BSE": "O",
			"FNO": "O",
			"NDX": "O"
		},
		"segments_allowed": {
			"Trading": "Y",
			"Equity": "Y",
			"Derivatives": "Y",
			"Currency": "Y"
		},
		"Idirect_Userid": "test",
		"SessionToken": "1173201",
		"idirect_user_name": "ert ert",
		"idirect_lastlogin_time": "03-Jul-2019 12:47:37"
	}
}

Order Book

API URL:https://api.icicidirect.com/equity/orderbook

Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
 order_from_dtStringN/ANo 
 order_to_dtStringN/ANo 
 order_xchng_cdStringN/ANo 
Checksum StringN/AYesCombination of (Time Stamp + JSONPostData + secret_key )
Output Parameters:-
ParameterTypeDescription/Remark
Status   200 Success,500 Failure
Error   null if no error else Applicable error
Success    
 order_productString 
 order_validityString 
 order_quantitystring 
 order_ratestring 
 order_stp_loss_pricestring 
 order_disclosed_qtystring 
 order_stock_cdString 
 order_xchng_cdString 
 order_xchng_ackString 
 order_statusString 
 order_open_qtystring 
 order_executed_qtystring 
 order_cancelled_qtystring 
 order_expired_qtystring 
 MsgTypStringMessage returned from system.
 order_refrenceStringOrder Reference
Request Example:-
{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW",
"time_stamp":"21-06-2019 17:20:50",
"JSONPostData":{"order_from_dt":"21-Jun-2018",
"order_xchng_cd":"A","order_to_dt":"20-Jun-2019",
"SessionToken":"1171689",
"Idirect_Userid":"test"},
"Checksum":"26045B4EB3D316E1CA401F61429564D1B6A5507FDF81E32E6B41A7A018E8F45C"}

Response Example:-
{
	"Status": 200,
	"Error": null,
	"Success": [{
		"order_xchng_cd": "BSE",
		"order_stock_cd": "RELIND",
		"order_typ": "T",
		"order_rate": "800.00",
		"order_product": "M",
		"order_status": "P",
		"order_plctm": "02-Jul-2019 16:11",
		"order_plc_dt": "20-Jun-2019",
		"order_refrence": "20190620B100000927",
		"order_quantity": "4",
		"order_open_qty": "3",
		"order_executed_qty": "1",
		"order_cancelled_qty": "0",
		"order_expired_qty": "0",
		"order_disc_qty": "0",
		"order_sltp": "0.00",
		"MsgTyp": "N"
	}, {
        "order_xchng_cd": "NSE",
		"order_stock_cd": "ICIBAN",
		"order_typ": "T",
		"order_rate": "1000.00",
		"order_product": "C",
		"order_status": "R",
		"order_plctm": "25-Jul-2018 18:17",
		"order_plc_dt": "25-Jul-2018",
		"order_refrence": "20180725N100000567",
		"order_quantity": "1",
		"order_open_qty": "1",
		"order_executed_qty": "0",
		"order_cancelled_qty": "0",
		"order_expired_qty": "0",
		"order_disc_qty": "0",
		"order_sltp": "0.00",
		"MsgTyp": "*"
	}, {
		"order_xchng_cd": "NSE",
		"order_stock_cd": "ICIBAN",
		"order_typ": "T",
		"order_rate": "1000.00",
		"order_product": "C",
		"order_status": "R",
		"order_plctm": "25-Jul-2018 18:15",
		"order_plc_dt": "25-Jul-2018",
		"order_refrence": "20180725N100000566",
		"order_quantity": "1",
		"order_open_qty": "1",
		"order_executed_qty": "0",
		"order_cancelled_qty": "0",
		"order_expired_qty": "0",
		"order_disc_qty": "0",
		"order_sltp": "0.00",
		"MsgTyp": "*"
	}]
}

Order Book Details

API URL:https://api.icicidirect.com/equity/orderbookdtl

Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData  StringN/AYesData in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
 Order_OrderReferenceNoStringN/ANo 
 order_from_dtstringN/AYes 
 order_to_dtstringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )
Output Parameters:-
ParameterTypeDescription/Remark
Status   200 Success,500 Failure
Error   null if no error else Applicable error
Success    
 Order_Datestring 
 Order_ExchangeCodestring 
 Order_StockCodestring 
 Order_TradeFlowstring 
 Order_OrderQuantitystring 
 Order_Pricestring 
 Order_Statusstring 
 Order_ProductCodestring 
 Order_OrderReferenceNostring 
 Order_MatchAccountNumberstring 
 Order_LimitMarketFlagstring 
 Order_Typestring 
 Order_TradeDatestring 
 Order_ValidDatestring 
 Order_OpenQuantitystring 
 Order_ExecutedQuantitystring 
 Order_CanceledQuantitystring 
 Order_ExpiredQuantitystring 
 Order_DisclosedQuantitystring 
 Order_StopLossTriggerPricestring 
 Order_SpecialRemarksstring 
 Order_AmountBlockedstring 
 Order_PipeIdstring 
 Order_Channelstring 
 Order_ExchangeSegmentCodestring 
 Order_ExchangeSegmentSettlementstring 
 Order_SegmentDescriptionstring 
 Order_MarginSquareOffModestring 
 Order_LastTradedPricestring 
 Order_MarginPLUSIndicatorstring
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW", "time_stamp":"24-06-2019 14:48:38", "JSONPostData":{"SessionToken":"1171825","Idirect_Userid":"test", "Order_OrderReferenceNo":"20190415N100001951","order_from_dt":"01-Jun-2018", "order_to_dt":"31-Aug-2019"},"Checksum":"4B4A2CF819330FF5D7DE693776BB801990D0524B32D76F8AF1AF0BE62F2920FB"}
Response Example:-
{
	"Status": 200,
	"Error": null,
	"Success": [{
		"Order_Date": "15-Apr-2019 11:02",
		"Order_ExchangeCode": "NSE",
		"Order_StockCode": "ACC",
		"Order_TradeFlow": "B",
		"Order_OrderQuantity": "1",
		"Order_Price": 1440.3,
		"Order_Status": "R",
		"Order_ProductCode": "C",
		"Order_OrderReferenceNo": "20190415N100001951",
		"Order_MatchAccountNumber": "8504204200",
		"Order_LimitMarketFlag": "M",
		"Order_Type": "T",
		"Order_TradeDate": "15-Apr-2019",
		"Order_ValidDate": "*",
		"Order_OpenQuantity": "1",
		"Order_ExecutedQuantity": "0",
		"Order_CanceledQuantity": "0",
		"Order_ExpiredQuantity": "0",
		"Order_DisclosedQuantity": "0",
		"Order_StopLossTriggerPrice": "0.00",
		"Order_SpecialRemarks": "N",
		"Order_AmountBlocked": "0",
		"Order_PipeId": "N1",
		"Order_Channel": "SEP",
		"Order_ExchangeSegmentCode": "N",
		"Order_ExchangeSegmentSettlement": "2019073",
		"Order_SegmentDescription": "Rolling",
		"Order_MarginSquareOffMode": "",
		"Order_LastTradedPrice": 1440.3,
		"Order_MarginPLUSIndicator": ""
	}]
}

OrderBook Modify Order

API URL:https://api.icicidirect.com/equity/orderbookmodifyorder


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
 AppKeyStringN/AYes 
 time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData StringN/AYesData in JSONPostData has to be stringify  
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
 order_referenceStringN/AYesorder refrence of order
 new_order_typeStringN/AYesLimit,Market,StopLoss
 new_order_validityStringN/AYesIOC,DAY
 new_order_quantitystringN/AYes 
 new_order_ratestringN/ANoIn case of Market orders this filed is not required
 new_order_stp_loss_pricestringN/ANoStop loss price in case of stoploss order.
 new_order_disclosed_qtystringN/ANoDisclosed quantity in case of order
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter TypeDescription/Remark
Status   200 Success,500 Failure
Error   null if no error else Applicable error
Success    
 messageStringMessage returned from system.
 order_refrenceStringOrder Refrence

Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"28-06-2019 14:41:04", "JSONPostData":{"SessionToken":"1172803","Idirect_Userid":"test", "Order_OrderReferenceNo":"20180725N100000566","ORD_TYP":"L","new_order_rate":"1000", "new_order_validity":"T","new_order_Qty":"1"}, "Checksum":"8DB52DA771C1544F99B9E08479962C028BD725741B094DA2EBE13490821E0A28"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "order_refrence": "20180725N100000566", "message": "Your Order Modified successfully." } }

OrderBook Cancel Order

API URL:https://api.icicidirect.com/equity/cancelorder


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData StringN/AYesData in JSONPostData has to be stringify  
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
 order_referenceStringN/AYes 
 order_productStringN/AYes 
 order_flowStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter TypeDescription/Remark
Status  String200 Success,500 Failure
Error  Stringnull if no error else Applicable error
Success  String 
 messageStringMessage returned from system.
 order_refrenceStringOrder Refrence
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"28-06-2019 16:52:14", "JSONPostData":{"SessionToken":"1172860","Idirect_Userid":"test","Order_OrderReferenceNo":"20180725N100000566", "order_product":"C","order_flow":"B"}, "Checksum":"8A74CCCB169B77ABADAABAFD167F151673B58C27AEB4178E4E60F7B17252CF24"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "order_refrence": "20180725N100000566", "message": "Your Order Cancelled successfully." } }

Placement

API URL:https://api.icicidirect.com/equity/placement


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData StringN/AYesData in JSONPostData has to be stringify  
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
 order_stock_cdStringN/AYes 
 order_xchng_cdStringN/AYesExchange for placing order.
 order_productStringN/AYesCash,Margin,Marginplus,eATM
 order_typeStringN/AYesLimit,Market,StopLoss
 order_validityStringN/AYesIOC,DAY
 order_quantityStringN/AYes 
 order_rateStringN/ANoIn case of Market orders this filed is not required
 order_flowStringN/AYesBuy/Sell
 order_stp_loss_priceStringN/ANoStop loss price in case of stoploss order.
 order_disclosed_qtyStringN/ANoDisclosed quantity in case of order
 order_trade_dtStringN/AYesExchange trade date as retuned in client details
 TRNSCTN_FLWstringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterTypeDescription/Remark
Status  String200 Success,500 Failure
Error  Stringnull if no error else Applicable error
Success  String 
 messageStringMessage returned from system.
 order_referenceStringOrder Refrence
Request Example:-

{"AppKey":"93#AP6557N13n0w10N0272u3)9619X07","time_stamp":"28-Jun-2019 15:02:16", "JSONPostData":{"VALID_FLAG":null,"TRNSCTN_FLW":null,"order_stock_cd":"ACC","order_xchng_cd":"NSE", "order_product":"CASH","order_type":"M","order_validity":"T","order_quantity":"10","order_rate":null, "order_flow":"B","order_stp_loss_price":null,"order_disclosed_qty":null,"order_trade_dt":"20-Jun-2019", "Node":null,"Idirect_Userid":"parul","SessionToken":"1172814"}, "Checksum":"7659C5E50C7C78806C1479D69DC88D1DA80BBECD067FF06B02FABDCF66F8B590"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "Message": "Equity CASH Order placed successfully through RI reference no 20190620N100002482" } }

Portfolio

API URL:https://api.icicidirect.com/equity/portfolio


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData StringN/AYesData in JSONPostData has to be stringify  
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 portfolio_typeStringAYesA - Holdings , Y - Zero Holding , Z - all holding.
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
Status  String200 Success,500 Failure
Error  Stringnull if no error else Applicable error
Success  String 
 portfolio_stock_cdstring 
 SectorNamestring 
 Exchangestring 
 Quantityint 
 AvgrageCastPricestring 
 BookedProfitLossstring 
 CurrentMarketPricestring 
 ChangePersentagestring 
 AnswerFlagstring 
 messageStringMessage returned from system.
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"26-06-2019 11:42:32", "JSONPostData":{"SessionToken":"1172241","Idirect_Userid":"test","portfolio_type":"A"}, "Checksum":"EB16AEA99FC38A58EE36308D850B4C7E3BCA80A6AF56442EBDE7522E0F16382F"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "StockCode": "GAIL", "SectorName": "Auto/Auto ancillary", "Exchange": "NSE", "Quantity": 10, "AvgrageCastPrice": 428.5, "BookedProfitLoss": 0, "CurrentMarketPrice": 352.15, "ChangePersentage": -0.283165793572136, "AnswerFlag": "N" }, { "StockCode": "SUZENE", "SectorName": "Power/Generation/Distribution", "Exchange": "NSE", "Quantity": 11010, "AvgrageCastPrice": 15.86, "BookedProfitLoss": 0, "CurrentMarketPrice": 5.4, "ChangePersentage": 1.88679245283019, "AnswerFlag": "N" }, { "StockCode": "ONGC", "SectorName": "Refineries/Oil-Gas", "Exchange": "NSE", "Quantity": 10, "AvgrageCastPrice": 279.25, "BookedProfitLoss": 0, "CurrentMarketPrice": 145, "ChangePersentage": -2.19224283305228, "AnswerFlag": "N" }] }

Position

API URL:https://api.icicidirect.com/equity/position


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
SessionTokenStringN/AYes 
ChecksumStringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterTypeDescription/Remark
position_productString 
position_trade_dateString 
position_stock_cdString 
position_xchng_cdString 
position_flowString 
position_quantitystring 
position_ratestring 
position_cvr_qtystring 
position_stp_loss_pricestring 
position_limit_priceString 
xchng_ltpstring 
position_pnl_amntstring 
position_pnl_prnctstring 
position_avlbl_mrgnstring 
position_diff_mrgnstring 
messageStringMessage returned from system.
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW", "time_stamp":"26-06-2019 11:19:48", "JSONPostData":{"SessionToken":"1172217","Idirect_Userid":"test"}, "Checksum":"12831747B3DE473961058AFFA27D99E6B47A0110AC79FBDADAFE7DAE5BCDFC2A"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "position_product": "E", "position_trade_date": "20-Jun-2019", "position_stock_cd": "TCS", "position_xchng_cd": "BSE", "position_flow": "B", "position_quantity": 7, "position_rate": 2070, "position_cvr_qty": 4, "position_stp_loss_price": 0, "position_limit_price": "0", "xchng_ltp": 2070, "position_pnl_amnt": 0, "position_pnl_prnct": 0, "position_avlbl_mrgn": 14490, "position_diff_mrgn": 533.232 }, { "position_product": "E", "position_trade_date": "20-Jun-2019", "position_stock_cd": "TCS", "position_xchng_cd": "BSE", "position_flow": "B", "position_quantity": 10, "position_rate": 2070, "position_cvr_qty": 0, "position_stp_loss_price": 0, "position_limit_price": "0", "xchng_ltp": 2070, "position_pnl_amnt": 0, "position_pnl_prnct": 0, "position_avlbl_mrgn": 20700, "position_diff_mrgn": 761.760000000002 }] }

Stock Search

API URL:https://api.icicidirect.com/equity/stocksearch


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
security_ORD_STCK_CDStringEQYes3 characters
security_TRNSCTN_FLWStringN/AYesE - Equity, F - Derivatives, M - Mutual Fund
SessionTokenStringN/AYes 
ChecksumStringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterType
security_StockStringstring
security_NNSeriesstring
security_OSeriesstring
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"25-06-2019 15:41:04", "JSONPostData":{"SessionToken":"1172097","Idirect_Userid":"test", "ORD_STCK_CD":"ACC","TRNSCTN_FLW":"E"}, "Checksum":"280E77C3FB549735EF68F7FB9902D02B379310533D2FF166CBFECCA61B0D317C"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "StockString": "ACC (ACC LIMITED-INE012A01025)", "NNSeries": "ACCEQ", "OSeries": "ACC" }, { "StockString": "ACCEXP (ACCURATE EXPORTS-INE062B01010)", "NNSeries": "*", "OSeries": "ACCUEXPO" }, { "StockString": "TRASYS (ACCEL TRANSMATIC LIMITED-INE258C01038)", "NNSeries": "*", "OSeries": "ACCEL" }, { "StockString": "TREHOU (TREE HOUSE EDUCATION \u0026 ACCESSO-INE040M01013)", "NNSeries": "TREEHOUSEEQ", "OSeries": "TREEHOUSE" }] }

Demat Allocation

API URL:https://api.icicidirect.com/equity/dematallocation


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
demat_stock_cdStringN/ANo 
SessionTokenStringN/AYes 
ChecksumStringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )
EBA_ISIN_FLGStringN/AYes 
DPIDStringN/AYes 
ORD_DP_CLNT_IDStringN/AYes

Output Parameters:-
ParameterType
demat_StckCodestring
demat_ISINstring
demat_TotQtystring
demat_TotBlkQtystring
demat_AvlQtystring
demat_BlockedQtystring
demat_AlocatedQtystring
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW", "time_stamp":"25-06-2019 14:50:31", "JSONPostData":{"SessionToken":"1172048","Idirect_Userid":"test", "DPID":"IN303028","ORD_DP_CLNT_ID":"50025336","EBA_ISIN_FLG":"E"}, "Checksum":"226C80F23CB428D0AA60B1D8C37D03CD56F2E1E40560F34D4F20D5636F825671"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "demat_StckCode": "NA", "demat_ISIN": "INE090A01013", "demat_TotQty": "100", "demat_TotBlkQty": "1", "demat_AvlQty": "72", "demat_BlockedQty": "0", "demat_AlocatedQty": "0" }, { "demat_StckCode": "RELPET", "demat_ISIN": "INE475H01011", "demat_TotQty": "100", "demat_TotBlkQty": "100", "demat_AvlQty": "0", "demat_BlockedQty": "0", "demat_AlocatedQty": "0" }] }

Get Quote

API URL:https://api.icicidirect.com/equity/getquote


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
SessionTokenStringN/AYes 
ChecksumStringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )
STCK_CDStringN/AYes

Output Parameters:-
ParameterType
Exchangestring
LTPstring
DayOpenstring
DayClosestring
DayHighstring
DayLowstring
PreDayClosestring
Changestring
ChangePerstring
HighPriceRangestring
LowPriceRangestring
DayVolumestring
BestBidPricestring
BestOfferPricestring
BestBidQtystring
BestOfferQtystring
WeekHigh52string
WeekLow52string
LifeTimeHighstring
LifeTimeHighDatestring
LifeTimeLowstring
LifeTimeLowDatestring
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW", "time_stamp":"25-06-2019 12:57:40", "JSONPostData":{"SessionToken":"1172031","Idirect_Userid":"test", "STCK_CD":"ACC"}, "Checksum":"6025BDB50BAAF74607AC756076EAC208288ADAE500616B9D1A9A11279B2A2964"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "NSEQuote": [{ "Exchange": "BSE", "LTP": "1472", "DayOpen": "1560.15", "DayClose": "1462.7", "DayHigh": "4000", "DayLow": "1000", "PreDayClose": "1462.7", "Change": "9.3", "ChangePer": "0.635810487454707", "HighPriceRange": "4000", "LowPriceRange": "100", "DayVolume": "23312", "BestBidPrice": "1543.75", "BestOfferPrice": "1544.45", "BestBidQty": "13", "BestOfferQty": "25", "WeekHigh52": "1869", "WeekLow52": "1255", "LifeTimeHigh": "1869", "LifeTimeHighDate": "13-Sep-2017", "LifeTimeLow": "64.86", "LifeTimeLowDate": "23-Oct-1998" }], "BSEQuote": [{ "Exchange": "BSE", "LTP": "1472", "DayOpen": "1560.15", "DayClose": "1462.7", "DayHigh": "4000", "DayLow": "1000", "PreDayClose": "1462.7", "Change": "9.3", "ChangePer": "0.635810487454707", "HighPriceRange": "4000", "LowPriceRange": "100", "DayVolume": "23312", "BestBidPrice": "1543.75", "BestOfferPrice": "1544.45", "BestBidQty": "13", "BestOfferQty": "25", "WeekHigh52": "1869", "WeekLow52": "1255", "LifeTimeHigh": "1869", "LifeTimeHighDate": "13-Sep-2017", "LifeTimeLow": "64.86", "LifeTimeLowDate": "23-Oct-1998" }] } }

Limit

API URL:https://api.icicidirect.com/equity/limit


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
SessionTokenStringN/AYes 
ChecksumStringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )
ExchangeStringN/AYes 
SegmentStringN/AYes

Output Parameters:-
ParameterType
CashLimitstring
AmtAllocatedstring
BlockAmtstring
TotalSecuritiesallocatedamountstring
CurrentSecuritiesLimitstring
TotalCurrentLimitstring
SettlementDtstring
PayInAmtstring
PatOutAmtstring
Exchangestring
SettlementNostring
Segmentstring
LimitTypestring
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW", "time_stamp":"25-06-2019 11:57:21", "JSONPostData":{"SessionToken":"1171991", "Idirect_Userid":"test","Exchange":"NSE","Segment":"N"}, "Checksum":"7A2CF2197BEF91B15BA6D8D44D6F62C7557AE66224A56CB221B8A37D757B788C"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "objlmt": [{ "SettlementDt": "06-Jun-2019", "PayInAmt": 2967.2, "PatOutAmt": 0, "Exchange": "NSE", "SettlementNo": "2019104", "Segment": "Rolling", "LimitType": "C" }, { "SettlementDt": "17-Jun-2019", "PayInAmt": 6708.6, "PatOutAmt": 0, "Exchange": "BSE", "SettlementNo": "201920051", "Segment": "Rolling", "LimitType": "C" }, { "SettlementDt": "20-Jun-2019", "PayInAmt": 406.2, "PatOutAmt": 0, "Exchange": "NSE", "SettlementNo": "2019114", "Segment": "Rolling", "LimitType": "C" }, { "SettlementDt": "20-Jun-2019", "PayInAmt": 11407.6, "PatOutAmt": 0, "Exchange": "BSE", "SettlementNo": "201920054", "Segment": "Rolling", "LimitType": "C" }], "CashLimit": -3.63797880709171E-12, "AmtAllocated": 16563, "BlockAmt": 0, "TotalSecuritiesallocatedamount": 0, "CurrentSecuritiesLimit": 0, "TotalCurrentLimit": -3.63797880709171E-12 } }

Convert To Delivery

API URL:https://api.icicidirect.com/equity/converttodel


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
SessionTokenStringN/AYes 
ChecksumStringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key)
eq_QTYstringN/AYes 
eq_XCHNG_SGMNT_STTLMNTstringN/AYes 
eq_STCK_CDstringN/AYes 
eq_XCHNG_CDstringN/AYes 
eq_DP_IDstringN/AYes 
eq_DP_CLNT_IDstringN/AYes 
eq_XCHNG_SGMNT_CDstringN/AYes

Output Parameters:-
ParameterTypeDescription/Remark
messageStringMessage returned from system.
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"22-07-2019 18:06:43", "JSONPostData":{"SessionToken":"1176451","Idirect_Userid":"suraj24", "eq_XCHNG_CD":"NSE","eq_STCK_CD":"WIPRO","eq_XCHNG_SGMNT_CD":"N", "eq_XCHNG_SGMNT_STTLMNT":"2019089","eq_QTY":"1"}, "Checksum":"DF05D7885FAF9E0093603EE7EFB50634F6E489F155689C05DB5F7EAD3E884D24"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "message": "Success" } }

Basket Order

API URL:https://api.icicidirect.com/equity/basketorder


Input Parameters:-
ParameterTypeInstanceRequiredDescription/Remark
AppKey StringSingleYes 
time_stamp StringSingleYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringSingleYesidirect userid returned in client details api
 SessionTokenStringSingleYes 
 Basket_ORD_STCK_CD stringMultipleYesstock code
 Basket_ORD_XCHNG_CD stringMultipleYesexchange code
 Basket_ORD_PRDCT_TYP stringMultipleYesproduct type
 Basket_ORD_ORDR_FLW stringMultipleYesorder flow B if you want to buy. S if you want to sell.
 Basket_ORD_EXCTD_QTY stringMultipleYes 
 Basket_ORD_TYP stringMultipleYesorder type Market, Limit or Stop loss
 Basket_ORD_EXCTD_RT stringMultipleYes 
 Basket_ORD_STP_LSS stringMultipleYesStop loss price in case of stoploss order.
 Basket_GMS_CSH_PRDCT_PRCNTGstringMultipleYes 
 Basket_ORD_DSCLSD_QTY stringMultipleYesDisclosed quantity in case of order
 Basket_RQST_TYP stringMultipleYes 
 Basket_POINT_TYPE stringMultipleYesHard code as T 
 Basket_SQ_FLAG stringMultipleNo 
 Basket_ORD_TRD_DT stringSingleYesTrade date format to be dd-Mon-yyyy
 Basket_ORDER_NO stringSingleYes 
Checksum StringSingleYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
ErrMessageStringMessage returned from system.
Basket_ORD_ORDR_RFRNCStringOrder Refrence No
Request Example:-

{"AppKey": "266HZ4!565`48*42c63U96XMF6965g09","time_stamp": "15-Jun-2020 16:01:15", "JSONPostData": {"_inputListData":[{"Basket_ORD_STCK_CD":"3IINFO","Basket_ORD_XCHNG_CD":"NSE","Basket_ORD_PRDCT_TYP":"C", "Basket_ORD_ORDR_FLW":"B","Basket_ORD_EXCTD_QTY":"1","Basket_ORD_TYP":"Limit","Basket_ORD_EXCTD_RT":"1.80", "Basket_ORD_STP_LSS":"0","Basket_GMS_CSH_PRDCT_PRCNTG":"0","Basket_ORD_DSCLSD_QTY":"0","Basket_RQST_TYP":"X", "Basket_POINT_TYPE":"T","Basket_SQ_FLAG":""},{"Basket_ORD_STCK_CD":"STABAN","Basket_ORD_XCHNG_CD":"NSE", "Basket_ORD_PRDCT_TYP":"C","Basket_ORD_ORDR_FLW":"B","Basket_ORD_EXCTD_QTY":"1","Basket_ORD_TYP":"Limit","Basket_ORD_EXCTD_RT":"275", "Basket_ORD_STP_LSS":"0","Basket_GMS_CSH_PRDCT_PRCNTG":"0","Basket_ORD_DSCLSD_QTY":"0","Basket_RQST_TYP":"X", "Basket_POINT_TYPE":"T","Basket_SQ_FLAG":""},{"Basket_ORD_STCK_CD":"WIPRO","Basket_ORD_XCHNG_CD":"NSE", "Basket_ORD_PRDCT_TYP":"C","Basket_ORD_ORDR_FLW":"B","Basket_ORD_EXCTD_QTY":"1","Basket_ORD_TYP":"Limit", "Basket_ORD_EXCTD_RT":"223.56","Basket_ORD_STP_LSS":"0","Basket_GMS_CSH_PRDCT_PRCNTG":"0","Basket_ORD_DSCLSD_QTY":"0", "Basket_RQST_TYP":"X","Basket_POINT_TYPE":"T","Basket_SQ_FLAG":""},{"Basket_ORD_STCK_CD":"ONGC","Basket_ORD_XCHNG_CD":"NSE", "Basket_ORD_PRDCT_TYP":"C","Basket_ORD_ORDR_FLW":"B","Basket_ORD_EXCTD_QTY":"1","Basket_ORD_TYP":"Limit","Basket_ORD_EXCTD_RT":"88.50", "Basket_ORD_STP_LSS":"0","Basket_GMS_CSH_PRDCT_PRCNTG":"0","Basket_ORD_DSCLSD_QTY":"0","Basket_RQST_TYP":"X", "Basket_POINT_TYPE":"T","Basket_SQ_FLAG":""}],"Idirect_Userid":"cash10","SessionToken":"610943","Basket_ORD_TRD_DT":"23-Jan-2020", "Basket_ORDER_NO":"4"},"Checksum": "0A58719FD355FAA2D62AC98AF44DF429FA7382D20BD179470D59942D253A8E11"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "ErrMessage": null, "Basket_ORD_ORDR_RFRNC": "20200615N100000050" }, { "ErrMessage": null, "Basket_ORD_ORDR_RFRNC": "20200615N100000051" }, { "ErrMessage": null, "Basket_ORD_ORDR_RFRNC": "20200615N100000052" }, { "ErrMessage": null, "Basket_ORD_ORDR_RFRNC": "20200615N100000053" }] }

iClick-2-Invest

API URL:https://api.icicidirect.com/equity/iclk2invest


Input Parameters:-
Parameter  TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 InvestmentCode    Investment Code
 prodCode    Product Code
 statusCode    Status Code
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
ical_TRNSCTN_ID string
ical_TRNSCTN_FLW string
ical_DAM_TRNSCTN string
ical_ANSWR_FLAG string
ical_ACTIVE string
ical_VALID_FLAG string
ical_MRGN_FLAG string
ical_LOW_RT string
ical_QUOTE string
ical_TRNSCTN_PRC string
ical_NN_HIGH_PRICE string
ical_NN_LOW_PRICE string
ical_ORD_STP_LSS string
ical_STCK_CD string
ical_XCHNG_CD string
ical_USR_ADDRSS_LN1 string
ical_USR_ADDRSS_LN2 string
ical_ARD_CRNNT_INVSTR string
ical_ARD_PRDCT_TYP_RQSTDstring
ical_STK_STCK_NM string
ical_TRD_DT string
ical_CHART_TYPE string
ical_ARD_CLNT_RMRKS string
ical_EXPIRY_DATE string
ErrMsgString
Request Example:-

{"AppKey":"B2125UR07222384n04_92*161s0+4b77","time_stamp":"16-Mar-2020 17:58:51", "JSONPostData":{"Idirect_Userid":"test","SessionToken":"591556","statusCode":"O", "SegmentType":null,"InvestmentCode":"Medium Term","prodCode":"ALL"}, "Checksum":"D84688A0DB0DEC22D8E355127679B9DDADD95D759E5C18D6428D21C897C1085A"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "ICOutput": [{ "ical_TRNSCTN_ID": "15500", "ical_TRNSCTN_FLW": "S", "ical_DAM_TRNSCTN": "Y", "ical_ANSWR_FLAG": "E", "ical_ACTIVE": "N", "ical_VALID_FLAG": "O", "ical_MRGN_FLAG": "O", "ical_LOW_RT": "-6.75", "ical_QUOTE": "38.95", "ical_TRNSCTN_PRC": "148", "ical_NN_HIGH_PRICE": "0", "ical_NN_LOW_PRICE": "138", "ical_ORD_STP_LSS": "153", "ical_STCK_CD": "YESBAN", "ical_XCHNG_CD": "BSE", "ical_USR_ADDRSS_LN1": "xyz.pdf", "ical_USR_ADDRSS_LN2": "-", "ical_ARD_CRNNT_INVSTR": "1 month", "ical_ARD_PRDCT_TYP_RQSTD": "Result Update", "ical_STK_STCK_NM": "YES BANK LIMITED", "ical_TRD_DT": "23-May-2019", "ical_CHART_TYPE": "P", "ical_ARD_CLNT_RMRKS": "Others", "ical_EXPIRY_DATE": "28-Jun-2019" }, { "ical_TRNSCTN_ID": "1160000", "ical_TRNSCTN_FLW": "S", "ical_DAM_TRNSCTN": "Y", "ical_ANSWR_FLAG": "E", "ical_ACTIVE": "N", "ical_VALID_FLAG": "O", "ical_MRGN_FLAG": "O", "ical_LOW_RT": "-6.75", "ical_QUOTE": "38.95", "ical_TRNSCTN_PRC": "148", "ical_NN_HIGH_PRICE": "0", "ical_NN_LOW_PRICE": "138", "ical_ORD_STP_LSS": "153", "ical_STCK_CD": "YESBAN", "ical_XCHNG_CD": "BSE", "ical_USR_ADDRSS_LN1": "xyz.pdf", "ical_USR_ADDRSS_LN2": "-", "ical_ARD_CRNNT_INVSTR": "1 month", "ical_ARD_PRDCT_TYP_RQSTD": "Result Update", "ical_STK_STCK_NM": "YES BANK LIMITED", "ical_TRD_DT": "23-May-2019", "ical_CHART_TYPE": "P", "ical_ARD_CLNT_RMRKS": "Others", "ical_EXPIRY_DATE": "28-Jun-2019" }] } }

Cash Projection

API URL:https://api.icicidirect.com/equity/cashprojection


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
datestring
Exchange string
Segment string
Settlement string
CSB_DB_CR_FLGstring
Request Example:-

{"AppKey":"B2125UR07222384n04_92*161s0+4b77","time_stamp":"16-Mar-2020 17:58:51", "JSONPostData":{"Idirect_Userid":"test","SessionToken":"591556"}, "Checksum":"D84688A0DB0DEC22D8E355127679B9DDADD95D759E5C18D6428D21C897C1085A"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "cashproj": [{ "date": "2020-May-14", "Exchange": "NSE", "Segment": "Rolling", "Settlement": "2020089", "CSB_DB_CR_FLG": "D" }], "Message": "", "date": "2020-May-14", "CumBalance": "9483027.1" } }

Security Projection

API URL:https://api.icicidirect.com/equity/securityprojection


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
ACTIVEstring
PRDCT_TYP string
date string
CSB_DB_CR_FLG string
StockCodestring
Exchangestring
Segment string
SettlementNo string
ExecQuantity string
Quotestring
Avegpricestring
MaxSellQty string
BlockedQty string
AvailableQty string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"13-May-2020 16:58:35", "JSONPostData":{"Idirect_Userid":"cash10","SessionToken":"602421"}, "Checksum":"F33C44A5FA03540A4D802AD306163D3572E6526CC0070C30EE964869AB9878A9"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "securityProj": [{ "ACTIVE": "Y", "PRDCT_TYP": "Y", "date": "15-May-2020", "CSB_DB_CR_FLG": "C", "StockCode": "ACC", "Exchange": "NSE", "Segment": "N", "SettlementNo": "2020089", "ExecQuantity": "5", "Quote": "1327", "Avegprice": "1327", "MaxSellQty": "5", "BlockedQty": "0", "AvailableQty": "5" }], "Message": "", "BTSTClientEnableFlag": "Y", "ACTIVE": "Y", "BTSTEnableFlag": "Y" } }

I-Sec Margin Details

API URL:https://api.icicidirect.com/equity/isecmargindetails


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
Messagestring
TradeDate string
BankAllocation string
SecuritiesAllocation string
BlockForTradestring
IsecMarginstring
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"13-May-2020 17:35:22", "JSONPostData"{"Idirect_Userid":"cash10","SessionToken":"602428"}, "Checksum":"13244238F62BC8EA253CA04D1824301976B4685701CDD6D047B9A6AFED4BC0D1"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "Message": "", "TradeDate": "13-May-2020", "BankAllocation": "9483027.1", "SecuritiesAllocation": "286.34", "BlockForTrade": "0", "IsecMargin": "9827.44" } }

ETF List

API URL:https://api.icicidirect.com/equity/etflist


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
StockCode string
Exchange string
Category string
StockName string
PriceBand string
Spot string
MRGN_FLG string
MRGN_PRDCT_PRCNTG string
IDD_PRCNTG_CHNG_PCLS string
SQRD_OFF_PCTG string
SEGMENT string
LM_FLGstring
MSG_TYPstring
STCK_EXISTS string
GMS_MRGN_PRDCT_PRCNTG string
CSH_PRDCT_PRCNTG string
O_PRCstring
MIN_CLS_RTstring
MRGN_LMTstring
ST string
ML_FLG string
NEW_CLOSE_IND string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"11-May-2020 19:45:45", "JSONPostData":"{\"Idirect_Userid\":\"cash10\",\"SessionToken\":\"601945\"}", "Checksum":"EE04CF8104DAFD80F7007C9235E64BB57D362674DF221B74D794314F6FBC9F1D"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "StockCode": "BHABO2", "Exchange": "NSE", "Category": "Index - Debt", "StockName": "BHARAT BOND 2", "PriceBand": "20", "Spot": "78", "MRGN_FLG": "89", "MRGN_PRDCT_PRCNTG": "40", "IDD_PRCNTG_CHNG_PCLS": "100", "SQRD_OFF_PCTG": "100", "SEGMENT": "Rolling", "LM_FLG": "78", "MSG_TYP": "0", "STCK_EXISTS": "78", "GMS_MRGN_PRDCT_PRCNTG": "0", "CSH_PRDCT_PRCNTG": "4", "O_PRC": "43", "MIN_CLS_RT": "80", "MRGN_LMT": "80", "ST": "89", "ML_FLG": "84", "NEW_CLOSE_IND": "89" }, { "StockCode": "BHABO1", "Exchange": "NSE", "Category": "Index - Debt", "StockName": "BHARAT BOND 1", "PriceBand": "20", "Spot": "89", "MRGN_FLG": "78", "MRGN_PRDCT_PRCNTG": "0", "IDD_PRCNTG_CHNG_PCLS": "0", "SQRD_OFF_PCTG": "0", "SEGMENT": "Rolling", "LM_FLG": "78", "MSG_TYP": "0", "STCK_EXISTS": "78", "GMS_MRGN_PRDCT_PRCNTG": "0", "CSH_PRDCT_PRCNTG": "4", "O_PRC": "43", "MIN_CLS_RT": "80", "MRGN_LMT": "80", "ST": "78", "ML_FLG": "84", "NEW_CLOSE_IND": "89" }, { "StockCode": "BANBEE", "Exchange": "BSE", "Category": "ETF - Gold", "StockName": "RELIANCE ETF BANK BEES", "PriceBand": "20", "Spot": "78", "MRGN_FLG": "89", "MRGN_PRDCT_PRCNTG": "0", "IDD_PRCNTG_CHNG_PCLS": "100", "SQRD_OFF_PCTG": "100", "SEGMENT": "Rolling", "LM_FLG": "78", "MSG_TYP": "0", "STCK_EXISTS": "78", "GMS_MRGN_PRDCT_PRCNTG": "0", "CSH_PRDCT_PRCNTG": "4", "O_PRC": "43", "MIN_CLS_RT": "80", "MRGN_LMT": "80", "ST": "78", "ML_FLG": "84", "NEW_CLOSE_IND": "78" }, { "StockCode": "BANBEE", "Exchange": "NSE", "Category": "ETF - Gold", "StockName": "RELIANCE ETF BANK BEES", "PriceBand": "20", "Spot": "78", "MRGN_FLG": "89", "MRGN_PRDCT_PRCNTG": "0", "IDD_PRCNTG_CHNG_PCLS": "11", "SQRD_OFF_PCTG": "11", "SEGMENT": "Rolling", "LM_FLG": "78", "MSG_TYP": "0", "STCK_EXISTS": "89", "GMS_MRGN_PRDCT_PRCNTG": "0", "CSH_PRDCT_PRCNTG": "4", "O_PRC": "34", "MIN_CLS_RT": "6", "MRGN_LMT": "6", "ST": "78", "ML_FLG": "84", "NEW_CLOSE_IND": "89" }, { "StockCode": "AXINIF", "Exchange": "NSE", "Category": "ETF - Index", "StockName": "AXIS NIFTY ETF", "PriceBand": "0", "Spot": "78", "MRGN_FLG": "78", "MRGN_PRDCT_PRCNTG": "0", "IDD_PRCNTG_CHNG_PCLS": "0", "SQRD_OFF_PCTG": "0", "SEGMENT": "Rolling", "LM_FLG": "78", "MSG_TYP": "0", "STCK_EXISTS": "78", "GMS_MRGN_PRDCT_PRCNTG": "0", "CSH_PRDCT_PRCNTG": "4", "O_PRC": "43", "MIN_CLS_RT": "80", "MRGN_LMT": "80", "ST": "78", "ML_FLG": "84", "NEW_CLOSE_IND": "78" }, { "StockCode": "AXIGOL", "Exchange": "BSE", "Category": "GOLD - ETF", "StockName": "AXIS Gold ETF", "PriceBand": "20", "Spot": "78", "MRGN_FLG": "89", "MRGN_PRDCT_PRCNTG": "0", "IDD_PRCNTG_CHNG_PCLS": "100", "SQRD_OFF_PCTG": "100", "SEGMENT": "Rolling", "LM_FLG": "78", "MSG_TYP": "0", "STCK_EXISTS": "78", "GMS_MRGN_PRDCT_PRCNTG": "0", "CSH_PRDCT_PRCNTG": "4", "O_PRC": "43", "MIN_CLS_RT": "80", "MRGN_LMT": "80", "ST": "78", "ML_FLG": "84", "NEW_CLOSE_IND": "78" }, { "StockCode": "AXIGOL", "Exchange": "NSE", "Category": "GOLD - ETF", "StockName": "AXIS Gold ETF", "PriceBand": "20", "Spot": "78", "MRGN_FLG": "78", "MRGN_PRDCT_PRCNTG": "0", "IDD_PRCNTG_CHNG_PCLS": "0", "SQRD_OFF_PCTG": "0", "SEGMENT": "Rolling", "LM_FLG": "78", "MSG_TYP": "0", "STCK_EXISTS": "78", "GMS_MRGN_PRDCT_PRCNTG": "0", "CSH_PRDCT_PRCNTG": "4", "O_PRC": "43", "MIN_CLS_RT": "80", "MRGN_LMT": "80", "ST": "78", "ML_FLG": "84", "NEW_CLOSE_IND": "78" }] }

NCD List

API URL:https://api.icicidirect.com/equity/ncdlist


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 strTypeStringN/ANo 
 CategoryFlgStringN/ANo 
 searchStringN/ANo 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
TotalCount string
Exc string
IssuerName string
NCDName string
CreditRating string
CouponRate string
Couponpayfreq string
LTP string
MaturityAmt string
EXDate string
RecordDate string
IndicativeYTMstring
MaturityDatestring
Couponpayoutdate string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"11-May-2020 20:17:10", "JSONPostData":"{"Idirect_Userid":"cash10","SessionToken":"601957"}", "Checksum":"2BDC751A3A497CD8D55AED7D43F370B3EC82B4DB1C7FD0C63D2316EDCC88BB27"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "objlmt": [{ "Exc": "BSE", "IssuerName": "National Highways Authority of India", "NCDName": "NHAI 8.2% BD 25JN22", "CreditRating": "CARE AA+", "CouponRate": "8.37", "Couponpayfreq": "Half-Yearly", "LTP": "1102.99", "MaturityAmt": "1000", "EXDate": "10-Sep-2019", "RecordDate": "11-Sep-2019", "IndicativeYTM": "6.76", "MaturityDate": "12-Feb-2033", "Couponpayoutdate": "12Feb,12Sep" }, { "Exc": "NSE", "IssuerName": "RURUAL ELEC CORP", "NCDName": "REC 7.38% BD 19DC27", "CreditRating": "IND AA+", "CouponRate": "7.38", "Couponpayfreq": "Yearly", "LTP": "1160", "MaturityAmt": "1000", "EXDate": "NA", "RecordDate": "NA", "IndicativeYTM": "0", "MaturityDate": "04-Jan-2017", "Couponpayoutdate": "04Jan" }, { "Exc": "BSE", "IssuerName": "HOUSING AND URBAN DEVELOPMENT CORP", "NCDName": "HUDCO 7.03% LOA 28MR23", "CreditRating": "BWR AAA", "CouponRate": "7.03", "Couponpayfreq": "Yearly", "LTP": "1040", "MaturityAmt": "1000", "EXDate": "12-Mar-2020", "RecordDate": "13-Mar-2020", "IndicativeYTM": "0", "MaturityDate": "28-Mar-2023", "Couponpayoutdate": "28Mar" }, { "Exc": "NSE", "IssuerName": "National Highways Authority of India", "NCDName": "NHAI 8.2% BD 25JN22", "CreditRating": "CARE AA+", "CouponRate": "8.37", "Couponpayfreq": "Half-Yearly", "LTP": "1082", "MaturityAmt": "1000", "EXDate": "10-Sep-2019", "RecordDate": "11-Sep-2019", "IndicativeYTM": "0", "MaturityDate": "12-Feb-2033", "Couponpayoutdate": "12Feb,12Sep" }, { "Exc": "BSE", "IssuerName": "National Highways Authority of India", "NCDName": "NHAI 8.3% BD 25JN27", "CreditRating": "CRISIL A4+", "CouponRate": "8.3", "Couponpayfreq": "Yearly", "LTP": "1227.87", "MaturityAmt": "1000", "EXDate": "16-Jul-2019", "RecordDate": "17-Jul-2019", "IndicativeYTM": "0", "MaturityDate": "01-Mar-2022", "Couponpayoutdate": "01Aug" }, { "Exc": "NSE", "IssuerName": "National Highways Authority of India", "NCDName": "NHAI 8.3% BD 25JN27", "CreditRating": "CRISIL A4+", "CouponRate": "8.3", "Couponpayfreq": "Yearly", "LTP": "1200.04", "MaturityAmt": "1000", "EXDate": "16-Jul-2019", "RecordDate": "17-Jul-2019", "IndicativeYTM": "0", "MaturityDate": "01-Mar-2022", "Couponpayoutdate": "01Aug" }, { "Exc": "BSE", "IssuerName": "NATIONAL HIGHWAYS AUTHORITY OF INDIA", "NCDName": "NHAI SR IIA 8.5 05FB29 FV1000", "CreditRating": "CRISIL AAA", "CouponRate": "8.5", "Couponpayfreq": "Yearly", "LTP": "1191.5", "MaturityAmt": "1000", "EXDate": "NA", "RecordDate": "NA", "IndicativeYTM": "0", "MaturityDate": "01-Oct-2019", "Couponpayoutdate": "15Mar" }], "TotalCount": "11" } }

Stock List

API URL:https://api.icicidirect.com/equity/stocklist


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 exchgCodeStringN/AYesExchange Code
 prodCodeStringN/AYesProduct Code
 stckCodeStringN/AYesStock Code
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
StockCode string
eATM string
NRI string
BTST string
BuyBrokerMode_IM string
BuyBrokerMode_MM string
SellBrokerMode_IM string
SellBrokerMode_MM string
FlexiCash_ClientMode_IM string
FlexiCash_ClientMode_MM string
FlexiCash_ClientSquoffModeEnable string
ClientwiseStock_wiseLimit string
MarginPLUS string
BulletAllowed string
MarginPLUSMinDiff string
ProfitOrdAllowed string
LimitOrdAllowedstring
ProfitPriceSLTPDiff string
SLTPUpdate string
MinTrailingAmount string
Request Example:-

{"AppKey":" 266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"11-May-2020 17:16:10", "JSONPostData":{"exchgCode":"NSE","prodCode":"A","stckCode":"A", "Idirect_Userid":"cash10","SessionToken":"601869"}, "Checksum":"AB2656417881ECB0085257829B6739B4B5A247CE02B21DC4855755C5A9EE80C6"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "StockCode": "AVESUP", "eATM": "N", "NRI": "Y", "BTST": "Y", "BuyBrokerMode_IM": "0", "BuyBrokerMode_MM": "3", "SellBrokerMode_IM": "0", "SellBrokerMode_MM": "3", "FlexiCash_ClientMode_IM": "0", "FlexiCash_ClientMode_MM": "34", "FlexiCash_ClientSquoffModeEnable": "N", "ClientwiseStock_wiseLimit": "999999999999", "MarginPLUS": "0", "BulletAllowed": "N", "MarginPLUSMinDiff": "2", "ProfitOrdAllowed": "Y", "LimitOrdAllowed": "Y", "ProfitPriceSLTPDiff": "2", "SLTPUpdate": "5.4", "MinTrailingAmount": "0.05" }, { "StockCode": "AVTHOM", "eATM": "N", "NRI": "Y", "BTST": "Y", "BuyBrokerMode_IM": "0", "BuyBrokerMode_MM": "7", "SellBrokerMode_IM": "0", "SellBrokerMode_MM": "7", "FlexiCash_ClientMode_IM": "0", "FlexiCash_ClientMode_MM": "36", "FlexiCash_ClientSquoffModeEnable": "N", "ClientwiseStock_wiseLimit": "999999999999", "MarginPLUS": "0", "BulletAllowed": "N", "MarginPLUSMinDiff": "4", "ProfitOrdAllowed": "Y", "LimitOrdAllowed": "Y", "ProfitPriceSLTPDiff": "2", "SLTPUpdate": "0.2", "MinTrailingAmount": "0.05" }, { "StockCode": "AXIBAN", "eATM": "N", "NRI": "Y", "BTST": "Y", "BuyBrokerMode_IM": "55", "BuyBrokerMode_MM": "49", "SellBrokerMode_IM": "55", "SellBrokerMode_MM": "49", "FlexiCash_ClientMode_IM": "0", "FlexiCash_ClientMode_MM": "9", "FlexiCash_ClientSquoffModeEnable": "N", "ClientwiseStock_wiseLimit": "50000", "MarginPLUS": "0", "BulletAllowed": "Y", "MarginPLUSMinDiff": "0.25", "ProfitOrdAllowed": "Y", "LimitOrdAllowed": "Y", "ProfitPriceSLTPDiff": "0.4", "SLTPUpdate": "2.45", "MinTrailingAmount": "0.05" }, { "StockCode": "AXIGOL", "eATM": "N", "NRI": "N", "BTST": "N", "BuyBrokerMode_IM": "0", "BuyBrokerMode_MM": "80", "SellBrokerMode_IM": "0", "SellBrokerMode_MM": "80", "FlexiCash_ClientMode_IM": "0", "FlexiCash_ClientMode_MM": "43", "FlexiCash_ClientSquoffModeEnable": "N", "ClientwiseStock_wiseLimit": "999999999999", "MarginPLUS": "0", "BulletAllowed": "N", "MarginPLUSMinDiff": "4", "ProfitOrdAllowed": "N", "LimitOrdAllowed": "N", "ProfitPriceSLTPDiff": "0", "SLTPUpdate": "0", "MinTrailingAmount": "0" }, { "StockCode": "AXIIT", "eATM": "N", "NRI": "Y", "BTST": "Y", "BuyBrokerMode_IM": "0", "BuyBrokerMode_MM": "7", "SellBrokerMode_IM": "0", "SellBrokerMode_MM": "7", "FlexiCash_ClientMode_IM": "0", "FlexiCash_ClientMode_MM": "34", "FlexiCash_ClientSquoffModeEnable": "N", "ClientwiseStock_wiseLimit": "999999999999", "MarginPLUS": "0", "BulletAllowed": "N", "MarginPLUSMinDiff": "4", "ProfitOrdAllowed": "Y", "LimitOrdAllowed": "Y", "ProfitPriceSLTPDiff": "2", "SLTPUpdate": "0.7", "MinTrailingAmount": "0.05" }, { "StockCode": "AXINIF", "eATM": "N", "NRI": "N", "BTST": "N", "BuyBrokerMode_IM": "0", "BuyBrokerMode_MM": "80", "SellBrokerMode_IM": "0", "SellBrokerMode_MM": "80", "FlexiCash_ClientMode_IM": "0", "FlexiCash_ClientMode_MM": "43", "FlexiCash_ClientSquoffModeEnable": "N", "ClientwiseStock_wiseLimit": "999999999999", "MarginPLUS": "0", "BulletAllowed": "N", "MarginPLUSMinDiff": "4", "ProfitOrdAllowed": "N", "LimitOrdAllowed": "N", "ProfitPriceSLTPDiff": "0", "SLTPUpdate": "0", "MinTrailingAmount": "0" }, { "StockCode": "AYMSYN", "eATM": "N", "NRI": "Y", "BTST": "Y", "BuyBrokerMode_IM": "0", "BuyBrokerMode_MM": "7", "SellBrokerMode_IM": "0", "SellBrokerMode_MM": "7", "FlexiCash_ClientMode_IM": "0", "FlexiCash_ClientMode_MM": "36", "FlexiCash_ClientSquoffModeEnable": "N", "ClientwiseStock_wiseLimit": "999999999999", "MarginPLUS": "0", "BulletAllowed": "N", "MarginPLUSMinDiff": "4", "ProfitOrdAllowed": "Y", "LimitOrdAllowed": "Y", "ProfitPriceSLTPDiff": "2", "SLTPUpdate": "0.4", "MinTrailingAmount": "0.05" }] }

Prepaid Usage Summary

API URL:https://api.icicidirect.com/equity/prepaidcardsum


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
NRIPrepaidPlan string
EligibleTurnover string
UtilizedTurnover string
BalanceTurnover string
Planselected string
Initialvalue string
UtilizedAmount string
Remainingbalance string
StartDate string
ValidTill string
Closedate string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"11-May-2020 20:17:10", "JSONPostData":"{"Idirect_Userid":"cash10","SessionToken":"601957"}", "Checksum":"2BDC751A3A497CD8D55AED7D43F370B3EC82B4DB1C7FD0C63D2316EDCC88BB27"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "NRIPrepaidPlan": null, "EligibleTurnover": null, "UtilizedTurnover": null, "BalanceTurnover": null, "Planselected": "PPS25K", "Initialvalue": "29750", "UtilizedAmount": "0", "Remainingbalance": "29750", "StartDate": "27-Jan-2020", "ValidTill": "27-Jan-2035", "Closedate": "*" }, { "NRIPrepaidPlan": null, "EligibleTurnover": null, "UtilizedTurnover": null, "BalanceTurnover": null, "Planselected": "PPS25K", "Initialvalue": "29750", "UtilizedAmount": "29750", "Remainingbalance": "0", "StartDate": "23-Oct-2019", "ValidTill": "23-Oct-2034", "Closedate": "*" }] }

My Messages

API URL:https://api.icicidirect.com/equity/mymessages


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 FROM_DTStringN/AYesFrom Date
 TO_DTStringN/AYesTill date
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
MatchAC string
Date string
Message string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"11-May-2020 20:39:20", "JSONPostData":{"FROM_DT":"01-Jan-2020","TO_DT":"31-Dec-2020"}, "Checksum":"06531C0E36034827F09CDABD6C3A0FEF159614BB6CFEC5A6DFA7EBD1B9B420D8"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "MatchAC": "8500011155", "Date": "27-Jan-2020", "Message": "Dear Customer, Amount of Rs 1974641.87 is outstanding in your account for more than 2 days. Hence we have placed your account in square off mode and cancelled fresh overnight orders in your account." }, { "MatchAC": "8500011155", "Date": "27-Jan-2020", "Message": "Dear Customer, Amount of Rs 1974641.87 is outstanding in your account for more than 2 days. Hence we have placed your account in square off mode and cancelled fresh overnight orders in your account." }, { "MatchAC": "8500011155", "Date": "20-Jan-2020", "Message": "We have received your request for switching to Running Account Authorization mode. We shall process the same within 5 working days. Please check my messages for updates." }] }

Market Messages

API URL:https://api.icicidirect.com/equity/marketmsg


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 ExchangeStringN/ANo 
 PgNoStringN/ANo 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
NewMessage string
TotPgNo string
Time string
Message string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"22-May-2020 13:09:38", "JSONPostData":{"Idirect_Userid":"cash10","SessionToken":"605385"}, "Checksum":"7D88181D776C8A4206D866166360A915211C847570D39674BB29CA3E73840F28"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "objlmt": [{ "Time": "07-Mar-2020 14:19:47", "Message": "NSE : Nifty 50 has touched 12090.70. The Markets will halt." }, { "Time": "07-Mar-2020 14:19:04", "Message": "NSE : Members are requested to note that there would be a market halt if the Nifty 50 value crosses 12088.40 (+ 1098.95)." }, { "Time": "07-Mar-2020 14:19:04", "Message": "NSE : Members are requested to note that there would be a market halt if the Nifty 50 value crosses 12088.40 (+ 1098.95)." }, { "Time": "07-Mar-2020 14:19:03", "Message": "NSE : Members are requested to note that there would be a market halt if the Nifty 50 value crosses 12088.40 (+ 1098.95)." }, { "Time": "07-Mar-2020 14:19:03", "Message": "NSE : Members are requested to note that there would be a market halt if the Nifty 50 value crosses 12088.40 (+ 1098.95)." }, { "Time": "07-Mar-2020 14:19:02", "Message": "NSE : Members are requested to note that there would be a market halt if the Nifty 50 value crosses 12088.40 (+ 1098.95)." }, { "Time": "07-Mar-2020 14:19:02", "Message": "NSE : Members are requested to note that there would be a market halt if the Nifty 50 value crosses 12088.40 (+ 1098.95)." }, { "Time": "07-Mar-2020 14:19:01", "Message": "NSE : Members are requested to note that there would be a market halt if the Nifty 50 value crosses 12088.40 (+ 1098.95)." }, { "Time": "07-Mar-2020 14:19:01", "Message": "NSE : Members are requested to note that there would be a market halt if the Nifty 50 value crosses 12088.40 (+ 1098.95)." }, { "Time": "07-Mar-2020 14:18:52", "Message": "NSE : Members are requested to note that there would be a market halt if the Nifty 50 value crosses 12088.40 (+ 1098.95)." }, { "Time": "07-Mar-2020 14:18:52", "Message": "NSE : Members are requested to note that there would be a market halt if the Nifty 50 value crosses 12088.40 (+ 1098.95)." }, { "Time": "07-Mar-2020 14:18:51", "Message": "NSE : Members are requested to note that there would be a market halt if the Nifty 50 value crosses 12088.40 (+ 1098.95)." }], "NewMessage": "", "TotPgNo": "884" } }

SEP Request Book

API URL:https://api.icicidirect.com/equity/seprequestbook


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 FrmDateStringN/AYes 
 ToDateStringN/AYes 
 ExchangeStringN/ANo 
 StockCodeStringN/ANo 
 OrderStatusStringN/ANo 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
Date string
SEPReferenceNo string
Exchange string
Channel string
Stock string
ProdTyp string
Quantity string
Amount string
Status string
Frequency string
TotalPeriod string
SEPStartDate string
SEPEndDate string
NextSEPDate string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"22-May-2020 13:56:03", "JSONPostData":{"FrmDate":"22-May-2020","ToDate":"22-May-2020","Idirect_Userid":"cash10","SessionToken":"605401"}, "Checksum":"E754ED175B1B70B4FEEF3D493611AE93DB6B65445CFD8B900C4768E60F25A27F"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "Date": "22-May-2020 03:17:36", "SEPReferenceNo": "SEP2020052202485", "Exchange": "NSE", "Channel": "WEB", "Stock": "ACC", "ProdTyp": "A", "Quantity": "1", "Amount": "1500", "Status": "O", "Frequency": "D", "TotalPeriod": "24", "SEPStartDate": "22-May-2020", "SEPEndDate": "22-May-2022", "NextSEPDate": "Daily" }] }

Existing SEP

API URL:https://api.icicidirect.com/equity/existingsep


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
Date string
SEPReferenceNo string
Exchange string
Channel string
Stock string
ProdTyp string
Quantity string
Amount string
Status string
Frequency string
TotalPeriod string
SEPStartDate string
SEPEndDate string
NextSEPDate string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"22-May-2020 13:56:03", "JSONPostData":{"Idirect_Userid":"cash10","SessionToken":"605401"}, "Checksum":"E754ED175B1B70B4FEEF3D493611AE93DB6B65445CFD8B900C4768E60F25A27F"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "Date": "15-May-2020 11:20:09", "SEPReferenceNo": "SEP2020051502476", "Exchange": "NSE", "Channel": "WEB", "Stock": "BHAAIR", "SEPType": "A", "Quantity": "3", "Amount": "2000", "Status": "O", "Frequency": "M", "TotalPeriod": "6", "SEPStartDate": "25-May-2020", "SEPEndDate": "25-Oct-2020", "NextSEPDate": "25-May-2020" }, { "Date": "15-May-2020 11:24:24", "SEPReferenceNo": "SEP2020051502477", "Exchange": "NSE", "Channel": "WEB", "Stock": "STABAN", "SEPType": "Q", "Quantity": "10", "Amount": "0", "Status": "O", "Frequency": "M", "TotalPeriod": "-1", "SEPStartDate": "27-May-2020", "SEPEndDate": "", "NextSEPDate": "27-May-2020" }, { "Date": "15-May-2020 11:25:44", "SEPReferenceNo": "SEP2020051502478", "Exchange": "NSE", "Channel": "WEB", "Stock": "AXIBAN", "SEPType": "A", "Quantity": "2", "Amount": "2000", "Status": "O", "Frequency": "F", "TotalPeriod": "39", "SEPStartDate": "27-May-2020", "SEPEndDate": "27-Aug-2023", "NextSEPDate": "27-May-2020" }] }

SEP Stock List

API URL:https://api.icicidirect.com/equity/sepstocklist


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 ExchangeCodeStringN/AYesExchange Code
 StockCodeStringN/AYesStock Code
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
StockCode string
StockName string
Exchange string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"22-May-2020 01:40:32", "JSONPostData":{"ExchangeCode":"A","StockCode":"ACC","Idirect_Userid":"cash10","SessionToken":"605285"}, "Checksum":"902515E312B1B66B9B214B0B7B65354206B91ACB0402027E6406C850F3B97A92"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "StockCode": "ACC ", "StockName": "ACC LIMITED", "Exchange": "BSE" }, { "StockCode": "ACC ", "StockName": "ACC LIMITED", "Exchange": "NSE" }] }

ETF SEP Stock List

API URL:https://api.icicidirect.com/equity/sepetfstocklist


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 ExchangeCodeStringN/ANoExchange Code
 StockCodeStringN/ANoStock Code
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
StockCode string
StockName string
Exchange string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"21-May-2020 20:05:20", "JSONPostData":{"Idirect_Userid":"cash10","SessionToken":"605218"}, "Checksum":"8CDAE75AEE77505981DD9CBADF79E417764C713639D4737E5FFE036EDA54DBFC"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "StockCode": "BANBEE", "StockName": "RELIANCE ETF BANK BEES", "Exchange": "NSE" }, { "StockCode": "BHABO1", "StockName": "BHARAT BOND 1", "Exchange": "NSE" }, { "StockCode": "BHABO2", "StockName": "BHARAT BOND 2", "Exchange": "NSE" }, { "StockCode": "CPSETF", "StockName": "CPSE ETF", "Exchange": "BSE" }, { "StockCode": "CPSETF", "StockName": "CPSE ETF", "Exchange": "NSE" }, { "StockCode": "GOLDEX", "StockName": "RELIANCE ETF GOLD BEES", "Exchange": "NSE" }, { "StockCode": "ICI100", "StockName": "ICICI PRUD NIFTY 100 iWIN ETF", "Exchange": "NSE" }, { "StockCode": "ICIGOL", "StockName": "ICICI PRUDENTIAL GOLD iWIN ETF", "Exchange": "NSE" }, { "StockCode": "ICIMID", "StockName": "ICICI PRUD MIDCAP iWIN ETF", "Exchange": "NSE" }, { "StockCode": "ICIN20", "StockName": "ICICI PRUDENTIAL NV20 iWIN ETF", "Exchange": "NSE" }, { "StockCode": "ICINIF", "StockName": "ICICI PRUD NIFTY iWIN ETF", "Exchange": "NSE" }, { "StockCode": "ICINIF", "StockName": "ICICI PRUD NIFTY iWIN ETF", "Exchange": "BSE" }, { "StockCode": "KOTBAN", "StockName": "KOTAK MF - KOTAK BANKING ETF", "Exchange": "NSE" }, { "StockCode": "KOTGOL", "StockName": "KOTAK GOLD ETF", "Exchange": "NSE" }, { "StockCode": "KOTNIF", "StockName": "KOTAK MAHINDRA MF - NIFTY ETF", "Exchange": "NSE" }, { "StockCode": "KOTPSB", "StockName": "KOTAK MF - PSU BANK ETF", "Exchange": "NSE" }, { "StockCode": "LIBEES", "StockName": "RELIANCE ETF LIQUID BEES", "Exchange": "NSE" }, { "StockCode": "LIBEES", "StockName": "RELIANCE ETF LIQUID BEES", "Exchange": "BSE" }, { "StockCode": "NIFBEE", "StockName": "RELIANCE ETF NIFTY BEES", "Exchange": "NSE" }, { "StockCode": "NIFJUN", "StockName": "RELIANCE ETF JUNIOR BEES", "Exchange": "NSE" }, { "StockCode": "PSUBAN", "StockName": "RELIANCE ETF PSU BANK BEES", "Exchange": "NSE" }, { "StockCode": "SBIGOL", "StockName": "SBI-ETF GOLD", "Exchange": "NSE" }, { "StockCode": "UTGOLD", "StockName": "UTI GOLD ETF", "Exchange": "NSE" }] }

I-Sec Margin History

API URL:https://api.icicidirect.com/equity/isecmarginhistory


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 FROM_DTStringN/ANoExchange Code
 TO_DTStringN/ANoExchange Code
 ExchangeStringN/ANoStock Code
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
Tradedate string
Exchange string
Totalmargin string
SAMmargin string
Cashmargin string
OldIsecmarginamount string
ISecMarginDr_CrAmount string
Dr_Crtocustomer string
Status string
Indicator string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"28-May-2020 09:30:36", "JSONPostData":{"FROM_DT":"27-May-2019","TO_DT":"13-May-2020","Idirect_Userid":"cash10","SessionToken":"607041"}, "Checksum":"D8AE5C3348F3967DF2AABF82159C01ADB732B8A3FEF7A26F6D1F6AF217237B53"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "Tradedate": "12-May-2020", "Exchange": "NSE", "Totalmargin": "1736", "SAMmargin": "0", "Cashmargin": "1736", "OldIsecmarginamount": "9827.44", "ISecMarginDr_CrAmount": "1736", "Dr_Crtocustomer": "DEBIT", "Status": "SUCCESS", "Indicator": "SYS" }, { "Tradedate": "08-May-2020", "Exchange": "NSE", "Totalmargin": "0", "SAMmargin": "0", "Cashmargin": "0", "OldIsecmarginamount": "9827.44", "ISecMarginDr_CrAmount": "0", "Dr_Crtocustomer": "DEBIT", "Status": "NEW", "Indicator": "SYS" }, { "Tradedate": "24-Feb-2020", "Exchange": "NSE", "Totalmargin": "0", "SAMmargin": "0", "Cashmargin": "0", "OldIsecmarginamount": "9302.08", "ISecMarginDr_CrAmount": "0", "Dr_Crtocustomer": "DEBIT", "Status": "NEW", "Indicator": "SYS" }, { "Tradedate": "20-Feb-2020", "Exchange": "NSE", "Totalmargin": "0", "SAMmargin": "0", "Cashmargin": "0", "OldIsecmarginamount": "9302.08", "ISecMarginDr_CrAmount": "0", "Dr_Crtocustomer": "DEBIT", "Status": "NEW", "Indicator": "SYS" }, { "Tradedate": "30-Jan-2020", "Exchange": "NSE", "Totalmargin": "0", "SAMmargin": "0", "Cashmargin": "0", "OldIsecmarginamount": "9382.22", "ISecMarginDr_CrAmount": "14.53", "Dr_Crtocustomer": "DEBIT", "Status": "FAIL", "Indicator": "SYS" }, { "Tradedate": "23-Jan-2020", "Exchange": "NSE", "Totalmargin": "8043.75", "SAMmargin": "14.53", "Cashmargin": "8029.22", "OldIsecmarginamount": "10890.97", "ISecMarginDr_CrAmount": "1508.75", "Dr_Crtocustomer": "CREDIT", "Status": "SUCCESS", "Indicator": "SYS" }, { "Tradedate": "03-Jan-2020", "Exchange": "NSE", "Totalmargin": "9803.06", "SAMmargin": "14.53", "Cashmargin": "9788.53", "OldIsecmarginamount": "10890.97", "ISecMarginDr_CrAmount": "0", "Dr_Crtocustomer": "DEBIT", "Status": "NEW", "Indicator": "SYS" }, { "Tradedate": "23-Dec-2019", "Exchange": "NSE", "Totalmargin": "11868.36", "SAMmargin": "14.53", "Cashmargin": "11853.83", "OldIsecmarginamount": "10890.97", "ISecMarginDr_CrAmount": "0", "Dr_Crtocustomer": "DEBIT", "Status": "NEW", "Indicator": "SYS" }, { "Tradedate": "20-Dec-2019", "Exchange": "NSE", "Totalmargin": "11868.36", "SAMmargin": "14.53", "Cashmargin": "11853.83", "OldIsecmarginamount": "1203", "ISecMarginDr_CrAmount": "9687.97", "Dr_Crtocustomer": "DEBIT", "Status": "SUCCESS", "Indicator": "SYS" }, { "Tradedate": "06-Dec-2019", "Exchange": "NSE", "Totalmargin": "2165.86", "SAMmargin": "0", "Cashmargin": "2165.86", "OldIsecmarginamount": "1203", "ISecMarginDr_CrAmount": "0", "Dr_Crtocustomer": "DEBIT", "Status": "NEW", "Indicator": "SYS" }, { "Tradedate": "26-Nov-2019", "Exchange": "NSE", "Totalmargin": "2015.3", "SAMmargin": "0", "Cashmargin": "2015.3", "OldIsecmarginamount": "1203", "ISecMarginDr_CrAmount": "0", "Dr_Crtocustomer": "DEBIT", "Status": "NEW", "Indicator": "SYS" }, { "Tradedate": "25-Nov-2019", "Exchange": "NSE", "Totalmargin": "2015.3", "SAMmargin": "0", "Cashmargin": "2015.3", "OldIsecmarginamount": "1203", "ISecMarginDr_CrAmount": "0", "Dr_Crtocustomer": "DEBIT", "Status": "NEW", "Indicator": "SYS" }, { "Tradedate": "13-Jun-2019", "Exchange": "NSE", "Totalmargin": "0", "SAMmargin": "0", "Cashmargin": "0", "OldIsecmarginamount": "203", "ISecMarginDr_CrAmount": "406", "Dr_Crtocustomer": "DEBIT", "Status": "FAIL", "Indicator": "SYS" }, { "Tradedate": "12-Jun-2019", "Exchange": "NSE", "Totalmargin": "0", "SAMmargin": "0", "Cashmargin": "0", "OldIsecmarginamount": "203", "ISecMarginDr_CrAmount": "406", "Dr_Crtocustomer": "DEBIT", "Status": "FAIL", "Indicator": "SYS" }] }

SEP Place Order

API URL:https://api.icicidirect.com/equity/sepplaceorder


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 TO_PERIODStringN/AYesPeriod in Months
 CDM_CD_IDStringN/AYes
 ORD_ORDR_QTYStringN/AYesOrder Qty
 NN_VALUE_TRDStringN/ANoTrade Value
 INTEREST_FREQStringN/AYesFrequency
 PRDCT_TYPStringN/AYesProduct
 PRTFLO_EXISTSStringN/ANo
 ORD_LMT_MRKT_FLGStringN/AYes
 BUY_SELLStringN/AYesAction
 RQST_TYP StringN/AYesRequest Type
 XCHNG_CDStringN/AYesExchange Code
 GMS_STRT_DTStringN/AYesStart Date
 ORD_STCK_CDStringN/AYesStock Code
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
sip_allow string
TRD_REF string
PortExist string
IsOTPShow string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"28-May-2020 12:39:15", "JSONPostData":{"TO_PERIOD":"24","CDM_CD_ID":"999999","ORD_ORDR_QTY":"1000","NN_VALUE_TRD":null,"INTEREST_FREQ":"D", "PRDCT_TYP":"C","PRTFLO_EXISTS":"N","ORD_LMT_MRKT_FLG":"M","BUY_SELL":"B","RQST_TYP":"Q","XCHNG_CD":"NSE", "GMS_STRT_DT":"28/05/2020","ORD_STCK_CD":"ACC","Idirect_Userid":"cash10","SessionToken":"607108"}, "Checksum":"AB154193E48F1E939337CDB775CA78D2F35E5112531A3569BBE5AB5D64FB1F76"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "sip_allow": "28-May-2020", "TRD_REF": "SEP2020052802488", "PortExist": "", "IsOTPShow": null } }

iClick-2-Gain

API URL:https://api.icicidirect.com/equity/clicktogain


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 sellBuyStringN/ANoAction
 recommTypeStringN/ANo
 stockCodeStringN/ANoStock Code
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
CallType string
Act string
Stock string
Contract string
CMP string
RecmndFromPrice string
RecmndToPrice string
RecmndDate string
TRGT1 string
TRGT2 string
SLTP string
BookPartProfitPrice string
BookPartProfitPercentstring
BookProfitPrice string
ExitPrice string
Remarks string
Potential string
TimeFrame string
BLK_FLG string
SETL_BEG_DT string
SETL_END_DT string
FUND_IN_DT string
FUND_OUT_DT string
PHY_IN_DT string
EX_BONUS_DT string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"28-May-2020 13:44:43", "JSONPostData":{"Idirect_Userid":"cash10","SessionToken":"607175"}, "Checksum":"89890BC33007F85609FD546DBE57E1C069D1A4FCC2B31B685F2714AE374F1940"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "CallType": "Currency Options", "Act": "B", "Stock": "OPT-USDINR-26-Jun-2020-77-CE", "Contract": null, "CMP": "0", "RecmndFromPrice": "0.4", "RecmndToPrice": "0.41", "RecmndDate": "28-May-2020 12:58", "TRGT1": "0.76", "TRGT2": "0.96", "SLTP": "0.31", "BookPartProfitPrice": "0", "BookPartProfitPercent": "0", "BookProfitPrice": "0", "ExitPrice": "0", "Remarks": "*", "Potential": "0", "TimeFrame": "", "BLK_FLG": "X", "SETL_BEG_DT": "*", "SETL_END_DT": "*", "FUND_IN_DT": "*", "FUND_OUT_DT": "*", "PHY_IN_DT": "*", "EX_BONUS_DT": "*" },{ "CallType": "Options", "Act": "B", "Stock": "OPT-NIFTY-28-Jul-2011-5500-CE", "Contract": null, "CMP": "0", "RecmndFromPrice": "50", "RecmndToPrice": "0", "RecmndDate": "31-May-2011 16:52", "TRGT1": "60", "TRGT2": "0", "SLTP": "50", "BookPartProfitPrice": "55", "BookPartProfitPercent": "50", "BookProfitPrice": "0", "ExitPrice": "0", "Remarks": "*", "Potential": "0", "TimeFrame": "*", "BLK_FLG": "D", "SETL_BEG_DT": "*", "SETL_END_DT": "*", "FUND_IN_DT": "*", "FUND_OUT_DT": "31-May-2011 16:53", "PHY_IN_DT": "*", "EX_BONUS_DT": "*" }, { "CallType": "Margin", "Act": "B", "Stock": "IDBI", "Contract": null, "CMP": "21.05", "RecmndFromPrice": "130", "RecmndToPrice": "0", "RecmndDate": "30-May-2011 12:38", "TRGT1": "132", "TRGT2": "0", "SLTP": "128", "BookPartProfitPrice": "0", "BookPartProfitPercent": "0", "BookProfitPrice": "131", "ExitPrice": "0", "Remarks": "*", "Potential": "0", "TimeFrame": "*", "BLK_FLG": "E", "SETL_BEG_DT": "*", "SETL_END_DT": "*", "FUND_IN_DT": "*", "FUND_OUT_DT": "*", "PHY_IN_DT": "30-May-2011 12:38", "EX_BONUS_DT": "*" }, { "CallType": "Future", "Act": "B", "Stock": "FUT-GAIL-30-Jun-2011", "Contract": null, "CMP": "0", "RecmndFromPrice": "430", "RecmndToPrice": "0", "RecmndDate": "30-May-2011 16:18", "TRGT1": "435", "TRGT2": "440", "SLTP": "426", "BookPartProfitPrice": "0", "BookPartProfitPercent": "0", "BookProfitPrice": "0", "ExitPrice": "428", "Remarks": "*", "Potential": "0", "TimeFrame": "*", "BLK_FLG": "F", "SETL_BEG_DT": "*", "SETL_END_DT": "*", "FUND_IN_DT": "*", "FUND_OUT_DT": "*", "PHY_IN_DT": "*", "EX_BONUS_DT": "30-May-2011 18:10" }, { "CallType": "Future", "Act": "P", "Stock": "", "Contract": null, "CMP": "0", "RecmndFromPrice": "430", "RecmndToPrice": "0", "RecmndDate": "30-May-2011 17:35", "TRGT1": "0", "TRGT2": "0", "SLTP": "0", "BookPartProfitPrice": "0", "BookPartProfitPercent": "0", "BookProfitPrice": "0", "ExitPrice": "0", "Remarks": "Book profit in MAX INDIA RECOMMEDNED PICK OF THE WEEK at 218 recommened at 01stMay2010", "Potential": "0", "TimeFrame": "*", "BLK_FLG": "X", "SETL_BEG_DT": "*", "SETL_END_DT": "*", "FUND_IN_DT": "*", "FUND_OUT_DT": "*", "PHY_IN_DT": "*", "EX_BONUS_DT": "*" }, { "CallType": "Margin", "Act": "B", "Stock": "VOLTAS", "Contract": null, "CMP": "490.8", "RecmndFromPrice": "158", "RecmndToPrice": "159", "RecmndDate": "29-Jun-2011 12:45", "TRGT1": "162", "TRGT2": "163.5", "SLTP": "156", "BookPartProfitPrice": "0", "BookPartProfitPercent": "0", "BookProfitPrice": "0", "ExitPrice": "0", "Remarks": "*", "Potential": "0", "TimeFrame": "*", "BLK_FLG": "C", "SETL_BEG_DT": "*", "SETL_END_DT": "*", "FUND_IN_DT": "29-Jun-2011 12:47", "FUND_OUT_DT": "*", "PHY_IN_DT": "*", "EX_BONUS_DT": "*" }, { "CallType": "Future", "Act": "S", "Stock": "FUT-VOLTAS-30-Jun-2011", "Contract": null, "CMP": "0", "RecmndFromPrice": "159", "RecmndToPrice": "160", "RecmndDate": "29-Jun-2011 12:46", "TRGT1": "157", "TRGT2": "156", "SLTP": "162", "BookPartProfitPrice": "0", "BookPartProfitPercent": "0", "BookProfitPrice": "156", "ExitPrice": "0", "Remarks": "*", "Potential": "0", "TimeFrame": "*", "BLK_FLG": "E", "SETL_BEG_DT": "*", "SETL_END_DT": "*", "FUND_IN_DT": "*", "FUND_OUT_DT": "*", "PHY_IN_DT": "29-Jun-2011 12:46", "EX_BONUS_DT": "*" },{ "CallType": "Margin", "Act": "B", "Stock": "ACC", "Contract": null, "CMP": "1138.25", "RecmndFromPrice": "1111", "RecmndToPrice": "0", "RecmndDate": "06-May-2011 15:46", "TRGT1": "1111", "TRGT2": "111", "SLTP": "1111", "BookPartProfitPrice": "0", "BookPartProfitPercent": "0", "BookProfitPrice": "0", "ExitPrice": "0", "Remarks": "t1", "Potential": "0", "TimeFrame": "*", "BLK_FLG": "A", "SETL_BEG_DT": "06-May-2011 15:50", "SETL_END_DT": "*", "FUND_IN_DT": "*", "FUND_OUT_DT": "*", "PHY_IN_DT": "*", "EX_BONUS_DT": "*" },{ "CallType": "Future", "Act": "B", "Stock": "FUT-RELIND-13-May-2011", "Contract": null, "CMP": "0", "RecmndFromPrice": "950", "RecmndToPrice": "0", "RecmndDate": "13-May-2011 13:06", "TRGT1": "955", "TRGT2": "960", "SLTP": "943", "BookPartProfitPrice": "0", "BookPartProfitPercent": "0", "BookProfitPrice": "0", "ExitPrice": "0", "Remarks": "Book full", "Potential": "0", "TimeFrame": "*", "BLK_FLG": "B", "SETL_BEG_DT": "13-May-2011 13:09", "SETL_END_DT": "13-May-2011 13:10", "FUND_IN_DT": "*", "FUND_OUT_DT": "*", "PHY_IN_DT": "*", "EX_BONUS_DT": "*" }, { "CallType": "", "Act": "B", "Stock": "ACC", "Contract": null, "CMP": "1138.25", "RecmndFromPrice": "111", "RecmndToPrice": "0", "RecmndDate": "06-May-2011 15:54", "TRGT1": "111", "TRGT2": "0", "SLTP": "111", "BookPartProfitPrice": "0", "BookPartProfitPercent": "0", "BookProfitPrice": "0", "ExitPrice": "0", "Remarks": "111", "Potential": "0", "TimeFrame": "D", "BLK_FLG": "X", "SETL_BEG_DT": "*", "SETL_END_DT": "*", "FUND_IN_DT": "*", "FUND_OUT_DT": "*", "PHY_IN_DT": "*", "EX_BONUS_DT": "*" }, { "CallType": "", "Act": "B", "Stock": "ACC", "Contract": null, "CMP": "1138.25", "RecmndFromPrice": "111", "RecmndToPrice": "0", "RecmndDate": "06-May-2011 15:47", "TRGT1": "111", "TRGT2": "0", "SLTP": "111", "BookPartProfitPrice": "0", "BookPartProfitPercent": "0", "BookProfitPrice": "0", "ExitPrice": "0", "Remarks": "1111", "Potential": "11", "TimeFrame": "D", "BLK_FLG": "X", "SETL_BEG_DT": "*", "SETL_END_DT": "*", "FUND_IN_DT": "*", "FUND_OUT_DT": "*", "PHY_IN_DT": "*", "EX_BONUS_DT": "*" }, { "CallType": "Future", "Act": "B", "Stock": "FUT-ACC-06-May-2011", "Contract": null, "CMP": "0", "RecmndFromPrice": "111", "RecmndToPrice": "0", "RecmndDate": "06-May-2011 15:46", "TRGT1": "111", "TRGT2": "111", "SLTP": "111", "BookPartProfitPrice": "0", "BookPartProfitPercent": "0", "BookProfitPrice": "0", "ExitPrice": "0", "Remarks": "1111", "Potential": "0", "TimeFrame": "*", "BLK_FLG": "X", "SETL_BEG_DT": "*", "SETL_END_DT": "*", "FUND_IN_DT": "*", "FUND_OUT_DT": "*", "PHY_IN_DT": "*", "EX_BONUS_DT": "*" }] }

Share as margin: Modify Securities Limit

API URL:https://api.icicidirect.com/equity/shareasmarginmodifyseclmt


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 ANSWR_FLAGStringN/AYesA-Add or D-Reduce
 BLK_AMTStringN/AYesBlocked Amount
 BLK_FLGStringN/AYesE-Equity or F- F & O
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
message string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"09-Jun-2020 18:29:51", "JSONPostData":{"ANSWR_FLAG":"A","BLK_AMT":"1","BLK_FLG":"F","Idirect_Userid":"cash10","SessionToken":"609831"}, "Checksum":"9F6FA9741FEB03B4ADD35FB9DCF7AE64282D302B164D301D3A5670F1DA5415C4"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "message": "You have successfully added the amount to your securities allocation." } }

Share as margin: Blocked Securities

API URL:https://api.icicidirect.com/equity/shareasmarginblksec


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
Scrip string
DPID string
SAMQuantityBlocked string
ValuationPrice string
Valueofsecurities string
Haircut string
Limitcreated string
Blockforsale string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"09-Jun-2020 18:29:51", "JSONPostData":{"Idirect_Userid":"cash10","SessionToken":"609831"}, "Checksum":"9F6FA9741FEB03B4ADD35FB9DCF7AE64282D302B164D301D3A5670F1DA5415C4"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "Scrip": "ICINIF", "DPID": "10802627", "SAMQuantityBlocked": "1", "ValuationPrice": "97.71", "Valueofsecurities": "586.26", "Haircut": "6", "Limitcreated": "551.0844", "Blockforsale": "5" }] }

Share as margin: Request Book

API URL:https://api.icicidirect.com/equity/shareasmarginreqbook


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey  StringN/AYes 
time_stamp  StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData     Data in JSONPostData has to be stringify 
 FrmDatestringN/AYesFormat :- DD-Mon-yyyy
 ToDatestringN/AYesFormat :- DD-Mon-yyyy
 StockCodestringN/AYesStock Code
 TYPEstringN/AYesOrder TYPE
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
Parameter Type
DateTime string
Scrip string
DPAccount string
Quantity string
Haircut string
Value string
Type string
Status string
Remarks string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"09-Jun-2020 18:59:17", "JSONPostData":{"FrmDate":"09-Jun-2019","ToDate":"09-Jun-2020", "Idirect_Userid":"cash10","SessionToken":"609831"}, "Checksum":"7E910E16FFE139E373AF127C311F6FB16A5AEAD32C54390FCD7220F77B896FBD"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "DateTime": "01-Jun-2020 08:30:47", "Scrip": "ICINIF", "DPAccount": "IN300183-10802627", "Quantity": "1", "Haircut": "6", "Value": "9185", "Type": "Block", "Status": "Completed", "Remarks": "User SAM Block" }, { "DateTime": "10-Jan-2020 12:03:55", "Scrip": "ICINIF", "DPAccount": "IN300183-10802627", "Quantity": "5", "Haircut": "15", "Value": "53359", "Type": "Block", "Status": "Completed", "Remarks": "User SAM Block" }] }

FNO Order Book

API URL:https://api.icicidirect.com/fno/fnoorderbook


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
 FromDTstringN/AYesFormat :- DD-Mon-yyyy
 ToDTstringN/AYesFormat :- DD-Mon-yyyy
 EXCHANGEstringYesYes"NFO"
 OPERATION_TYPstringN/AYes"F" when underlying is blank else "D" when underlying is given.
 PRDCT_TYPstringN/AYesFutures/Options
 UNDRLYNGstringN/AYesStock code (optional)
 ORDR_STTSstringYesYes"ALL"
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
order_exchcdstring"NFO"
order_stckcdstring 
order_ProductTypestringFutures/Options
order_OptionTypestringfor Options, Call and Put/for Futures, *
order_ExerciseTypestringEuropean,American
order_StrikePricestring 
order_ExpryDtstring 
order_OrderValidDatestring 
order_OrderFlowstringBuy/Sell
order_Limit_MarketFlagstring"Market"
order_OrderTypestringIOC,Day
order_LimitRatestring 
order_OrderStatusstring 
order_OrderReferencestringOrder Id
order_OrderQtystring 
order_ExecutedQtystring 
order_CanceledQtystring 
order_ExpiredQtystring 
order_StopLossTriggerstring 
order_SplFlgstring 
order_channelstring 
order_Modify_CancelFlagstring 
order_LstTradePricestring 
order_AcknowledgementNostring 
order_MarginAmtBlockedstring 
order_ExecutedRatestring 
order_TradeValuestring 
order_Brokeragestring 
order_ContractNostring 
order_TotalTradeValuestring 
order_FreshCoverFlagstring 
order_SquareOffatMarketFlagstring 
messageStringMessage returned from system.
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"01-07-2019 12:36:06", "JSONPostData":{"SessionToken":"1172955","Idirect_Userid":"pawan","FromDT":"01-May-2019", "ToDT":"01-Jul-2019","EXCHANGE":"NFO","OPERATION_TYP":"F","PRDCT_TYP":"Futures","UNDRLYNG":"", "ORDR_STTS":"ALL"}, "Checksum":"E9D18273894469BB0D2771D1B29570269AE7A110C4B6CB2E53A1396CEA401D03"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "order_exchcd": "NFO", "order_stckcd": "ITC", "order_ProductType": "Futures", "order_OptionType": "*", "order_ExerciseType": "European", "order_StrikePrice": 0, "order_ExpryDt": "29-Aug-2019", "order_OrderValidDate": "01-Jul-2019", "order_OrderFlow": "Sell", "order_Limit_MarketFlag": "Market", "order_OrderType": "Day", "order_LimitRate": "28200", "order_OrderStatus": "Executed", "order_OrderReference": "201907011300000015", "order_OrderQty": "7200", "order_ExecutedQty": "7200", "order_CanceledQty": "0", "order_ExpiredQty": "0", "order_StopLossTrigger": 0, "order_SplFlg": "N", "order_channel": "WEB", "order_Modify_CancelFlag": "N", "order_LstTradePrice": 28200, "order_AcknowledgementNo": "1100000000000731", "order_MarginAmtBlocked": 0, "order_ExecutedRate": 28200, "order_TradeValue": 203040000, "order_Brokerage": 0, "order_ContractNo": "*", "order_TotalTradeValue": "N", "order_FreshCoverFlag": "0", "order_SquareOffatMarketFlag": "N" }] }

Order Book Details

API URL:https://api.icicidirect.com/fno/fnoorderbookdtl


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
 ORDR_RFRNCStringN/ANo 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterTypeDescription/Remark
ModificationNumberstring 
ExchangeAcknowledgementDatestring 
Quantitystring 
Pricestring 
RequestTimestring 
Remarksstring 
SLTPPricestring 
ErrMsgStringMessage returned from system.
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW", "time_stamp":"26-06-2019 14:54:50","JSONPostData":{"SessionToken":"1172343", "Idirect_Userid":"test","ORDR_RFRNC":"201906241100002032"} ", "Checksum":"6500105CF4966C75F3FF26B7A28C7F0EDEA2E299EB114EEAEA09D14376AD464B"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "ModificationNumber": "1", "ExchangeAcknowledgementDate": "25-Jun-2019 10:17:15", "Quantity": "150", "Price": "1185000", "RequestTime": "25-Jun-2019 10:17:11", "Remarks": "*-*", "SLTPPrice": "0", "ErrMsg": null }] }

Modify Order

API URL:https://api.icicidirect.com/fno/fnomodifyorder


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
 order_referenceStringN/AYesorder refrence of order
 new_order_typeStringN/AYesLimit,Market,StopLoss
 new_order_validityStringN/AYesIOC,DAY
 new_order_quantitystringN/AYes 
 new_order_ratestringN/ANoIn case of Market orders this filed is not required
 new_order_stp_loss_pricestringN/ANoStop loss price in case of stoploss order.
 ORDR_FLWStringN/AYesbuy/sell
 XCHNG_CDStringN/AYes"NFO"
 new_order_disclosed_qtystringN/ANoDisclosed quantity in case of order
 ORD_VALID_DTstringN/ANo
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
messageStringMessage returned from system.
order_refrenceStringOrder Refrence
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"03-07-2019 11:37:24", "JSONPostData":{"SessionToken":"1173168","Idirect_Userid":"test","order_reference":"201907011300000066", "new_order_quantity":"400","new_order_rate":"160000","new_order_stp_loss_price":"0", "new_order_disclosed_qty":"0","new_order_type":"Limit","ORDR_FLW":"buy","XCHNG_CD":"NFO", "new_order_validity":"Day","ORD_VALID_DT":"01-Jul-2019"}, "Checksum":"79ABF525C30283BD1DBFDE4012BC892B099569DBDF844411FC21F740799CC898"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "order_reference": "201907011300000066", "message": "Your Order Modified Successfully" } }

Cancel Order

API URL:https://api.icicidirect.com/fno/fnocancelorder


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
 order_referenceStringN/AYes order refrence of order 
 XCHNG_CDStringN/AYes"NFO" 
 PRDCT_TYPStringN/AYes Futures/Options 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
messageStringMessage returned from system.
order_refrenceStringOrder Refrence
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"01-07-2019 15:31:13", "JSONPostData":{"SessionToken":"1173001","Idirect_Userid":"test", "ORDR_RFRNC":"201907011300000051","PRDCT_TYP":"Futures","EXCHANGE":"*", "OPERATION_TYP":"F","XCHNG_CD":"NFO"}, "Checksum":"BB1EE4DDD0F4CD483D13507CCD63D154BE98A1FE1BA8D8B9AEC833FD8FD1363B"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "order_reference": "201907011300000051", "message": "Your Order Canceled Successfully" } }

Placement

API URL:https://api.icicidirect.com/fno/fnoorderplacement


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
 order_stock_cdStringN/AYes 
 order_xchng_cdStringN/AYesExchange for placing order. NFO/BFO
 order_productStingN/AYesFutures,Options
 order_exp_dateStringN/AYesExpiry date format to be dd-Mon-yyyy
 order_exc_typeStringN/ANoEuropean,American.
 order_opt_typeStringN/ANoCall,Put
 order_strike_pricestringN/ANoprice in paise
 order_typeStringN/AYesLimit,Market
 order_validityStringN/AYesDAY
 order_quantitystringN/AYes 
 order_ratestringN/ANoIn case of Market orders this filed is not required
 order_flowStringN/AYesBuy/Sell
 order_stp_loss_pricestringN/ANoStop loss price in case of stoploss order.
 order_trade_dtStringN/AYesExchange trade date as retuned in client details
 order_disclosed_qtystringN/ANoDisclosed quantity in case of order
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
messageStringMessage returned from system.
order_referenceStringOrder Refrence
Request Example for Futures:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"05-Nov-2019 09:55:02", "JSONPostData":{"Idirect_Userid":"RAHUL123","SessionToken":"1192541","order_xchng_cd":"NFO", "order_product":"futures","order_stock_cd":"NIFTY","order_exp_date":"28-Nov-2019","order_exc_type":"European", "order_opt_type":"*","order_strike_price":"0","order_flow":"Buy","order_type":"Limit", "order_stp_loss_price":"0","order_quantity":"75","order_rate":"1100000","order_validity":"Day", "order_trade_dt":"04-Nov-2019","order_disclosed_qty":"0"}, "Checksum":"0CDCCFBCCA40BDE1E4A4F082495A435C7DBCFF22AE2ABB651C45A17D0053AFDB"}
Response Example for Futures:-

{ "Status": 200, "Error": null, "Success": { "order_reference": "201911041100000006", "message": "Successfully Placed the Order." } }
Request Example for Options:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"04-Nov-2019 16:00:22", "JSONPostData":{"Idirect_Userid":"RAHUL123\","SessionToken":"1192508\","order_xchng_cd":"NFO","order_product":"options", "order_stock_cd":"NIFTY\","order_exp_date":"28-Nov-2019","order_exc_type":"European","order_opt_type":"Call", "order_strike_price":"1250000","order_flow":"Buy","order_type":"Limit","order_stp_loss_price":"0", "order_quantity":"75","order_rate":"10","order_validity":"Day","order_trade_dt":"04-Nov-2019","order_disclosed_qty":"0"}, "Checksum":"745D718132622B486CD64272066BF42E483FE189AC4BE36DBEC2FEC7617609EF"}
Response Example for Options:-

{ "Status": 200, "Error": null, "Success": { "order_reference": "201911041100000001", "message": "Successfully Placed the Order." } }

Portfolio

API URL:https://api.icicidirect.com/fno/fnoportfolio


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData     Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 Portfolio_FROM_DTStringN/AYesDate in DD-Mon-yyyy format
 Portfolio_TO_DTStringN/AYesDate in DD-Mon-yyyy format
 Portfolio_XCHNG_CDStringN/AYes"NFO"
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
Portfolio_XCHNG_CDstring 
Portfolio_ProductstringFutures/Options
Portfolio_Underlyingstring 
Portfolio_ExpiryDatestringExpiry date format dd-Mon-yyyy
Portfolio_StrikePricestring 
Portfolio_OptionTypestringCall/Put
Portfolio_ExerciseTypestringEuropean,American
Portfolio_CategoryIndexPerStockstring 
Portfolio_TradeFlowstringBuy/Sell
Portfolio_OpenPositionQtystring 
Portfolio_RealizedProfitstring 
Portfolio_UnrealizedProfitstring 
Portfolio_CurrentMarketPricestring 
Portfolio_OpenPositionValuestring 
Portfolio_AveragePricestring 
Portfolio_Chargesstring 
messageStringMessage returned from system.
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"27-06-2019 11:33:12", "JSONPostData":{"SessionToken":"1172477","Idirect_Userid":"test","Portfolio_XCHNG_CD":"NFO" ,"Portfolio_FROM_DT":"01-Jun-2019","Portfolio_TO_DT":"31-Aug-2019"}, "Checksum":"46A85F34F8CF60A4DA4914B22EF203B9E5117DDBE966B6B567CBD4E82D8F4596"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "futures": [{ "Portfolio_XCHNG_CD": "NFO", "Portfolio_Product": "Futures", "Portfolio_Underlying": "ICIBAN", "Portfolio_ExpiryDate": "27-Jun-2019", "Portfolio_StrikePrice": "0", "Portfolio_OptionType": "*", "Portfolio_ExerciseType": "European", "Portfolio_CategoryIndexPerStock": "S", "Portfolio_TradeFlow": "Sell", "Portfolio_OpenPositionQty": "0", "Portfolio_RealizedProfit": "0", "Portfolio_UnrealizedProfit": "12375000", "Portfolio_CurrentMarketPrice": "33500", "Portfolio_OpenPositionValue": "0", "Portfolio_AveragePrice": "42500", "Portfolio_Charges": "0" }, { "Portfolio_XCHNG_CD": "NFO", "Portfolio_Product": "Futures", "Portfolio_Underlying": "NIFTY", "Portfolio_ExpiryDate": "25-Jul-2019", "Portfolio_StrikePrice": "0", "Portfolio_OptionType": "*", "Portfolio_ExerciseType": "European", "Portfolio_CategoryIndexPerStock": "I", "Portfolio_TradeFlow": "Buy", "Portfolio_OpenPositionQty": "0", "Portfolio_RealizedProfit": "0", "Portfolio_UnrealizedProfit": "-442500", "Portfolio_CurrentMarketPrice": "1180000", "Portfolio_OpenPositionValue": "0", "Portfolio_AveragePrice": "1185900", "Portfolio_Charges": "0" }, { "Portfolio_XCHNG_CD": "NFO", "Portfolio_Product": "Futures", "Portfolio_Underlying": "NIFTY", "Portfolio_ExpiryDate": "27-Jun-2019", "Portfolio_StrikePrice": "0", "Portfolio_OptionType": "*", "Portfolio_ExerciseType": "European", "Portfolio_CategoryIndexPerStock": "I", "Portfolio_TradeFlow": "Buy", "Portfolio_OpenPositionQty": "2700", "Portfolio_RealizedProfit": "21040500", "Portfolio_UnrealizedProfit": "-16564500", "Portfolio_CurrentMarketPrice": "1185000", "Portfolio_OpenPositionValue": "3196800000", "Portfolio_AveragePrice": "1191135", "Portfolio_Charges": "0" }, { "Portfolio_XCHNG_CD": "NFO", "Portfolio_Product": "Futures", "Portfolio_Underlying": "RAYMON", "Portfolio_ExpiryDate": "27-Jun-2019", "Portfolio_StrikePrice": "0", "Portfolio_OptionType": "*", "Portfolio_ExerciseType": "European", "Portfolio_CategoryIndexPerStock": "S", "Portfolio_TradeFlow": "Sell", "Portfolio_OpenPositionQty": "0", "Portfolio_RealizedProfit": "0", "Portfolio_UnrealizedProfit": "-23580000", "Portfolio_CurrentMarketPrice": "83000", "Portfolio_OpenPositionValue": "0", "Portfolio_AveragePrice": "69900", "Portfolio_Charges": "0" }, { "Portfolio_XCHNG_CD": "NFO", "Portfolio_Product": "Futures", "Portfolio_Underlying": "TCS", "Portfolio_ExpiryDate": "27-Jun-2019", "Portfolio_StrikePrice": "0", "Portfolio_OptionType": "*", "Portfolio_ExerciseType": "European", "Portfolio_CategoryIndexPerStock": "S", "Portfolio_TradeFlow": "Buy", "Portfolio_OpenPositionQty": "250", "Portfolio_RealizedProfit": "0", "Portfolio_UnrealizedProfit": "2500", "Portfolio_CurrentMarketPrice": "225810", "Portfolio_OpenPositionValue": "56450000", "Portfolio_AveragePrice": "225800", "Portfolio_Charges": "0" }], "option": [{ "Portfolio_XCHNG_CD": "NFO", "Portfolio_Product": "Options", "Portfolio_Underlying": "NIFTY", "Portfolio_ExpiryDate": "27-Jun-2019", "Portfolio_StrikePrice": "700000", "Portfolio_OptionType": "Call", "Portfolio_ExerciseType": "European", "Portfolio_CategoryIndexPerStock": "I", "Portfolio_TradeFlow": "Buy", "Portfolio_OpenPositionQty": "75", "Portfolio_RealizedProfit": "-35250000", "Portfolio_UnrealizedProfit": "36675000", "Portfolio_CurrentMarketPrice": "489000", "Portfolio_OpenPositionValue": "35250000", "Portfolio_AveragePrice": "470000", "Portfolio_Charges": "0" }, { "Portfolio_XCHNG_CD": "NFO", "Portfolio_Product": "Options", "Portfolio_Underlying": "NIFTY", "Portfolio_ExpiryDate": "27-Jun-2019", "Portfolio_StrikePrice": "1000000", "Portfolio_OptionType": "Call", "Portfolio_ExerciseType": "European", "Portfolio_CategoryIndexPerStock": "I", "Portfolio_TradeFlow": "Sell", "Portfolio_OpenPositionQty": "-150", "Portfolio_RealizedProfit": "27300000", "Portfolio_UnrealizedProfit": "-31430250", "Portfolio_CurrentMarketPrice": "209535", "Portfolio_OpenPositionValue": "-27300000", "Portfolio_AveragePrice": "182000", "Portfolio_Charges": "0" }] } }

Get Quote

API URL:https://api.icicidirect.com/fno/fnogetquote


Input Parameters:-
ParameterTypeDescription/RemarkRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData    Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 EXPRY_DTstringN/A Yes Date in DD-Mon-yyyy format 
 XCHNG_CDstringN/A Yes "NFO"
 PRDCT_TYPstringN/A Yes Futures,Options
 UNDRLYNGstringN/A Yes  
 EXER_TYPstringN/A Yes European,American 
 OPT_TYPstringN/A No  Call,Put 
 STRK_PRCstringN/A No  
 SessionTokenStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
security_Exchngecodestring 
security_ProductTypestring 
security_Underlyingstring 
security_expiryDatestring 
security_exercisetypestring 
security_Optiontypestring 
security_Strikepricestring 
security_LasttradedPricestring 
security_LastTradedtimestring 
security_bestbidpricestring 
security_bestbidquantitystring 
security_bestofferpricestring 
security_bestofferquantitystring 
security_OpenPrcstring 
security_highstring 
security_lowstring 
security_Previousclosestring 
security_Perchangestring 
security_highpricerangestring 
security_lowpricechangestring 
security_Totalquantitytradedstring 
security_Cashmarketquoteofunderlyingstring 
messageStringMessage returned from system.
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"26-06-2019 18:36:12", "JSONPostData":{"SessionToken":"1172392","Idirect_Userid":"pawan", "EXPRY_DT":"27-Jun-2019","XCHNG_CD":"NFO","PRDCT_TYP":"Futures", "UNDRLYNG":"NIFTY","EXER_TYP":"European","OPT_TYP":"*", "STRK_PRC":"0"}, "Checksum":"A055FDA1411FCB6B2ED821F0F884EFC899489B03428992E849EE3E13A7026A90"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "security_Exchngecode": "NFO", "security_ProductType": "Futures", "security_Underlying": "NIFTY", "security_expiryDate": "27-Jun-2019", "security_exercisetype": "European", "security_Optiontype": "*", "security_Strikeprice": "0", "security_LasttradedPrice": 1185000, "security_LastTradedtime": "14-Jun-2019 20:12:29", "security_bestbidprice": 1180100, "security_bestbidquantity": "150", "security_bestofferprice": 0, "security_bestofferquantity": "0", "security_OpenPrc": 1150000, "security_high": 1232500, "security_low": 1090000, "security_Previousclose": 1210445, "security_Perchange": -210, "security_highpricerange": 1312115, "security_lowpricechange": 1073550, "security_Totalquantitytraded": "432225", "security_Cashmarketquoteofunderlying": "11200" }] }

Limit

API URL:https://api.icicidirect.com/fno/fnolimit


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData    Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
 TRD_DTStringN/AYesFormat :- DD-Mon-yyyy 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
TradeDatestring 
ExchangeCodestring 
GroupIDstring 
PayinDatestring 
PayoutDatestring 
Amountstring 
messageStringMessage returned from system.
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"26-06-2019 15:45:55", "JSONPostData":{"SessionToken":"1172367","Idirect_Userid":"test", "TRD_DT":"26-Jun-2019"}, "Checksum":"0CCC19D9CD2531458739B489DA7F213054BB9F39D559F73818E9351F28F4C57F"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "objlmt": [{ "TradeDate": "19-Jun-2019", "ExchangeCode": "NFO", "GroupID": "1", "PayinDate": "19-Jun-2019", "PayoutDate": "-", "Amount": -348852081 }, { "TradeDate": "20-Jun-2019", "ExchangeCode": "NFO", "GroupID": "1", "PayinDate": "20-Jun-2019", "PayoutDate": "-", "Amount": -30721424 }, { "TradeDate": "21-Jun-2019", "ExchangeCode": "NFO", "GroupID": "1", "PayinDate": "21-Jun-2019", "PayoutDate": "-", "Amount": -42505296 }], "CurrentLimit": 804913240493, "BankAllocationAmount": 805151287271, "SecuritiesAllocationAmount": 0, "BlockforTradeAmount": 0, "ISECMargin": 349518229 } }

Open Position

API URL:https://api.icicidirect.com/fno/fnoopenposition

Span Open Position


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData    Data in JSONPostData has to be stringify 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYessession token
 PSTN_XCHNG_CDStringN/AYes"NFO"
 PSTN_UNDRLYNGStringN/AYes 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
Position_PRDCT_TYPStringProduct Type
Position_CTGRY_INDSTKStringCategory
PSTN_UNDRLYNGStringUnderlying
Position_EXPRY_DTStringExpiry Date
Position_EXER_TYPStringExercise Type
Position_C_OPNPSTN_FLWStringFlow
Position_C_OPNPSTN_QTYStringOpen Position Qty
Position_CVR_QTYStringCover Qty
Position_C_MTM_OPN_VALStringMTM open val
Position_LST_TRD_PRCStringLTP
Position_U_TRD_MRGNStringMargin On Position
Position_SPL_FLGStringRecord Type
Position_MIN_LOT_QTYStringLot Size
Position_UI_BUY_QTYStringBuy Order Qty
Position_UI_SELL_QTYStringSell Order Qty
Position_U_MM_TRD_MRGNStringMinimum Margin
Position_PRCNTG_CHNGStringMarket wide Open Position %
Position_SUB_BUF_CNTStringRecord Count
Position_ACTN_IDStringAction Id
Position_BASE_PRCStringBase Price
Position_OPT_TYPStringOption Type
Position_STRK_PRCStringStrike Price
PSTN_XCHNG_CDStringExchange Code
Position_AVM_PRCNTStringProfit and Loss
Position_BAL_AMTStringAvailable margin
Position_ERR_MSGStringError Message
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"04-10-2019 08:51:28", "JSONPostData":{"SessionToken":"1188788","Idirect_Userid":"anand", "PSTN_UNDRLYNG":""}, "Checksum":"D7E3323556D64047DE18EC31F0AB1214F4F40BDFA8DCBB7DE8353629FFC2FA1F"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "SPANOpenPosition": [{ "Position_PRDCT_TYP": "F", "Position_CTGRY_INDSTK": "S", "PSTN_UNDRLYNG": "TCS", "Position_EXPRY_DT": "31-Oct-2019", "Position_EXER_TYP": "E", "Position_C_OPNPSTN_FLW": "N", "Position_C_OPNPSTN_QTY": 0, "Position_CVR_QTY": 0, "Position_C_MTM_OPN_VAL": 0, "Position_LST_TRD_PRC": 206935, "Position_U_TRD_MRGN": 0, "Position_SPL_FLG": "A", "Position_MIN_LOT_QTY": 250, "Position_UI_BUY_QTY": 250, "Position_UI_SELL_QTY": 0, "Position_U_MM_TRD_MRGN": 0, "Position_PRCNTG_CHNG": 0, "Position_EBA_MTCH_ACT_NO": "8500012121", "Position_SUB_BUF_CNT": 0, "Position_ACTN_ID": 0, "Position_BASE_PRC": 0, "Position_OPT_TYP": "*", "Position_STRK_PRC": 0, "PSTN_XCHNG_CD": "NFO", "Position_AVM_PRCNT": 0, "Position_BAL_AMT": 0 }, { "Position_PRDCT_TYP": "N", "Position_CTGRY_INDSTK": "S", "PSTN_UNDRLYNG": "TCS", "Position_EXPRY_DT": "", "Position_EXER_TYP": "-", "Position_C_OPNPSTN_FLW": "N", "Position_C_OPNPSTN_QTY": 0, "Position_CVR_QTY": 0, "Position_C_MTM_OPN_VAL": 0, "Position_LST_TRD_PRC": 0, "Position_U_TRD_MRGN": 10254443, "Position_SPL_FLG": "C", "Position_MIN_LOT_QTY": 0, "Position_UI_BUY_QTY": 250, "Position_UI_SELL_QTY": 0, "Position_U_MM_TRD_MRGN": 0, "Position_PRCNTG_CHNG": 0, "Position_EBA_MTCH_ACT_NO": "8500012121", "Position_SUB_BUF_CNT": 1, "Position_ACTN_ID": 0, "Position_BASE_PRC": 0, "Position_OPT_TYP": "-", "Position_STRK_PRC": 0, "PSTN_XCHNG_CD": "NFO", "Position_AVM_PRCNT": 0, "Position_BAL_AMT": 0 }] } }

Futures Open Position


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData    Data in JSONPostData has to be stringify  
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYessession token
 PSTN_XCHNG_CDStringN/AYes"NFO" 
 FFO_PRDCT_TYPStringN/AYesFutures/Options 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )
Output Parameters:-
ParameterTypeDescription/Remark
PSTN_XCHNG_CDStringExchange Code
Position_SPL_FLGStringRecord Type
Position_PRDCT_TYPStringProduct Type
Position_CTGRY_INDSTKStringCategory
PSTN_UNDRLYNGStringUnderlying
Position_EXPRY_DTStringExpiry Date
Position_EXER_TYPStringExercise Type
Position_OPT_TYPStringOption Type
Position_STRK_PRCStringStrike Price
Position_CNTRCT_TAGStringContract Tag
Position_MIN_LOT_QTYStringLot Size
Position_C_OPNPSTN_FLWStringFlow
Position_C_OPNPSTN_QTYStringOpen Position Qty
Position_UI_BUY_QTYStringBuy Order Qty
Position_UI_SELL_QTYStringSell Order Qty
Position_CVR_QTYStringCover Qty
Position_U_IMTM_SPRD_PLStringBase Price
Position_LST_TRD_PRCStringLTP
Position_AMOUNTStringMargin On Position
Position_U_MM_TRD_MRGNStringMinimum Margin
Position_U_ORDR_MRGNStringMargin On Orders
Position_PRCNTG_CHNGStringMarket wide Open Position %
Position_ERR_MSGStringError Message
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"04-10-2019 10:23:21", "JSONPostData":{"SessionToken":"1188807","Idirect_Userid":"sachin","PSTN_UNDRLYNG":"","FFO_PRDCT_TYP":"F"}, "Checksum":"E7E1CDAC486BF05EB719EDB5D4DA507B2AB42870A8FFE89DD5709B20DB15E080"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "FUTOpenPosition": [{ "Position_PRDCT_TYP": "F", "Position_CTGRY_INDSTK": "I", "PSTN_UNDRLYNG": "NIFTY", "Position_EXPRY_DT": "31-Oct-2019", "Position_EXER_TYP": "E", "Position_C_OPNPSTN_FLW": "B", "Position_C_OPNPSTN_QTY": 75, "Position_CVR_QTY": 0, "Position_LST_TRD_PRC": 1192985, "Position_SPL_FLG": "A", "Position_MIN_LOT_QTY": 75, "Position_UI_BUY_QTY": 0, "Position_UI_SELL_QTY": 0, "Position_U_MM_TRD_MRGN": 0, "Position_PRCNTG_CHNG": 0, "Position_EBA_MTCH_ACT_NO": "8542333333", "Position_OPT_TYP": "*", "Position_STRK_PRC": 0, "PSTN_XCHNG_CD": "NFO", "Position_CNTRCT_TAG": "C", "Position_U_IMTM_SPRD_PL": 11929.85, "Position_AMOUNT": 0, "Position_U_ORDR_MRGN": 0 }, { "Position_PRDCT_TYP": "F", "Position_CTGRY_INDSTK": "I", "PSTN_UNDRLYNG": "NIFTY", "Position_EXPRY_DT": "-", "Position_EXER_TYP": "-", "Position_C_OPNPSTN_FLW": "B", "Position_C_OPNPSTN_QTY": 75, "Position_CVR_QTY": 0, "Position_LST_TRD_PRC": 0, "Position_SPL_FLG": "C", "Position_MIN_LOT_QTY": 0, "Position_UI_BUY_QTY": 0, "Position_UI_SELL_QTY": 0, "Position_U_MM_TRD_MRGN": 10280548.24, "Position_PRCNTG_CHNG": 0, "Position_EBA_MTCH_ACT_NO": "8542333333", "Position_OPT_TYP": "*", "Position_STRK_PRC": 0, "PSTN_XCHNG_CD": "NFO", "Position_CNTRCT_TAG": "C", "Position_U_IMTM_SPRD_PL": 0, "Position_AMOUNT": 11041076.18, "Position_U_ORDR_MRGN": 0 }, { "Position_PRDCT_TYP": "F", "Position_CTGRY_INDSTK": "S", "PSTN_UNDRLYNG": "TCS", "Position_EXPRY_DT": "31-Oct-2019", "Position_EXER_TYP": "E", "Position_C_OPNPSTN_FLW": "S", "Position_C_OPNPSTN_QTY": 250, "Position_CVR_QTY": 0, "Position_LST_TRD_PRC": 206935, "Position_SPL_FLG": "A", "Position_MIN_LOT_QTY": 250, "Position_UI_BUY_QTY": 0, "Position_UI_SELL_QTY": 0, "Position_U_MM_TRD_MRGN": 0, "Position_PRCNTG_CHNG": 0, "Position_EBA_MTCH_ACT_NO": "8542333333", "Position_OPT_TYP": "*", "Position_STRK_PRC": 0, "PSTN_XCHNG_CD": "NFO", "Position_CNTRCT_TAG": "C", "Position_U_IMTM_SPRD_PL": -2069.35, "Position_AMOUNT": 0, "Position_U_ORDR_MRGN": 0 }] } }

Options Open Position


Input Parameters:-
Parameter TypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
     Request will be honoured only if server time stamp and client timestamp is between 60 seconds
JSONPostData    Data in JSONPostData has to be stringify  
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYessession token
 PSTN_XCHNG_CDStringN/AYes"NFO" 
 FFO_PRDCT_TYPStringN/AYesFutures/Options 
Checksum StringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )
Output Parameters:-
ParameterTypeDescription/Remark
Position_EBA_MTCH_ACT_NOStringMatch Account
PSTN_XCHNG_CDStringExchange Code
Position_PRDCT_TYPStringProduct Type
Position_CTGRY_INDSTKStringCategory
PSTN_UNDRLYNGStringUnderlying
Position_EXPRY_DTStringExpiry Date
Position_EXER_TYPStringExercise Type
Position_OPT_TYPStringOption Type
Position_STRK_PRCStringStrike Price
Position_C_OPNPSTN_FLWStringFlow
Position_C_OPNPSTN_QTYStringOpen Position Qty
Position_CI_BUY_QTYStringBuy Order Qty
Position_CI_SELL_QTYStringSell Order Qty
Position_I_EXRC_QTYStringExercise Qty
Position_CVR_QTYStringCover Qty
Position_MTM_TRG_PRCStringTrigger Price
Position_LST_TRD_PRCStringLTP
Position_C_TRD_MRGNStringMargin On Position
Position_C_ORDR_MRGNStringMargin On Orders
Position_PRCNTG_CHNGStringMarket wide Open Position %
Position_MIN_LOT_QTYStringLot Size
Position_ERR_MSGStringError Message
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"04-10-2019 10:24:47", "JSONPostData":{"SessionToken":"1188807","Idirect_Userid":"sachin","PSTN_UNDRLYNG":"","FFO_PRDCT_TYP":"O"}, "Checksum":"2FC5ED2CB7FFC9F8DC5B8AF449BC070F8EE1DEC664CE8CD4F5A7E0F683928677"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "OPTOpenPosition": [{ "Position_PRDCT_TYP": "O", "Position_CTGRY_INDSTK": "I", "PSTN_UNDRLYNG": "NIFTY", "Position_EXPRY_DT": "31-Oct-2019", "Position_EXER_TYP": "E", "Position_C_OPNPSTN_FLW": "B", "Position_C_OPNPSTN_QTY": 75, "Position_CVR_QTY": 0, "Position_LST_TRD_PRC": 30100, "Position_SPL_FLG": "A", "Position_MIN_LOT_QTY": 75, "Position_PRCNTG_CHNG": 0, "Position_EBA_MTCH_ACT_NO": "8542333333", "Position_STRK_PRC": 1100000, "PSTN_XCHNG_CD": "NFO", "Position_CI_BUY_QTY": 0, "Position_CI_SELL_QTY": 0, "Position_I_EXRC_QTY": 0, "Position_MTM_TRG_PRC": 0, "Position_C_TRD_MRGN": 0, "Position_C_ORDR_MRGN": 0 }] } }

Margin Calculator

API URL:https://api.icicidirect.com/fno/fnomargincal


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData StringN/AYesRequest will be honoured only if server time stamp and client timestamp is between 60 seconds
 Margin_RQST_TYP StringN/AYes 
 Margin_XCHNG_CD StringN/AYes 
 Margin_PRDCT_TYPStringN/AYes 
 Margin_UNDRLYNG StringN/AYes 
 Margin_EXPRY_DT StringN/AYes 
 Margin_STRK_PRCStringN/AYes 
 Margin_OPT_TYP StringN/AYes 
 Margin_EXER_TYP StringN/AYes 
 Margin_CTGRY_INDSTK StringN/AYes 
 Margin_CI_BUY_QTY StringN/AYes 
 Margin_CI_BUY_ORD_VLStringN/AYes 
 Margin_CI_SELL_QTY StringN/AYes 
 Margin_CI_SELL_ORD_VL StringN/AYes 
 Margin_C_OPNPSTN_FLW StringN/AYes 
 Margin_C_OPNPSTN_QTY StringN/AYes 
 Margin_C_ORG_OPN_VAL StringN/AYes 
 Margin_CBUY_EXCTD_QTY StringN/AYes 
 Margin_CSELL_EXCTD_QTYStringN/AYes 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum  String N/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterType
Margin_C_ORDR_MRGNstring
Margin_C_TRD_MRGN string
Margin_ERR_MSGstring
Request Example:-

{"AppKey":"22a88ZwF10664Gd902s+G8542g8Z9849","time_stamp":"11-Dec-2019 18:27:07", "JSONPostData":{"Margin_RQST_TYP":"W","Margin_XCHNG_CD":"NFO","Margin_PRDCT_TYP":"O", "Margin_UNDRLYNG":"NIFTY","Margin_EXPRY_DT":"28-Nov-2019","Margin_STRK_PRC":"1150000", "Margin_OPT_TYP":"Call","Margin_EXER_TYP":"E","Margin_CTGRY_INDSTK":"I", "Margin_RQST_TYP":"S","Margin_CI_BUY_QTY":"150","Margin_CI_BUY_ORD_VL":"180000000", "Margin_CI_SELL_QTY":"0","Margin_CI_SELL_ORD_VL":"0","Margin_C_OPNPSTN_FLW":"N", "Margin_C_OPNPSTN_QTY":"0","Margin_C_ORG_OPN_VAL":"0","Margin_ROUT_CRT":null, "Margin_CBUY_EXCTD_QTY":null,"Margin_CSELL_EXCTD_QTY":null,"Idirect_Userid":"mamu", "SessionToken":1198099"}, "Checksum":"B9A9B97FE28B418D11ED037460B9929BBFA6D0D6591A9758D159627EB88954E2"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "Margin_U_ORDR_MRGN":15000, "Margin_U_TRD_MRGN": 15000, "Margin_ORD_AMT_BLKD": 1000, "Margin_C_BLKD_TRD_MRGN": 1000, "Margin_ERR_MSG": "" } }

Isec Margin Details

API URL:https://api.icicidirect.com/fno/fnoisecmargindetails


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData StringN/AYesRequest will be honoured only if server time stamp and client timestamp is between 60 seconds
 TradeDate StringN/ANo 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum  String N/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterType
BAL_AMTstring
PLG_AMT string
ORD_AMT_BLKDstring
ADD_MRGN_AMTstring
U_TRD_MRGN string
STATUS_FLGstring
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"23-May-2020 15:14:44", "JSONPostData":{"TradeDate":"23-May-2020","Idirect_Userid":"hulk","SessionToken":"605720"}, "Checksum":"091E133A49F4530736BF2DB525DA93F7C8B33B0AB0ABC8D728CA59BD94237110"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "BAL_AMT": "846916863", "PLG_AMT": "0", "ORD_AMT_BLKD": "0", "ADD_MRGN_AMT": "152929737", "U_TRD_MRGN": "0", "STATUS_FLG": "N" } }

Isec Margin History

API URL:https://api.icicidirect.com/fno/fnoisecmarginhistory


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData StringN/AYesRequest will be honoured only if server time stamp and client timestamp is between 60 seconds
 ExchangeCode StringN/ANo 
 TradeDate StringN/ANo 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum  String N/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterType
TRD_DTstring
XCHNG_CD string
C_TRD_MRGNstring
ADD_MRGN_AMTstring
ORD_AMT_BLKD string
DR_CR_FLGstring
PSTN_FLG string
STATUS_FLGstring
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"23-May-2020 15:16:20", "JSONPostData":{"ExchangeCode":"NFO","TradeDate":"20-May-2019","Idirect_Userid":"hulk","SessionToken":"605720"}, "Checksum":"8C3D0D5ECA026719333D1528BA9C2CA4B6951822D8224959CCB4874706398122"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "TRD_DT": "19-May-2020", "XCHNG_CD": "NSE", "C_TRD_MRGN": "152929737", "ADD_MRGN_AMT": "0", "ORD_AMT_BLKD": "152929737", "DR_CR_FLG": "D", "PSTN_FLG": "Y", "STATUS_FLG": "B" }, { "TRD_DT": "04-Feb-2020", "XCHNG_CD": "NSE", "C_TRD_MRGN": "0", "ADD_MRGN_AMT": "130111905", "ORD_AMT_BLKD": "130111905", "DR_CR_FLG": "C", "PSTN_FLG": "Y", "STATUS_FLG": "B" },{ "TRD_DT": "24-Jun-2019", "XCHNG_CD": "NSE", "C_TRD_MRGN": "585744993", "ADD_MRGN_AMT": "0", "ORD_AMT_BLKD": "585744993", "DR_CR_FLG": "D", "PSTN_FLG": "Y", "STATUS_FLG": "B" }] }

Cash Projection

API URL:https://api.icicidirect.com/fno/fnocashprj


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData StringN/AYesRequest will be honoured only if server time stamp and client timestamp is between 60 seconds
 TradeDate StringN/AYes 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum  String N/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterType
MOD_TRD_DTstring
PAYIN_DT string
XCHNG_CDstring
AMOUNTstring
GID string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"23-May-2020 15:16:20", "JSONPostData":{"TradeDate":"20-May-2019","Idirect_Userid":"hulk","SessionToken":"605720"}, "Checksum":"8C3D0D5ECA026719333D1528BA9C2CA4B6951822D8224959CCB4874706398122"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "MOD_TRD_DT": "12-May-2020", "PAYIN_DT": "13-May-2020", "XCHNG_CD": "NFO", "AMOUNT": "153400", "GID": "1" }, { "MOD_TRD_DT": "21-May-2020", "PAYIN_DT": "21-May-2020", "XCHNG_CD": "NFO", "AMOUNT": "-3000000", "GID": "1" }, { "MOD_TRD_DT": "22-Apr-2020", "PAYIN_DT": "23-Apr-2020", "XCHNG_CD": "NFO", "AMOUNT": "4641750", "GID": "1" }, { "MOD_TRD_DT": "27-Apr-2020", "PAYIN_DT": "28-Apr-2020", "XCHNG_CD": "NFO", "AMOUNT": "6477000", "GID": "1" }, { "MOD_TRD_DT": "28-Apr-2020", "PAYIN_DT": "28-Apr-2020", "XCHNG_CD": "NFO", "AMOUNT": "-15000000", "GID": "1" }, { "MOD_TRD_DT": "02-May-2020", "PAYIN_DT": "03-May-2020", "XCHNG_CD": "NFO", "AMOUNT": "3375000", "GID": "1" }, { "MOD_TRD_DT": "13-May-2020", "PAYIN_DT": "13-May-2020", "XCHNG_CD": "NFO", "AMOUNT": "-636000", "GID": "1" }] }

Stock List

API URL:https://api.icicidirect.com/fno/fnostocklist


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData StringN/AYesRequest will be honoured only if server time stamp and client timestamp is between 60 seconds
 ExchangeCode StringN/AYes 
 ProductType StringN/AYes 
 StockCode StringN/ANo 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum  String N/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterType
DLVRY_ALLWDstring
UNDRLYNG string
STCK_CDstring
BOARD_LOT_QTYstring
INIT_MRGN_PRCNT string
SOMC_PRCNTstring
MIN_MRGN_PRCNT string
SPREAD_MRGNstring
MIN_SPREAD_MRGNstring
HAIRCUT string
MIN_LOT_QTYstring
PLG_QTY string
PRC_INDCTRstring
INTERVALstring
NET_TRD_VAL string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"22-May-2020 12:57:49", "JSONPostData":{"ExchangeCode":"NFO","ProductType":"X","StockCode":"","Idirect_Userid":"hulk","SessionToken":"605371"}, "Checksum":"DD590874BDF2F35B7016DC2BC1CE22028F7FCC5E215C845998C88F798F46B7C0"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "DLVRY_ALLWD": "", "UNDRLYNG": "ACC", "STCK_CD": "ACC LIMITED", "BOARD_LOT_QTY": "400", "INIT_MRGN_PRCNT": "5", "SOMC_PRCNT": "0", "MIN_MRGN_PRCNT": "5", "SPREAD_MRGN": "6", "MIN_SPREAD_MRGN": "0", "HAIRCUT": "0", "MIN_LOT_QTY": "0", "PLG_QTY": "0", "PRC_INDCTR": "Y", "INTERVAL": "5", "NET_TRD_VAL": "0" }, { "DLVRY_ALLWD": "", "UNDRLYNG": "ADAPOR", "STCK_CD": "ADANI PORT AND SPECIAL ECONO", "BOARD_LOT_QTY": "2500", "INIT_MRGN_PRCNT": "1", "SOMC_PRCNT": "0", "MIN_MRGN_PRCNT": "2.5", "SPREAD_MRGN": "6.5", "MIN_SPREAD_MRGN": "0", "HAIRCUT": "0", "MIN_LOT_QTY": "0", "PLG_QTY": "0", "PRC_INDCTR": "Y", "INTERVAL": "5", "NET_TRD_VAL": "0" }, { "DLVRY_ALLWD": "", "UNDRLYNG": "ADAPOW", "STCK_CD": "ADANI POWER LIMITED", "BOARD_LOT_QTY": "10000", "INIT_MRGN_PRCNT": "1", "SOMC_PRCNT": "0", "MIN_MRGN_PRCNT": "20", "SPREAD_MRGN": "25", "MIN_SPREAD_MRGN": "0", "HAIRCUT": "0", "MIN_LOT_QTY": "0", "PLG_QTY": "0", "PRC_INDCTR": "Y", "INTERVAL": "5", "NET_TRD_VAL": "0" }, { "DLVRY_ALLWD": "", "UNDRLYNG": "TORPOW", "STCK_CD": "TORRENT POWER LIMITED", "BOARD_LOT_QTY": "3000", "INIT_MRGN_PRCNT": "0", "SOMC_PRCNT": "0", "MIN_MRGN_PRCNT": "0", "SPREAD_MRGN": "0", "MIN_SPREAD_MRGN": "0", "HAIRCUT": "0", "MIN_LOT_QTY": "0", "PLG_QTY": "0", "PRC_INDCTR": "Y", "INTERVAL": "5", "NET_TRD_VAL": "0" }, { "DLVRY_ALLWD": "", "UNDRLYNG": "ULTCEM", "STCK_CD": "ULTRATECH CEMENT LIMITED", "BOARD_LOT_QTY": "200", "INIT_MRGN_PRCNT": "1", "SOMC_PRCNT": "0", "MIN_MRGN_PRCNT": "99", "SPREAD_MRGN": "110", "MIN_SPREAD_MRGN": "0", "HAIRCUT": "0", "MIN_LOT_QTY": "0", "PLG_QTY": "0", "PRC_INDCTR": "Y", "INTERVAL": "5", "NET_TRD_VAL": "0" }, { "DLVRY_ALLWD": "", "UNDRLYNG": "UNIBR", "STCK_CD": "UNITED BREWERIES LTD", "BOARD_LOT_QTY": "700", "INIT_MRGN_PRCNT": "1", "SOMC_PRCNT": "0", "MIN_MRGN_PRCNT": "4", "SPREAD_MRGN": "10", "MIN_SPREAD_MRGN": "0", "HAIRCUT": "0", "MIN_LOT_QTY": "0", "PLG_QTY": "0", "PRC_INDCTR": "Y", "INTERVAL": "5", "NET_TRD_VAL": "0" }, { "DLVRY_ALLWD": "", "UNDRLYNG": "UNIP", "STCK_CD": "UPL LIMITED", "BOARD_LOT_QTY": "900", "INIT_MRGN_PRCNT": "1", "SOMC_PRCNT": "0", "MIN_MRGN_PRCNT": "4", "SPREAD_MRGN": "10", "MIN_SPREAD_MRGN": "0", "HAIRCUT": "0", "MIN_LOT_QTY": "0", "PLG_QTY": "0", "PRC_INDCTR": "Y", "INTERVAL": "5", "NET_TRD_VAL": "0" }, { "DLVRY_ALLWD": "", "UNDRLYNG": "VOLTAS", "STCK_CD": "VOLTAS LTD", "BOARD_LOT_QTY": "1000", "INIT_MRGN_PRCNT": "1", "SOMC_PRCNT": "0", "MIN_MRGN_PRCNT": "4", "SPREAD_MRGN": "10", "MIN_SPREAD_MRGN": "0", "HAIRCUT": "0", "MIN_LOT_QTY": "0", "PLG_QTY": "0", "PRC_INDCTR": "Y", "INTERVAL": "5", "NET_TRD_VAL": "0" }, { "DLVRY_ALLWD": "", "UNDRLYNG": "WIPRO", "STCK_CD": "WIPRO LTD", "BOARD_LOT_QTY": "3200", "INIT_MRGN_PRCNT": "1", "SOMC_PRCNT": "0", "MIN_MRGN_PRCNT": "2.5", "SPREAD_MRGN": "6.5", "MIN_SPREAD_MRGN": "0", "HAIRCUT": "0", "MIN_LOT_QTY": "0", "PLG_QTY": "0", "PRC_INDCTR": "Y", "INTERVAL": "5", "NET_TRD_VAL": "0" }, { "DLVRY_ALLWD": "", "UNDRLYNG": "YESBAN", "STCK_CD": "YES BANK LIMITED", "BOARD_LOT_QTY": "8800", "INIT_MRGN_PRCNT": "1", "SOMC_PRCNT": "0", "MIN_MRGN_PRCNT": "1", "SPREAD_MRGN": "3.5", "MIN_SPREAD_MRGN": "0", "HAIRCUT": "0", "MIN_LOT_QTY": "0", "PLG_QTY": "0", "PRC_INDCTR": "Y", "INTERVAL": "5", "NET_TRD_VAL": "0" }] }

Favourite List

API URL:https://api.icicidirect.com/fno/fnofavlist


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData StringN/AYesRequest will be honoured only if server time stamp and client timestamp is between 60 seconds
 ExchangeCode StringN/AYes 
 RequestType StringN/AYes 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum  String N/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterType
PRDCT_TYPstring
UNDRLYNG string
EXER_TYPstring
EXPRY_DTstring
STRK_PRC string
OPT_TYPstring
CTGRY_INDSTK string
XCHNG_CDstring
MIN_LOT_QTYstring
TCK_SZ string
LST_TRD_PRCstring
Request Example:-

{"AppKey":"B2125UR07222384n04_92*161s0+4b77","time_stamp":"22-May-2020 17:55:45", "JSONPostData":{"ExchangeCode":"NFO","RequestType":"F","Idirect_Userid":"hulk","SessionToken":"605562"}, "Checksum":"BF2B6A3D1CB7A12A1F11AE867CDCDE513FB7CA996DEA024DA3056E5B4D785611"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "PRDCT_TYP": "F", "UNDRLYNG": "ACC", "EXER_TYP": "E", "EXPRY_DT": "28-May-2020", "STRK_PRC": "0", "OPT_TYP": "*", "CTGRY_INDSTK": "S", "XCHNG_CD": "NFO", "MIN_LOT_QTY": "400", "TCK_SZ": "0", "LST_TRD_PRC": "116250" }, { "PRDCT_TYP": "F", "UNDRLYNG": "ACC", "EXER_TYP": "E", "EXPRY_DT": "25-Jun-2020", "STRK_PRC": "0", "OPT_TYP": "*", "CTGRY_INDSTK": "S", "XCHNG_CD": "NFO", "MIN_LOT_QTY": "400", "TCK_SZ": "0", "LST_TRD_PRC": "117000" }, { "PRDCT_TYP": "F", "UNDRLYNG": "NIFTY", "EXER_TYP": "E", "EXPRY_DT": "28-May-2020", "STRK_PRC": "0", "OPT_TYP": "*", "CTGRY_INDSTK": "I", "XCHNG_CD": "NFO", "MIN_LOT_QTY": "75", "TCK_SZ": "0", "LST_TRD_PRC": "900500" }] }

Converted To Future

API URL:https://api.icicidirect.com/fno/fnoviewconvertedtofut


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData StringN/AYesRequest will be honoured only if server time stamp and client timestamp is between 60 seconds
 ExchangeCode StringN/AYes 
 ProductType StringN/AYes 
 FromDate StringN/AYes 
 ToDate StringN/AYes 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum  String N/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterType
PRDCT_TYPstring
UNDRLYNG string
EXPRY_DTstring
STRK_PRC string
OPT_TYPstring
EXER_TYPstring
XCHNG_CDstring
ORDR_FLWstring
EXEC_QTY string
CLS_PRCstring
RQST_TMstring
CHANNELstring
Request Example:-

{"AppKey":"B2125UR07222384n04_92*161s0+4b77","time_stamp":"22-May-2020 18:03:36", "JSONPostData":{"ExchangeCode":"NFO","ProductType":"F","FromDate":"22-May-2018", "ToDate":"22-May-2020","Idirect_Userid":"hulk","SessionToken":"605562"}, "Checksum":"A061BAB73EEF63CCB536F0F29BF04D22155737EB3CB2E5C41A0ACFB67E54A692"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "PRDCT_TYP": "F", "UNDRLYNG": "RELIND", "EXPRY_DT": "26-Jul-2018", "STRK_PRC": "0", "OPT_TYP": "*", "EXER_TYP": "E", "XCHNG_CD": "NFO", "ORDR_FLW": "S", "EXEC_QTY": "1000", "CLS_PRC": "110000", "RQST_TM": "16-Jul-2018 11:58:33", "CHANNEL": "WEB" }, { "PRDCT_TYP": "F", "UNDRLYNG": "RELIND", "EXPRY_DT": "30-May-2019", "STRK_PRC": "0", "OPT_TYP": "*", "EXER_TYP": "E", "XCHNG_CD": "NFO", "ORDR_FLW": "B", "EXEC_QTY": "500", "CLS_PRC": "127700", "RQST_TM": "09-May-2019 17:25:06", "CHANNEL": "WEB" }, { "PRDCT_TYP": "F", "UNDRLYNG": "NIFTY", "EXPRY_DT": "26-Jul-2018", "STRK_PRC": "0", "OPT_TYP": "*", "EXER_TYP": "E", "XCHNG_CD": "NFO", "ORDR_FLW": "B", "EXEC_QTY": "225", "CLS_PRC": "1119333", "RQST_TM": "07-Jul-2018 12:06:48", "CHANNEL": "WEB" }] }

Market Message

API URL:https://api.icicidirect.com/fno/fnomarketmessage


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData StringN/AYesRequest will be honoured only if server time stamp and client timestamp is between 60 seconds
 ExchangeCode StringN/AYes 
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum  String N/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterType
TM_STMPstring
REMARKS string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"23-May-2020 15:08:09", "JSONPostData":{"ExchangeCode":"NFO","Idirect_Userid":"hulk","SessionToken":"605718"}, "Checksum":"8F7F37EF8F43D7D0CAC101758C24471A851A898B44CE7F2F0B2FAD68DA5F97C3"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "TM_STMP": "23-May-2020 13:03:25", "REMARKS": "The Normal market has closed for 04 JAN 2020." }, { "TM_STMP": "23-May-2020 13:03:25", "REMARKS": "The regular segment has closed for 04 JAN 2020." }, { "TM_STMP": "23-May-2020 13:03:25", "REMARKS": "The Normal market has reopened." }, { "TM_STMP": "23-May-2020 13:03:25", "REMARKS": "The PREOPEN period has ended." }, { "TM_STMP": "23-May-2020 13:03:25", "REMARKS": "The regular segment has reopened." }, { "TM_STMP": "23-May-2020 13:03:25", "REMARKS": "The Normal market has preopened again." }] }

Profit And Loss Statement

API URL:https://api.icicidirect.com/fno/fnoprofitandlossstatement


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKey StringN/AYes 
time_stamp StringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
JSONPostData StringN/AYesRequest will be honoured only if server time stamp and client timestamp is between 60 seconds
 fnoPnlFY StringN/ANoFinancial Year
 Idirect_UseridStringN/AYesidirect userid returned in client details api
 SessionTokenStringN/AYes 
Checksum  String N/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterType
MOD_TRD_DTstring
XCHNG_CD string
AMOUNTstring
GID string
Request Example:-

{"AppKey":"266HZ4!565`48*42c63U96XMF6965g09","time_stamp":"23-May-2020 15:52:07", "JSONPostData":{"fnoPnlFY":"2020-2021","Idirect_Userid":"hulk","SessionToken":"605730"}, "Checksum":"CEFE9BFF231BF6AA1075BA44AE6E5DB2D80F76752DC6C94683666454E21EE1E8"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "MOD_TRD_DT": "21-May-2020", "XCHNG_CD": "NFO", "AMOUNT": "-3000000", "GID": "1" }, { "MOD_TRD_DT": "13-May-2020", "XCHNG_CD": "NFO", "AMOUNT": "-636000", "GID": "1" }, { "MOD_TRD_DT": "02-May-2020", "XCHNG_CD": "NFO", "AMOUNT": "3375000", "GID": "1" }, { "MOD_TRD_DT": "28-Apr-2020", "XCHNG_CD": "NFO", "AMOUNT": "-15000000", "GID": "1" }, { "MOD_TRD_DT": "27-Apr-2020", "XCHNG_CD": "NFO", "AMOUNT": "6477000", "GID": "1" }, { "MOD_TRD_DT": "22-Apr-2020", "XCHNG_CD": "NFO", "AMOUNT": "4641750", "GID": "1" }] }

Order Placement

API URL:https://api.icicidirect.com/mf/mfOrderPlacement


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
SessionTokenStringN/AYes 
order_COMP_CDstringN/AYes 
order_VALID_FLAGstringN/AYes 
order_MF_SCH_CDstringN/AYes 
order_MF_TRANS_AMTstringN/AYesin case of redem this will contain amount or units.
order_MF_SCH_DESCstringN/AYes 
order_MF_TRANS_CDstringN/AYes 
order_MF_SCH_DIV_REINV_FLGstringN/AYes 
order_MF_ALL_FLGstringN/AYes 
order_DAYstringN/AYes 
order_MF_FRE_MNTHstringN/AYes 
order_MF_PRDstringN/AYes 
order_ORD_TYPstringN/AYes 
order_MF_NO_OF_UNITSstringN/AYes 
order_DPIDstringN/AYes 
order_CH_DPACCstringN/AYes 
order_PRDCT_TYPstringN/AYes 
ChecksumStringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
messageStringMessage returned from system.
order_transaction_idStringOrder Refrence
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"12-07-2019 15:00:39", "JSONPostData":{"SessionToken":"1174924","Idirect_Userid":"test","order_COMP_CD":"21", "order_VALID_FLAG":"M","order_MF_SCH_CD":"081G","order_MF_TRANS_AMT":"10000", "order_MF_SCH_DESC":"WEB","order_MF_TRANS_CD":"P","order_MF_SCH_DIV_REINV_FLG":"N", "order_MF_ALL_FLG":"N","order_DAY":"0","order_MF_FRE_MNTH":"0","ORDER_MF_PRD":"0", "ORDER_ORD_TYP":"A","order_MF_NO_OF_UNITS":"0","order_DPID":"IN303028", "order_CH_DPACC":"50025336","order_PRDCT_TYP":"N"}, "Checksum":"661D7EEC78A307FF75AF1D90578C23162C2A61CFBFA63D1E4B4F2455B3239F8D"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "message": "Order placed successfully", "order_transaction_id": "283962" } }

Order Details

API URL:https://api.icicidirect.com/mf/mforderbook


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
SessionTokenStringN/AYes 
order_from_dtStringT-7 days  
order_to_dtStringtoday  
ChecksumStringN/AYesCombination of (Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
messageStringMessage returned from system.
response_codeStringResponse code - 0 Success, else failure
order_schemeStringScheme name
order_transaction_idString 
order_transaction_typeString 
order_transaction_dateStringdd-Mon-yyyy hh24:mi:ss
order_last_navstringNAV
order_dateStringdd-Mon-yyyy
order_amountstringAmount in Rs.
order_unitsstring 
order_statusString 
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"12-07-2019 11:02:18", "JSONPostData":{"SessionToken":"1174783","Idirect_Userid":"test","order_from_dt":"06/07/2019", "order_to_dt":"12/07/2019","order_TRANS_STATUS_CD":"%"}, "Checksum":"F906AAE3986AC9A65BEB09361F8B51940EC88FB52308587526B898675547C378"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "order_scheme": "SBI EMERGING BUSINESS FUND - GROWTH", "order_transaction_id": "283950", "order_transaction_type": "P", "order_transaction_date": "11-07-2019 18:55:54", "order_last_nav": 0, "order_date": "12-Jul-2019", "order_amount": 10000, "order_units": 0, "order_status": 79, "message": null }, { "order_scheme": "SBI EMERGING BUSINESS FUND - GROWTH", "order_transaction_id": "283947", "order_transaction_type": "P", "order_transaction_date": "11-07-2019 14:42:44", "order_last_nav": 0, "order_date": "12-Jul-2019", "order_amount": 10000, "order_units": 0, "order_status": 79, "message": null }] }

SIP

API URL:https://api.icicidirect.com/mf/mfSIP


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
SessionTokenStringN/AYes 
order_foliostringNEWYes 
order_amountstringN/AYes 
order_company_codestringN/AYes 
order_scheme_codestringN/AYes 
order_frequencystringN/AYesMonthly,Quaterly
order_daystringN/AYes 
order_no_sipstringN/AYes 
order_SCH_DIV_REINV_FLGstringN/AYes 
order_ALL_FLGstringN/AYes 
order_PRDCT_TYPstringN/AYes 
order_FLGstringN/AYes 
ORDER_ORD_TYPstringN/AYes 
order_NO_OF_UNITSstringN/AYes 
order_SCH_DESCstringN/AYes 
order_TRANS_CDstringN/AYes 
order_FRE_DATEstringN/AYes 
ChecksumStringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
messageStringMessage returned from system.
order_transaction_idStringOrder Refrence
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"12-07-2019 17:45:21", "JSONPostData":{"SessionToken":"1174995","Idirect_Userid":"test","order_folio":"123/in", "order_amount":"1000","order_company_code":"10","order_scheme_code":"MCOG","order_frequency":"1", "order_day":"-1","order_no_sip":"-1","order_SCH_DIV_REINV_FLG":"N","order_ALL_FLG":"N", "order_PRDCT_TYP":"","ORDER_ORD_TYP":"A","order_NO_OF_UNITS":"0","order_SCH_DESC":"WEB", "order_TRANS_CD":"A","order_FRE_DATE":"15/07/2019"}, "Checksum":"455B612C41DD5AB632325274DAD17C55379292D1C705DC6B435642C00B0F3BD6"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "message": "SIP Order placed successfully", "order_transaction_id": "283970" } }

SIP Modify

API URL:https://api.icicidirect.com/mf/mfsipmodify


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
SessionTokenStringN/AYes 
order_trnasaction_idStringN/AYesTransaction id of SIP to be modified/cancelled/paused
order_modify_cancelStringN/AYesModify/Cancel/pause
order_amountstringN/ANoRequired in case of modification
order_company_codeStingN/ANoRequired in case of modification
order_scheme_codeStringN/ANoRequired in case of modification
order_frequencyStringN/ANoMonthly,Quaterly
order_dayStringN/ANoRequired in case of modification
order_REINV_FLGStringN/AYes 
order_SCH_DIV_REINV_FLGStringN/AYes 
order_ALL_FLGStringN/AYes 
order_ORD_TYPStringN/AYes 
order_SCH_DESCStringN/AYes 
order_FOLIOStringN/AYes 
order_FRE_DATEStringN/AYes 
ChecksumStringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
messageStringMessage returned from system.

SIP Book

API URL:https://api.icicidirect.com/mf/mfSIPBook


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
SessionTokenStringN/AYes 
order_sip_statusStringAYesA-Active,C-Cancelled,X-Expired.
ChecksumStringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key )

Output Parameters:-
ParameterTypeDescription/Remark
messageStringMessage returned from system.
response_codeStringResponse code - 0 Success, else failure
order_schemeStringScheme name
order_transaction_dateStringdd-Mon-yyyy hh24:mi:ss
order_amountstringAmount in Rs.
order_transaction_idString 
order_start_dateStringdd-Mon-yyyy
order_end_dateStringdd-Mon-yyyy
order_frequencyString 
order_periodString 
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"04-07-2019 15:52:59", "JSONPostData":"{\"SessionToken\":\"1173505\",\"Idirect_Userid\":\"test\",\"order_sip_status\":\"Y\"}", "Checksum":"286AC6D9CE7ADE460FED3FF3834674A5A9E954BC9C143A89CB83412828463E65"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "message": "N", "order_scheme": "FRANKLIN INDIA OPPORTUNITIES FUND - DIVIDEND - DIRECT", "order_transaction_date": "19-Jun-2019 02:54:35", "order_amount": "500", "order_transaction_id": "283891", "order_start_date": "20-Jun-2019", "order_end_date": "-", "order_frequency": "1 (Months)", "order_period": "-1" }, { "message": "Y", "order_scheme": "FRANKLIN INDIA OPPORTUNITIES FUND - DIVIDEND - DIRECT", "order_transaction_date": "22-May-2019 04:25:08", "order_amount": "500", "order_transaction_id": "283768", "order_start_date": "25-May-2019", "order_end_date": "-", "order_frequency": "1 (Months)", "order_period": "-1" }, { "message": "N", "order_scheme": "FRANKLIN INDIA OPPORTUNITIES FUND - DIVIDEND - DIRECT", "order_transaction_date": "16-May-2019 04:38:02", "order_amount": "1000", "order_transaction_id": "283762", "order_start_date": "20-May-2019", "order_end_date": "-", "order_frequency": "1 (Months)", "order_period": "-1" }, { "message": "N", "order_scheme": "FRANKLIN INDIA OPPORTUNITIES FUND - DIVIDEND - DIRECT", "order_transaction_date": "16-May-2019 03:58:17", "order_amount": "800", "order_transaction_id": "283760", "order_start_date": "20-May-2019", "order_end_date": "-", "order_frequency": "1 (Months)", "order_period": "-1" }, { "message": "N", "order_scheme": "FRANKLIN INDIA OPPORTUNITIES FUND - DIVIDEND - DIRECT", "order_transaction_date": "16-May-2019 03:34:17", "order_amount": "900", "order_transaction_id": "283759", "order_start_date": "20-May-2019", "order_end_date": "-", "order_frequency": "1 (Months)", "order_period": "-1" }] }

Folio

API URL:https://api.icicidirect.com/mf/mffolio


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
order_company_codeStingN/AYesorder_company_code
order_scheme_codeStringN/AYesorder_scheme_code
ChecksumStringN/AYesCombination of ( AppKey + Time Stamp + client_key )

Output Parameters:-
ParameterTypeDescription/Remark
order_folioString[]Folio for schem code and company code.
messageStringMessage returned from system.
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"15-07-2019 14:22:21", "JSONPostData":{"SessionToken":"1175101", "Idirect_Userid":"test","order_company_code":"1","order_scheme_code":"15"}, "Checksum":"28515D85B62D214A595B4DCD06FBDE102D05994306FDB369C2E50CAE4835D44A"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "Folio_No": "1555555/33" }, { "Folio_No": "44" }] }

Unit Holding

API URL:https://api.icicidirect.com/mf/mfUnitHolding


Input Parameters:-
ParameterTypeDeafultRequiredDescription/Remark
AppKeyStringN/AYes 
time_stampStringN/AYesFormat :- DD-Mon-yyyy hh24:mi:ss
    Request will be honoured only if server time stamp and client timestamp is between 60 seconds
Idirect_UseridStringN/AYesidirect userid returned in client details api
portfolio_typeStringAYesA - Holdings , Z - all holding.
SessionTokenStringN/AYes 
ChecksumStringN/AYesCombination of ( Time Stamp + JSONPostData + secret_key)

Output Parameters:-
ParameterTypeDescription/Remark
portfolio_schemeString 
portfolio_scheme_cdString 
portfolio_company_cdString 
portfolio_folioString 
portfolio_unitsstring 
portfolio_last_navstringNAV
portfolio_dateStringdd-Mon-yyyy
portfolio_val_at_coststring 
portfolio_val_at_navstring 
portfolio_val_at_coststring 
portfolio_val_at_mktstring 
portfolio_realised_pnlstring 
portfolio_unrealised_pnlstring 
messageStringMessage returned from system.
response_codeStringResponse code - 0 Success, else failure
Request Example:-

{"AppKey":"683r5*Zo380~ycp76869V0Cz\u002675fZ9EW","time_stamp":"12-07-2019 11:30:41", "JSONPostData":{"SessionToken":"1174800","Idirect_Userid":"test"}, "Checksum":"C1E60845023877D1286A867C95FEF6DE43260485EF590404C309548A53957FDA"}
Response Example:-

{ "Status": 200, "Error": null, "Success": [{ "portfolio_scheme": "FIDELITY EQUITY NON LIQUID FUND GROWTH -N", "portfolio_scheme_cd": "FEF-G", "portfolio_company_cd": "20", "portfolio_folio": "12345/3460", "portfolio_units": 3000, "portfolio_last_nav": 79.286, "portfolio_date": "10-May-2019", "portfolio_val_at_cost": 0, "portfolio_val_at_nav": 0, "portfolio_val_at_mkt": 237858, "portfolio_realised_pnl": 0, "portfolio_unrealised_pnl": 0, "message": null }, { "portfolio_scheme": "FIDELITY EQUITY NON LIQUID FUND GROWTH -N", "portfolio_scheme_cd": "FEF-G", "portfolio_company_cd": "20", "portfolio_folio": "12345/345", "portfolio_units": 8234.23, "portfolio_last_nav": 79.286, "portfolio_date": "10-May-2019", "portfolio_val_at_cost": 0, "portfolio_val_at_nav": 0, "portfolio_val_at_mkt": 652859.15978, "portfolio_realised_pnl": 0, "portfolio_unrealised_pnl": 0, "message": null }, { "portfolio_scheme": "HDFC MID CAP OPPORTUNITIES FUND - GROWTH", "portfolio_scheme_cd": "MCOG", "portfolio_company_cd": "10", "portfolio_folio": "111/234/56", "portfolio_units": 9990, "portfolio_last_nav": 52.959, "portfolio_date": "10-May-2019", "portfolio_val_at_cost": 0, "portfolio_val_at_nav": 0, "portfolio_val_at_mkt": 529060.41, "portfolio_realised_pnl": 0, "portfolio_unrealised_pnl": 0, "message": null }, { "portfolio_scheme": "HDFC MID CAP OPPORTUNITIES FUND - GROWTH", "portfolio_scheme_cd": "MCOG", "portfolio_company_cd": "10", "portfolio_folio": "123/in", "portfolio_units": 0, "portfolio_last_nav": 52.959, "portfolio_date": "10-May-2019", "portfolio_val_at_cost": 0, "portfolio_val_at_nav": 0, "portfolio_val_at_mkt": 0, "portfolio_realised_pnl": 0, "portfolio_unrealised_pnl": 0, "message": null }, { "portfolio_scheme": "HDFC TOP 200 FUND - GROWTH PLAN", "portfolio_scheme_cd": "44", "portfolio_company_cd": "10", "portfolio_folio": "1456/6789/2343", "portfolio_units": 500, "portfolio_last_nav": 482.966, "portfolio_date": "10-May-2019", "portfolio_val_at_cost": 0, "portfolio_val_at_nav": 0, "portfolio_val_at_mkt": 241483, "portfolio_realised_pnl": 0, "portfolio_unrealised_pnl": 22216.436, "message": null }, { "portfolio_scheme": "HDFC CASH MANAGEMENT FUND - INVESTMENT PLAN - DIVIDEND OPTION", "portfolio_scheme_cd": "52", "portfolio_company_cd": "2", "portfolio_folio": "123/in", "portfolio_units": 100, "portfolio_last_nav": 0, "portfolio_date": "28-Aug-2005", "portfolio_val_at_cost": 0, "portfolio_val_at_nav": 0, "portfolio_val_at_mkt": 0, "portfolio_realised_pnl": 0, "portfolio_unrealised_pnl": 0, "message": null }, { "portfolio_scheme": "HDFC CASH MANAGEMENT FUND - SAVINGS PLAN - WEEKLY DIVIDEND", "portfolio_scheme_cd": "51", "portfolio_company_cd": "2", "portfolio_folio": "99990", "portfolio_units": -89.78, "portfolio_last_nav": 1065.0433, "portfolio_date": "10-May-2019", "portfolio_val_at_cost": 0, "portfolio_val_at_nav": 0, "portfolio_val_at_mkt": -95619.587474, "portfolio_realised_pnl": 0, "portfolio_unrealised_pnl": 0, "message": null }] }

Generate OTP

API URL:https://api.icicidirect.com/content/genotp

Generate OTP


Input Parameters:-
Parameter TypeRequiredDescription/Remark
DeviceId StringYesDevice Id
MobileNumber StringYesMobile Number

Output Parameters:-
NOTE: OTP will be send on register Email Id
Parameter Type Description/Remark
ErrMsgstring Returns system Error
Request Example:-

{"DeviceId":"AAAABBBBCCCCDDD","MobileNumber":"9638527410"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "UserId": "" } }

Verify OTP


Input Parameters:-
Parameter TypeRequiredDescription/Remark
DeviceId StringYesDevice Id
MobileNumber StringYesMobile Number
OTPStringYesGenerated OTP

Output Parameters:-
Parameter Type Description/Remark
UserIdstring Returns User ID
ErrMsgstring Returns system Error
Request Example:-

{"DeviceId":"AAAABBBBCCCCDDD","MobileNumber":"9638527410","OTP":"908740"}
Response Example:-

{ "Status": 200, "Error": null, "Success": { "UserId": "test" } }
  1. 1Overview
  2. 1.1Registration Details
  3. 1.2Customer Login
  4. 1.3Customer Details
  5. 2Equity
    1. 2.1Order Book
    2. 2.2Order Book Details
    3. 2.3Modify Order
    4. 2.4Cancel Order
    5. 2.5Placement
    6. 2.6Portfolio
    7. 2.7Position
    8. 2.8Stock Search
    9. 2.9Demat Allocation
    10. 2.10Get Quote
    11. 2.11Limit
    12. 2.12Convert To Delivery
    13. 2.13Basket Order
    14. 2.14iClick-2-Invest
    15. 2.15Cash Projection
    16. 2.16Security Projection
    17. 2.17I-Sec Margin Details
    18. 2.18ETF List
    19. 2.19NCD List
    20. 2.20Stock List
    21. 2.21Prepaid Usage Summary
    22. 2.22My Messages
    23. 2.23Market Messages
    24. 2.24SEP Request Book
    25. 2.25Existing SEP
    26. 2.26SEP Stock List
    27. 2.27ETF SEP Stock List
    28. 2.28I-Sec Margin History
    29. 2.29SEP Place Order
    30. 2.30iClick-2-Gain
    31. 2.31Share as margin: Modify Securities Limit
    32. 2.32Share as margin: Blocked Securities
    33. 2.33Share as margin: Request Book
  6. 3F&O
    1. 3.1Order Book
    2. 3.2Order Book Details
    3. 3.3Modify Order
    4. 3.4Cancel Order
    5. 3.5Placement
    6. 3.6Portfolio
    7. 3.7Get Quote
    8. 3.8Limit
    9. 3.9Open Position
    10. 3.10Margin Calculator
    11. 3.11Isec Margin Details
    12. 3.12Isec Margin History
    13. 3.13Cash Projection
    14. 3.14Stock List
    15. 3.15Favourite List
    16. 3.16Converted To Future
    17. 3.17Market Message
    18. 3.18Profit And Loss Statement
  7. 4Mutual Fund
    1. 4.1Order Placement
    2. 4.2Order Details
    3. 4.3SIP
    4. 4.4SIP Modify
    5. 4.5SIP Book
    6. 4.6Folio
    7. 4.7Unit Holding