Noren MobileClient API v1.0.9.0

1
KAMBALA SOLUTIONS PVT LTD
2
TABLE OF CONTENTS
INTRODUCTION 6
Login and User Details 7

Login 7
Logout 8
Forgot Password 9
Change Password 10
Set Device Pin 11
Login with Device Pin 13
Get HS Token 14
Validate HS Token 15
User Details 15
Watch Lists 18
Get WatchList Names 18
Get WatchList 19
Search Scrips 21
Add Scrip to Watch List 24
Delete Scrip to Watch List 25
Get SecurityInfo 26
Order and Trades 29

Place Order 29
Modify Order 32
Cancel Order 34
Exit SNO Order 35
Order Margin 36
Order Book 37
Multi Leg Order Book 41
Single Order History 44
Trade Book 49
Exch Msg 53
Order Margin 54
Positions Book 56
3
Product Conversion 59
Holdings and Limits 61

Holdings 61
Limits 63
Market Info 70
Get Index List 70
Get Top List Names 72
Get Top List 74
Get Time Price Data (Chart data) 77
Get Option Chain 80
Span Calculator 81
Web Socket API 84

General Guidelines 84
Connect 84
Subscribe Touchline 85
Unsubscribe Touchline 86
Subscribe Depth 87
Unsubscribe Depth 92
Subscribe Order Update 94
Unsubscribe Order Update 95
4
Version History
Version Changes Details
1.6.0 Option Chain added Return 10 strikes above and below the given Price, to
load the option chain screen.
Span calculator Provides span and exposure value for given positions
added
1.7.0 Change password dmsg added in case of successful password change
Get and Validate HS Get HandShake Token

token And Validate HS token added.
Help direct login facility into third party sites
(BackOffice / DP etc)
1.8.0 Span Calculator

fields corrected
Exit order added.
1.9.0 Order margin API

added
/SingleOrdHist and
/GetIndexList added
Upper ckt limit and

lower ckt limit added
to security info api
52 week high / low

added to depth
5
INTRODUCTION
Kambala Solutions is a solution oriented firm indulged in serving financial
organizations with innovative products and services. We understand the new challenges
and obstacles which are continuously arising for businesses with rapid advances in
technology and environment, they could only be tackled with efficient and effective
approaches. We have expertise in building high throughput, low latency distributed
applications that can support a large concurrent user base.
Noren OMS solution is built keeping in mind the large and diverse Indian broking
industry. Few of the prominent coverages are Order Execution, Algo Trading, Exchange
connectivity and Risk Mitigation. The Noren OMS team strives to serve ever changing
requirements with agility and personal touch. Noren OMS is continuously being tested
for stability, high scalability and low latency in mind.
This document provides details of APIs to develop Web/Mobile applications for

Noren OMS.
6
Login and User Details
Login
Request to be POSTed to uri : /NorenWClient/QuickAuth
Request Details :
Parameter Possible value Description
Name
jData* Should send json object with fields in below list
Json Fields Possible value Description
apkversion* Application version.
uid* User Id of the login user
pwd* Sha256 of the user entered password.
factor2* DOB or PAN as entered by the user.
vc* Vendor code provided by noren team, along with

connection URLs
appkey* Sha256 of uid|vendor_key
imei* Send mac if users logs in for desktop, imei is from mobile
ip_address Optional field
source WEB / MOB
Example:
curl https://apitest.kambala.co.in/NorenWClient/QuickAuth \
-d "jData={ \"apkversion\": \"1.0.0\", \"uid\": \"VIDYA\", \"pwd\": \"s3cur3Id\", \"factor2\":
\"31-08-2017\", \"imei\": \"134243434\", \"source\": \"MOB\"}“
Response Details :
7
Response data will be in json format with below fields.
Json Fields Possible Description
value
stat Ok or Not_Ok Login Success Or failure status
susertoken It will be present only on login success. This data to be sent

in subsequent requests in jKey field and web socket
connection while connecting.
lastaccesstime It will be present only on login success.
spasswordreset Y If Y Mandatory password reset to be enforced. Otherwise

the field will be absent.
emsg This will be present only if Login fails.
Sample Success Response :

{
"request_time": "20:18:47 19-05-2020",
"stat": "Ok",
"susertoken": "3b97f4c67762259a9ded6dbd7bfafe2787e662b3870422ddd343a59895f423a0",
"lastaccesstime": "1589899727"
}
Sample Failure Response :

{
"request_time": "20:32:14 19-05-2020",
"stat": "Not_Ok",
"emsg": "Invalid Input : Wrong Password"
}
Logout
Request to be POSTed to uri : /NorenWClient/Logout
Request Details :
Name
8
jKey* Key Obtained on login success.
uid* User Id of the login user
Response Details :
value
stat Ok or Not_Ok Logout Success Or failure status
request_time It will be present only on successful logout.
emsg This will be present only if Logout fails.

{
"stat":"Ok",
"request_time":"10:43:41 28-05-2020"
}

{
"stat":"Not_Ok",
"emsg":"Server Timeout : "
}
Forgot Password
Request to be POSTed to uri : /NorenWClient/ForgotPassword
Request Details :
Name
9
uid* User Id
pan* Pan of the user
dob* Date of birth
Response Details :
value
stat Ok or Not_Ok Password reset is Success Or failure status
request_time Response received time.
emsg This will be present only if password reset fails. (“Invalid

User or User Details”)

{
"request_time":"10:52:56 28-05-2020",
"stat":"Ok"
}

{
"request_time":"17:42:13 26-05-2020",
"stat":"Not_Ok",
"emsg":"Error Occurred : Wrong user id or user details"
}
Change Password
Request to be POSTed to uri : /NorenWClient/Changepwd
Request Details :
Name
10
uid* User Id
oldpwd* Sha256 of old password
pwd* New password in plain text
Response Details :
value
stat Ok or Not_Ok Password reset is Success Or failure status
dmsg This will be present only in case of success. Number of

days to expiry will be present in same.
emsg This will be present only if password change fails

{
"request_time":"10:20:04 27-05-2020",
"stat":"Ok",
“dmag”:”Password Change Success. Your new password will expire in 15”
}

{
"request_time":"10:21:09 27-05-2020",
"stat":"Not_Ok",
"emsg":"Error Occurred : Password already used"
}
Set Device Pin

Request to be POSTed to uri : /NorenWClient/SetPin
Request Details :
11
Name
uid* User Id
imei* Imei or device unique fingerprint
source* Access type (MOB / WEB / API)
dpin* New pin in plain text
Response Details :
value
stat Ok or Not_Ok If Pin setting is Success Or failure status
request_time This will be present only if password change succeeds.

{
"request_time":"14:59:43 27-05-2020",
"stat":"Ok"
}

{
"stat":"Not_Ok",
"emsg":"Session Expired : Invalid Session Key"
}
12
Login with Device Pin
Request to be POSTed to uri : /NorenWClient/PinAuth
Request Details :
Name
uid* User Id
imei* Imei or device unique fingerprint
source* Access type (MOB / WEB / API)
dpin* sha256 of entered device pin
vc* Vendor code provided by noren team, along with

connection URLs
appkey* Sha256 of uid|vendor_key
apkversion* Application version number
ip_address global Ip of internet access
Response Details :

value
stat Ok or Not_Ok Login Success Or failure status
susertoken It will be present only on login success. This data to be sent

in subsequent requests in jKey field and web socket
connection while connecting.
13
lastaccesstime It will be present only on login success.
spasswordreset Y If Y Mandatory password reset to be enforced. Otherwise

the field will be absent.
emsg This will be present only if Login fails.

{
"request_time":"17:01:45 27-05-2020",
"stat":"Ok",
"susertoken":"b0856b3f6c4bac657417fc95de3e2060567b8bd80665e0a8ab82bbde5c434936",
"lastaccesstime":"1590579105"
}

{
"request_time":"11:19:56 28-05-2020",
"stat":"Not_Ok",
"emsg":"Invalid Input : Mpin Invalid"
}
Get HS Token
Request to be POSTed to uri : /NorenWClient/GetHsToken
Request Details :
Name
uid* User Id
Response Details :
14
value
stat Ok or Not_Ok If Pin setting is Success Or failure status
request_time This will be present only if password change succeeds.
hstk One time Token to be sent to BackOffice or third party link
Validate HS Token
Request to be POSTed to uri : /NorenWClient/ValidateHsToken
(To be used only from server, Call this url from Browser / Client Side APKs)
Request Details :
Name
LoginId* Send sLoginId received from Initiator site
token* Key Obtained on login success.
Response Details :
Response data will be in plain text format TRUE if Token is valid and FALSE for invalid User Id
or Token.
User Details
Request to be POSTed to uri : /NorenWClient/UserDetails
Request Details :
Name
15
uid* Logged in User Id
Response Details :

value
stat Ok or Not_Ok User details success or failure indication.
exarr Json array of strings with enabled exchange names
orarr Json array of strings with enabled price types for user
prarr Json array of Product Obj with enabled products, as

defined below.
brkname Broker id
brnchid Branch id
email
actid
uprev Always it will be an INVESTOR, other types of user not

allowed to login using this API.
request_time It will be present only in a successful response.
emsg This will be present only in case of errors.
Product Obj format

value
prd Product name
s_prdt_ali Product display name
16
exch Json array of strings with enabled, allowed exchange
names
Sample Success Response:

{
"request_time": "20:20:04 19-05-2020",
"prarr": [
{ “prd”:"C",
“s_prdt_ali” : “Delivery”,
“exch” : [“NSE”, “BSE”]
},
{ “prd”:"I",
“s_prdt_ali” : “Intraday”,
“exch” : [“NSE”, “BSE”, “NFO”]
},
, { “prd”:"H",
“s_prdt_ali” : “High Leverage”,
},
{ “prd”:"B",
“s_prdt_ali” : “Bracket Order”,
}
],
"exarr": [
"NSE",
"NFO"
],
"orarr": [
"MKT",
"LMT",
"SL-LMT",
"SL-MKT",
"DS",
"2L",
"3L",
"4L"
],
"brkname": "VIDYA",
"brnchid": "VIDDU",
"email": "[email protected]",
"actid": "GURURAJ",
17
"uprev": "INVESTOR",
"stat": "Ok"
}
Sample Failure Response:

{
"stat": "Not_Ok",
"emsg": "Session Expired : Invalid Session Key"
}
Watch Lists
Get WatchList Names
Request to be POSTed to uri : /NorenWClient/MWList
Request Details :
Name
Response Details :

value
stat Ok or Not_Ok MWList success or failure indication.
values Watch List names as a json array of strings.
18
emsg This will be present only in case of errors or No WatchLists

are set yet.

{
"request_time": "12:34:52 21-05-2020",
"values": [
"default",
"WL"
],
"stat": "Ok"
}
{
"stat": "Not_Ok",
"emsg": "Session Expired : Invalid Session Key"
}
Get WatchList
Request to be POSTed to uri : /NorenWClient/MarketWatch
Request Details :
Name
wlname* Name of the Watchlist, for which scrip list is required.
19
Response Details :

value
stat Ok or Not_Ok Market watch success or failure indication.
values Array of json objects. (object fields given in below table)

That is : 1) Invalid Input : Invalid WatchList Name
2) Session Expired
Json Fields of Possible Description

object in values value
Array
exch NSE, BSE, Exchange

NFO ...
tsym Trading symbol of the scrip (contract)
token Token of the scrip (contract)
pp Price precision
ti Tick size
ls Lot size

{
"request_time": "13:25:17 21-05-2020",
"values": [
{
"exch": "BSE",
"token": "972889",
"tsym": "915PTCIF27"
},
20
{
"exch": "NSE",
"token": "13",
"tsym": "ABB-EQ"
},
{
"exch": "NSE",
"token": "22",
"tsym": "ACC-EQ"
}
],
"stat": "Ok"
}
{
"stat":"Not_Ok",
"emsg":"Invalid Input : Missing uid or wlname."
}
Search Scrips
Request to be POSTed to uri : /NorenWClient/SearchScrip
Request Details :
Name
stext* Search Text
exch Exchange (Select from ‘exarr’ Array provided in User Details

response)
Response Details :
21
value

That is : 1) Invalid Input
2) Session Expired

Array

NFO ...
pp Price precision
ti Tick size
ls Lot size
{
"stat": "Ok",
"values": [
{
"exch": "NSE",
"token": "18069",
"tsym": "REL100NAV-EQ"
},
{
"exch": "NSE",
"token": "24225",
"tsym": "RELAXO-EQ"
22
},
{
"exch": "NSE",
"token": "4327",
"tsym": "RELAXOFOOT-EQ"
},
{
"exch": "NSE",
"token": "18068",
"tsym": "RELBANKNAV-EQ"
},
{
"exch": "NSE",
"token": "2882",
"tsym": "RELCAPITAL-EQ"
},
{
"exch": "NSE",
"token": "18070",
"tsym": "RELCONSNAV-EQ"
},
{
"exch": "NSE",
"token": "18071",
"tsym": "RELDIVNAV-EQ"
},
{
"exch": "NSE",
"token": "18072",
"tsym": "RELGOLDNAV-EQ"
},
{
"exch": "NSE",
"token": "2885",
"tsym": "RELIANCE-EQ"
},
{
"exch": "NSE",
"token": "15068",
"tsym": "RELIGARE-EQ"
},
{
"exch": "NSE",
23
"token": "553",
"tsym": "RELINFRA-EQ"
},
{
"exch": "NSE",
"token": "18074",
"tsym": "RELNV20NAV-EQ"
}
]
}

{
"stat":"Not_Ok",
"emsg":"No Data : "
}
Add Scrip to Watch List
Request to be POSTed to uri : /NorenWClient/AddMultiScripsToMW
Request Details :
Name
scrips* List of scrips, example format NSE|22#BSE|506734
Response Details :
24
value
stat Ok or Not_Ok Watch list update success or failure indication.

2) Session Expired

{
"request_time": "13:50:40 21-05-2020",
"stat": "Ok"
}
{
"stat":"Not_Ok",
}
Delete Scrip to Watch List
Request to be POSTed to uri : /NorenWClient/DeleteMultiMWScrips
Request Details :
Name
scrips* List of scrips, example format NSE|22#BSE|506734
25
Response Details :

value
stat Ok or Not_Ok Watch list update success or failure indication.

2) Session Expired

{
"request_time": "13:50:40 21-05-2020",
"stat": "Ok"
}
{
"stat":"Not_Ok",
"emsg":"Invalid Input : Missing uid or wlname or scrips."
}
Get SecurityInfo
Request to be POSTed to uri : /NorenWClient/GetSecurityInfo
Request Details :
Name
26
exch Exchange
token Contract Token
Example:
jData={"uid":"{{USER_ID}}", "exch":"NSE",
"token":"22"}&jKey=c180c60ec8f7870490ec27f4accdba179a149a5e5b1d503a0682d8b72acb24
b3
Response Details :
Response data will have below fields.

value

NFO ...
tsym Trading Symbol
cname Company Name
symnam Symbol Name
seg Segment
exd Expiry Date
instname Intrument Name
strprc Strike Price
optt Option Type
isin ISIN
ti Tick Size
27
ls Lot Size
pp Price precision
mult Multiplier
gp_nd gn/gd * pn/pd
prcunt Price Units
prcqqty Price Quote Qty
trdunt Trade Units
delunt Delivery Units
frzqty Freeze Qty
gsmind scripupdate Gsm Ind
elmbmrg Elm Buy Margin
elmsmrg Elm Sell Margin
addbmrg Additional Long Margin
addsmrg Additional Short Margin
splbmrg Special Long Margin
splsmrg Special Short Margin
delmrg Delivery Margin
tenmrg Tender Margin
tenstrd Tender Start Date
tenendd Tender End Eate
exestrd Exercise Start Date
exeendd Exercise End Date
elmmrg Elm Margin
varmrg Var Margin
expmrg Exposure Margin
28
prcftr_d ((GN / GD) * (PN/PD))

{
"request_time": "17:43:38 31-10-2020",
"stat": "Ok",
"exch": "NSE",
"tsym": "ACC-EQ",
"cname": "ACC LIMITED",
"symname": "ACC",
"seg": "EQT",
"instname": "EQ",
"isin": "INE012A01025",
"pp": "2",
"ls": "1",
"ti": "0.05",
"mult": "1",
"prcftr_d": "(1 / 1 ) * (1 / 1)",
"trdunt": "ACC.BO",
"delunt": "ACC",
"token": "22",
"varmrg": "40.00"
}

{
"stat":"Not_Ok",
"request_time":"10:50:54 10-12-2020",
"emsg":"Error Occurred : 5 \"no data\""
}
Order and Trades

Place Order
Request to be POSTed to uri : /NorenWClient/PlaceOrder
Request Details :
29
Name
actid* Login users account ID
exch* NSE / NFO / BSE Exchange (Select from ‘exarr’ Array provided in User Details
/ MCX response)
tsym* Unique id of contract on which order to be placed.
qty* Order Quantity
prc* Order Price
trgprc Only to be sent in case of SL / SL-M order.
dscqty Disclosed quantity (Max 10% for NSE, and 50% for MCX)
prd* C/M/H Product name (Select from ‘prarr’ Array provided in User
Details response, and if same is allowed for selected,
exchange. Show product display name, for user to select,
and send corresponding prd in API call)
trantype* B/S B -> BUY, S -> SELL
prctyp* LMT / MKT /

SL-LMT / S L-MKT
/ DS / 2L / 3L
ret* DAY / EOS / IOC Retention type (Show options as per allowed exchanges)
remarks Any tag by user to mark order.
ordersource MOB / WEB / TT Used to generate exchange info fields.
bpprc Book Profit Price applicable only if product is selected as B

(Bracket order )
blprc Book loss Price applicable only if product is selected as H
30
and B (High Leverage and Bracket order )
trailprc Trailing Price applicable only if product is selected as H and

B (High Leverage and Bracket order )
amo Yes , If not sent, of Not “Yes”, will be treated as Regular

order.
tsym2 Trading symbol of second leg, mandatory for price type 2L

and 3L
trantype2 Transaction type of second leg, mandatory for price type 2L

and 3L
qty2 Quantity for second leg, mandatory for price type 2L and 3L
prc2 Price for second leg, mandatory for price type 2L and 3L
tsym3 Trading symbol of third leg, mandatory for price type 3L
trantype3 Transaction type of third leg, mandatory for price type 3L
qty3 Quantity for third leg, mandatory for price type 3L
prc3 Price for third leg, mandatory for price type 3L
Example:
curl https://apitest.kambala.co.in/NorenWClient/PlaceOrder \
-d "jData={\"uid\":\"VIDYA\", \"actid\":\"CLIENT1\", \"exch\":\"NSE\", \"tsym\":\"ACC-EQ\",
\"qty\":\"50\", \"price\":\"1400\", \"prd\":\"H\", \"trantype\":\"B\", \"prctyp\":\"LMT\", \"ret\":\"DAY\"}“ \
-d “jKey=GHUDWU53H32MTHPA536Q32WR”
Response Details :

value
stat Ok or Not_Ok Place order success or failure indication.
31
norenordno It will be present only on successful Order placement to
OMS.
emsg This will be present only if Order placement fails
Sample Success Response:

{
"request_time": "10:48:03 20-05-2020",
"stat": "Ok",
"norenordno": "20052000000017"
}
Sample Error Response :

{
"stat": "Not_Ok",
"request_time": "20:40:01 19-05-2020",
"emsg": "Error Occurred : 2 \"invalid input\""
}
Modify Order
Request to be POSTed to uri : /NorenWClient/ModifyOrder
Request Details :
Name
exch* Exchange
norenordno* Noren order number, which needs to be modified
prctyp LMT / MKT / This can be modified.

SL-MKT /
SL-LMT
prc Modified / New price
32
qty Modified / New Quantity
tsym* Unque id of contract on which order was placed. Can’t be

modified, must be the same as that of original order.
ret DAY / IOC / EOS New Retention type of the order
trgprc New trigger price in case of SL-MKT or SL-LMT
uid* User id of the logged in user.

(Bracket order )


Response Details :

value
stat Ok or Not_Ok Modify order success or failure indication.
result Noren Order number of the order modified.
emsg This will be present only if Order modification fails

{
"request_time":"14:14:08 26-05-2020",
"stat":"Ok",
"result":"20052600000103"
}

{
"request_time":"16:03:29 28-05-2020",
33
"stat":"Not_Ok",
"emsg":"Rejected : ORA:Order not found"
}
Cancel Order
Request to be POSTed to uri : /NorenWClient/CancelOrder
Request Details :
Name
Response Details :

value
stat Ok or Not_Ok Cancel order success or failure indication.
result Noren Order number of the canceled order.
emsg This will be present only if Order cancelation fails

{
"request_time":"14:14:10 26-05-2020",
"stat":"Ok",
"result":"20052600000103"
}
34
{
"request_time":"16:01:48 28-05-2020",
"stat":"Not_Ok",
"emsg":"Rejected : ORA:Order not found to Cancel"
}
Exit SNO Order

Request to be POSTed to uri : /NorenWClient/ExitSNOOrder
Request Details :
Name
prd* H/B Allowed for only H and B products (Cover order and bracket
order)
Response Details :

value
stat Ok or Not_Ok Cancel order success or failure indication.
dmsg Display message, (will be present only in case of success).
emsg This will be present only if Order cancelation fails
35
Order Margin
Request to be POSTed to uri : /NorenWClient/GetOrderMargin
Request Details :
Name
/ MCX response)
tsym* Unique id of contract on which order to be placed.
qty* Order Quantity
prc* Order Price
prctyp* LMT / MKT /

L-MKT
SL-LMT / S

36
rorgqty Optional field. Application only for modify order, open order
quantity
fillshares Optional field. Application only for modify order, quantity

already filled.
rorgprc Optional field. Application only for modify order, open order
price
orgtrgprc Optional field. Application only for modify order, open order
trigger price
norenordno Optional field. Application only for H or B order modification
snonum Optional field. Application only for H or B order modification
Response Details :

value
remarks This field will be available only on success.
cash Total credits available for order
marginused Total margin used.
emsg This will be present only if Order placement fails
Order Book
Request to be POSTed to uri : /NorenWClient/OrderBook
Request Details :
Name
37
prd H / M / ... Product name
Example:
curl https://apitest.kambala.co.in/NorenWClient/OrderBook \
-d "jData={\"uid\":\"VIDYA\"}“ \
Response Details :
Response data will be in json Array of objects with below fields in case of success.

value
stat Ok or Not_Ok Order book success or failure indication.
exch Exchange Segment
tsym Trading symbol / contract on which order is placed.
norenordno Noren Order Number
prc Order Price
qty Order Quantity
prd Display product alias name, using prarr returned in user

details.
status Order status
trantype B/S Transaction type of the order
prctyp LMT / MKT Price type
fillshares Total Traded Quantity of this order
avgprc Average trade price of total traded quantity
38
rejreason If order is rejected, reason in text form
exchordid Exchange Order Number
cancelqty Canceled quantity for order which is in status cancelled.
remarks Any message Entered during order entry.
dscqty Order disclosed quantity.
trgprc Order trigger price
ret DAY / IOC / Order validity

EOS
uid
actid

(Bracket order )


amo Yes / No
pp Price precision
ti Tick size
ls Lot size
orddttm
ordenttm
extm
Response data will be in json format with below fields in case of failure:
39
value
stat Not_Ok Order book failure indication.
emsg Error message
Sample Success Output :

Success response :
[
{
“stat” : “Ok”,
“exch” : “NSE” ,
“tsym” : “ACC-EQ” ,
“norenordno” : “20062500000001223”,
“prc” : “127230”,
“qty” : “100”,
“prd” : “C”,
“status”: “Open”,
“trantype” : “B”,
“prctyp” : ”LMT”,
“fillshares” : “0”,
“avgprc” : “0”,
“exchordid” : “250620000000343421”,
“uid” : “VIDYA”,
“actid” : “CLIENT1”,
“ret” : “DAY”,
“amo” : “Yes”
},
{
“stat” : “Ok”,
“exch” : “NSE” ,
“tsym” : “ABB-EQ” ,
“norenordno” : “20062500000002543”,
“prc” : “127830”,
“qty” : “50”,
“prd” : “C”,
“status”: “REJECT”,
“trantype” : “B”,
“prctyp” : ”LMT”,
“fillshares” : “0”,
“avgprc” : “0”,
“rejreason” : “Insufficient funds”
“uid” : “VIDYA”,
“actid” : “CLIENT1”,
“ret” : “DAY”,
40
“amo” : “No”
}
]

{
"stat":"Not_Ok",
}
Multi Leg Order Book

Request to be POSTed to uri : /NorenWClient/MultiLegOrderBook
Request Details :
Name
prd H / M / ... Product name
Example:
curl https://apitest.kambala.co.in/NorenWClient/MultiLegOrderBook \
Response Details :

value
41
prc Order Price
qty Order Quantity

details.
status Order status

EOS
uid
actid

(Bracket order )


42
amo Yes / No
pp Price precision
ti Tick size
ls Lot size
tsym2 Trading symbol of second leg, mandatory for price type 2L

and 3L
trantype2 Transaction type of second leg, mandatory for price type 2L

and 3L
qty2 Quantity for second leg, mandatory for price type 2L and 3L
prc2 Price for second leg, mandatory for price type 2L and 3L
tsym3 Trading symbol of third leg, mandatory for price type 3L
trantype3 Transaction type of third leg, mandatory for price type 3L
qty3 Quantity for third leg, mandatory for price type 3L
prc3 Price for third leg, mandatory for price type 3L
fillshares2 Total Traded Quantity of 2nd Leg
avgprc2 Average trade price of total traded quantity for 2nd leg
fillshares3 Total Traded Quantity of 3rd Leg
avgprc3 Average trade price of total traded quantity for 3rd leg

value
emsg Error message
43
Single Order History
Request to be POSTed to uri : /NorenWClient/SingleOrdHist
Request Details :
Name
norenordno* Noren Order Number
Example:
curl https://apitest.kambala.co.in/NorenWClient/SingleOrdHist \
Response Details :

value
prc Order Price
qty Order Quantity
44
details.
status Order status
rpt Report Type (fill/complete etc)

EOS
uid
actid

(Bracket order )


amo Yes / No
pp Price precision
ti Tick size
45
ls Lot size
orddttm
ordenttm
extm

value
emsg Error message
[
{
"stat": "Ok",
"norenordno": "20121300065716",
"uid": "DEMO1",
"actid": "DEMO1",
"exch": "NSE",
"tsym": "ACCELYA-EQ",
"qty": "180",
"trantype": "B",
"prctyp": "LMT",
"ret": "DAY",
"token": "7053",
"pp": "2",
"ls": "1",
"ti": "0.05",
"prc": "800.00",
46
"avgprc": "800.00",
"discqty": "0",
"prd": "M",
"status": "COMPLETE",
"rpt": "Fill",
"fillshares": "180",
"norentm": "19:59:32 13-12-2020",
"exch_tm": "00:00:00 01-01-1980",
"remarks": "WC TEST Order",
"exchordid": "6858"
},
{
"stat": "Ok",
"norenordno": "20121300065716",
"uid": "DEMO1",
"actid": "DEMO1",
"exch": "NSE",
"qty": "180",
"trantype": "B",
"prctyp": "LMT",
"ret": "DAY",
"token": "7053",
"pp": "2",
"ls": "1",
"ti": "0.05",
"prc": "800.00",
"discqty": "0",
"prd": "M",
"status": "OPEN",
"rpt": "New",
"norentm": "19:59:32 13-12-2020",
"exch_tm": "00:00:00 01-01-1980",
"exchordid": "6858"
},
{
47
"stat": "Ok",
"norenordno": "20121300065716",
"uid": "DEMO1",
"actid": "DEMO1",
"exch": "NSE",
"qty": "180",
"trantype": "B",
"prctyp": "LMT",
"ret": "DAY",
"token": "7053",
"pp": "2",
"ls": "1",
"ti": "0.05",
"prc": "800.00",
"discqty": "0",
"prd": "M",
"status": "PENDING",
"rpt": "PendingNew",
"norentm": "19:59:32 13-12-2020",
"remarks": "WC TEST Order"
},
{
"stat": "Ok",
"norenordno": "20121300065716",
"uid": "DEMO1",
"actid": "DEMO1",
"exch": "NSE",
"qty": "180",
"trantype": "B",
"prctyp": "LMT",
"ret": "DAY",
"token": "7053",
"pp": "2",
"ls": "1",
"ti": "0.05",
48
"prc": "800.00",
"prd": "M",
"status": "PENDING",
"rpt": "NewAck",
"norentm": "19:59:32 13-12-2020",
"remarks": "WC TEST Order"
}
]
Trade Book
Request to be POSTed to uri : /NorenWClient/TradeBook
Request Details :
Name
actid* Account Id of logged in user
Example:
curl https://apitest.kambala.co.in/NorenWClient/TradeBook \
-d "jData={\"uid\":\"VIDYA\", \“actid\”:\”DEMO1\”}“ \
Response Details :

value
49
qty Order Quantity

details.

EOS
uid
actid
pp Price precision
ti Tick size
ls Lot size
cstFrm Custom Firm
fltm Fill Time
flid Fill ID
flqty Fill Qty
flprc Fill Price
ordersource Order Source
50
token Token

value
emsg Error message
[
{
"stat": "Ok",
"norenordno": "20121300065715",
"uid": "GURURAJ",
"actid": "GURURAJ",
"exch": "NSE",
"prctyp": "LMT",
"ret": "DAY",
"prd": "M",
"flid": "102",
"fltm": "01-01-1980 00:00:00",
"trantype": "S",
"qty": "180",
"token": "7053",
"flqty": "180",
"pp": "2",
"ls": "1",
"ti": "0.05",
"prc": "800.00",
"flprc": "800.00",
51
"norentm": "19:59:32 13-12-2020",
"exch_tm": "00:00:00 01-01-1980",
"exchordid": "6857"
},
{
"stat": "Ok",
"norenordno": "20121300065716",
"uid": "GURURAJ",
"actid": "GURURAJ",
"exch": "NSE",
"prctyp": "LMT",
"ret": "DAY",
"prd": "M",
"flid": "101",
"fltm": "01-01-1980 00:00:00",
"trantype": "B",
"qty": "180",
"token": "7053",
"flqty": "180",
"pp": "2",
"ls": "1",
"ti": "0.05",
"prc": "800.00",
"flprc": "800.00",
"norentm": "19:59:32 13-12-2020",
"exch_tm": "00:00:00 01-01-1980",
"exchordid": "6858"
}
]
52
Exch Msg
Request to be POSTed to uri : /NorenWClient/ExchMsg
Request Details :
Name
exch Exchange (Select from ‘exarr’ Array provided in User Details

response)
Example:
curl https://apitest.kambala.co.in/NorenWClient/ExchMsg \
-d “jKey=NSE”
Response Details :
Response data will be in json format with below fields in case of success.

value
stat Ok Whi Exch Msg success or failure indication.
exchmsg It will be present only in a successful response.
exchtm Exchange Time
53
value
emsg Error message
Order Margin
Request to be POSTed to uri : /NorenWClient/OrderMargin
Request Details :
Name
/ MCX response)
qty* Order Quantity
prc* Order Price
54
prctyp* LMT / MKT /
SL-LMT / S L-MKT
/ DS / 2L / 3L
orgqty Org Quantity
orgprc Org Price
token Unique id of contract on which order to be placed.
flqty Fill Quantity
srcuid Source User ID
srcbkrid Source Broker ID
Example:
curl https://apitest.kambala.co.in/NorenWClient/PlaceOrder \
-d "jData={ \"actid\":\"CLIENT1\", \"exch\":\"NSE\", \"qty\":\"50\", \"price\":\"1400\", \"prd\":\"H\",
\"trantype\":\"B\", \"prctyp\":\"LMT\", \"orgqty\":\"50\", \"orgprc\":\"50\",\"token\":\"50\"}“ \
Response Details :

value
remarks Insufficient Any message Entered during order entry.

Balance/
Order
Success/
Invalid scrip,
RED is under
Reconciliation/
Squareoff
Order
55
cash optional Total Cash
marginused optional Margin Used
Positions Book
Request to be POSTed to uri : /NorenWClient/PositionBook
Request Details :
Name
actid* Account id of the logged in user.
Example:
curl https://apitest.kambala.co.in/NorenWClient/PositionBook \
-d "jData={\"uid\":\"VIDYA\", \”actid\”:\”ACCT_1\”}“ \
Response Details :
Response data will be in json format with Array of Objects with below fields in case of success.

value
stat Ok or Not_Ok Position book success or failure indication.
exch Exchange segment
56
tsym Trading symbol / contract.
token Contract token
uid User Id
actid Account Id
prd Product name to be shown.
netqty Net Position quantity
netavgprc Net position average price
daybuyqty Day Buy Quantity
daysellqty Day Sell Quantity
daybuyavgprc Day Buy average price
daysellavgprc Day buy average price
daybuyamt Day Buy Amount
daysellamt Day Sell Amount
cfbuyqty Carry Forward Buy Quantity
cforgavgprc Original Avg Price
cfsellqty Carry Forward Sell Quantity
cfbuyavgprc Carry Forward Buy average price
cfsellavgprc Carry Forward Buy average price
cfbuyamt Carry Forward Buy Amount
cfsellamt Carry Forward Sell Amount
lp LTP
rpnl RealizedPNL
urmtom UnrealizedMTOM.
(Can be recalculated in LTP update :
= netqty * (lp from web socket - netavgprc) * prcftr
57
bep Break even price
openbuyqty
opensellqty
openbuyamt
opensellamt
openbuyavgprc
opensellavgprc
mult
pp
prcftr gn*pn/(gd*pd).
ti Tick size
ls Lot size
request_time This will be present only in a failure response.

value
stat Not_Ok Position book request failure indication.
emsg Error message

[
{
"stat":"Ok",
"uid":"POORNA",
"actid":"POORNA",
"exch":"NSE",
58
"tsym":"ACC-EQ",
"prarr":"C",
"pp":"2",
"ls":"1",
"ti":"5.00",
"mult":"1",
"prcftr":"1.000000",
"daybuyqty":"2",
"daysellqty":"2",
"daybuyamt":"2610.00",
"daybuyavgprc":"1305.00",
"daysellamt":"2610.00",
"daysellavgprc":"1305.00",
"cfbuyqty":"0",
"cfsellqty":"0",
"cfbuyamt":"0.00",
"cfbuyavgprc":"0.00",
"cfsellamt":"0.00",
"cfsellavgprc":"0.00",
"openbuyqty":"0",
"opensellqty":"23",
"openbuyamt":"0.00",
"openbuyavgprc":"0.00",
"opensellamt":"30015.00",
"opensellavgprc":"1305.00",
"netqty":"0",
"netavgprc":"0.00",
"lp":"0.00",
"urmtom":"0.00",
"rpnl":"0.00",
"cforgavgprc":"0.00"
}
]

{
"stat":"Not_Ok",
"request_time":"14:14:11 26-05-2020",
"emsg":"Error Occurred : 5 \"no data\""
}
Product Conversion
Request to be POSTed to uri : /NorenWClient/ProductConversion
Request Details :
59
Name
exch* Exchange
tsym* Unique id of contract on which order was placed. Can’t be

modified, must be the same as that of original order.
qty* Quantity to be converted.
actid* Account id
prd* Product to which the user wants to convert position.
prevprd* Original product of the position.
trantype* Transaction type
postype* Day / CF Converting Day or Carry forward position
ordersource MOB For Logging
Response Details :

value
stat Ok or Not_Ok Position conversion success or failure indication.
emsg This will be present only if Position conversion fails.

{
"request_time":"10:52:12 02-06-2020",
60
"stat":"Ok"
}

{
"stat":"Not_Ok",
"emsg":"Invalid Input : Invalid Position Type"
}
Holdings and Limits

Holdings
Request to be POSTed to uri : /NorenWClient/Holdings
Request Details :
Name
prd* Product name
Response Details :
Response data will be in json format with below fields in case of Success:

value
stat Ok or Not_Ok Holding request success or failure indication.
exch_tsym Array of objects exch_tsym objects as defined below.
holdqty Holding quantity
61
colqty Collateral quantity
btstqty BTST quantity
btstcolqty BTST Collateral quantity
usedqty Holding used today
upldprc Average price uploaded along with holdings
Exch_tsym object:
Array

NFO ...
pp Price precision
ti Tick size
ls Lot size

value
stat Not_Ok Position book request failure indication.
emsg Error message

[
{
"stat":"Ok",
"exch_tsym":[
62
{
"exch":"NSE",
"token":"13",
"tsym":"ABB-EQ"
}
],
"holdqty":"2000000",
"colqty":"200",
"btstqty":"0",
"btstcolqty":"0",
"usedqty":"0",
"upldprc" : "1800.00"
},
{
"stat":"Ok",
"exch_tsym":[
{
"exch":"NSE",
"token":"22",
"tsym":"ACC-EQ"
}
],
"holdqty":"2000000",
"colqty":"200",
"btstqty":"0",
"btstcolqty":"0",
"usedqty":"0",
"upldprc" : "1400.00"
}
]

{
"stat":"Not_Ok",
"emsg":"Invalid Input : Missing uid or actid or prd."
}
Limits
Request to be POSTed to uri : /NorenWClient/Limits
Request Details :
Name
63
prd Product name
seg CM / FO / FX Segment
exch Exchange
Response Details :

value
stat Ok or Not_Ok Limits request success or failure indication.
actid Account id
prd Product name
seg CM / FO / FX Segment
exch Exchange
-------------------------Cash Primary Fields-------------------------------
cash Cash Margin available
payin Total Amount transferred using Payins today
payout Total amount requested for withdrawal today
-------------------------Cash Additional Fields-------------------------------
brkcollamt Prevalued Collateral Amount
unclearedcash Uncleared Cash (Payin through cheques)
daycash Additional leverage amount / Amount added to handle
64
system errors - by broker.
-------------------------Margin Utilized----------------------------------
marginused Total margin / fund used today
mtomcurper Mtom current percentage
-------------------------Margin Used components---------------------
cbu CAC Buy used
csc CAC Sell Credits
rpnl Current realized PNL
unmtom Current unrealized mtom
marprt Covered Product margins
span Span used
expo Exposure margin
premium Premium used
varelm Var Elm Margin
grexpo Gross Exposure
greexpo_d Gross Exposure derivative
scripbskmar Scrip basket margin
addscripbskmrg Additional scrip basket margin
brokerage Brokerage amount
collateral Collateral calculated based on uploaded holdings
grcoll Valuation of uploaded holding pre haircut
-------------------------Additional Risk Limits---------------------------
turnoverlmt
pendordvallmt
-------------------------Additional Risk Indicators---------------------------
65
turnover Turnover
pendordval Pending Order value
-------------------------Margin used detailed breakup fields-------------------------
rzpnl_e_i Current realized PNL (Equity Intraday)
rzpnl_e_m Current realized PNL (Equity Margin)
rzpnl_e_c Current realized PNL (Equity Cash n Carry)
rzpnl_d_i Current realized PNL (Derivative Intraday)
rzpnl_d_m Current realized PNL (Derivative Margin)
rzpnl_f_i Current realized PNL (FX Intraday)
rzpnl_f_m Current realized PNL (FX Margin)
rzpnl_c_i Current realized PNL (Commodity Intraday)
rzpnl_c_m Current realized PNL (Commodity Margin)
uzpnl_e_i Current unrealized MTOM (Equity Intraday)
uzpnl_e_m Current unrealized MTOM (Equity Margin)
uzpnl_e_c Current unrealized MTOM (Equity Cash n Carry)
uzpnl_d_i Current unrealized MTOM (Derivative Intraday)
uzpnl_d_m Current unrealized MTOM (Derivative Margin)
uzpnl_f_i Current unrealized MTOM (FX Intraday)
uzpnl_f_m Current unrealized MTOM (FX Margin)
uzpnl_c_i Current unrealized MTOM (Commodity Intraday)
uzpnl_c_m Current unrealized MTOM (Commodity Margin)
span_d_i Span Margin (Derivative Intraday)
span_d_m Span Margin (Derivative Margin)
span_f_i Span Margin (FX Intraday)
span_f_m Span Margin (FX Margin)
66
span_c_i Span Margin (Commodity Intraday)
span_c_m Span Margin (Commodity Margin)
expo_d_i Exposure Margin (Derivative Intraday)
expo_d_m Exposure Margin (Derivative Margin)
expo_f_i Exposure Margin (FX Intraday)
expo_f_m Exposure Margin (FX Margin)
expo_c_i Exposure Margin (Commodity Intraday)
expo_c_m Exposure Margin (Commodity Margin)
premium_d_i Option premium (Derivative Intraday)
premium_d_m Option premium (Derivative Margin)
premium_f_i Option premium (FX Intraday)
premium_f_m Option premium (FX Margin)
premium_c_i Option premium (Commodity Intraday)
premium_c_m Option premium (Commodity Margin)
varelm_e_i Var Elm (Equity Intraday)
varelm_e_m Var Elm (Equity Margin)
varelm_e_c Var Elm (Equity Cash n Carry)
marprt_e_h Covered Product margins (Equity High leverage)
marprt_e_b Covered Product margins (Equity Bracket Order)
marprt_d_h Covered Product margins (Derivative High leverage)
marprt_d_b Covered Product margins (Derivative Bracket Order)
marprt_f_h Covered Product margins (FX High leverage)
marprt_f_b Covered Product margins (FX Bracket Order)
marprt_c_h Covered Product margins (Commodity High leverage)
marprt_c_b Covered Product margins (Commodity Bracket Order)
67
scripbskmar_e_i Scrip basket margin (Equity Intraday)
scripbskmar_e_m Scrip basket margin (Equity Margin)
scripbskmar_e_c Scrip basket margin (Equity Cash n Carry)
addscripbskmrg_ Additional scrip basket margin (Derivative Intraday)

d_i
addscripbskmrg_ Additional scrip basket margin (Derivative Margin)

d_m
addscripbskmrg_f Additional scrip basket margin (FX Intraday)

_i
addscripbskmrg_f Additional scrip basket margin (FX Margin)

_m
addscripbskmrg_ Additional scrip basket margin (Commodity Intraday)

c_i
addscripbskmrg_ Additional scrip basket margin (Commodity Margin)

c_m
brkage_e_i Brokerage (Equity Intraday)
brkage_e_m Brokerage (Equity Margin)
brkage_e_c Brokerage (Equity CAC)
brkage_e_h Brokerage (Equity High Leverage)
brkage_e_b Brokerage (Equity Bracket Order)
brkage_d_i Brokerage (Derivative Intraday)
brkage_d_m Brokerage (Derivative Margin)
brkage_d_h Brokerage (Derivative High Leverage)
brkage_d_b Brokerage (Derivative Bracket Order)
brkage_f_i Brokerage (FX Intraday)
brkage_f_m Brokerage (FX Margin)
brkage_f_h Brokerage (FX High Leverage)
68
brkage_f_b Brokerage (FX Bracket Order)
brkage_c_i Brokerage (Commodity Intraday)
brkage_c_m Brokerage (Commodity Margin)
brkage_c_h Brokerage (Commodity High Leverage)
brkage_c_b Brokerage (Commodity Bracket Order)
request_time This will be present only in a successful response.
emsg This will be present only in a failure response.

{
"request_time":"18:07:31 29-05-2020",
"stat":"Ok",
"cash":"1500000000000000.00",
"payin":"0.00",
"payout":"0.00",
"brkcollamt":"0.00",
"unclearedcash":"0.00",
"daycash":"0.00",
"turnoverlmt":"50000000000000.00",
"pendordvallmt":"2000000000000000.00",
"turnover":"3915000.00",
"pendordval":"2871000.00",
"marginused":"3945540.00",
"mtomcurper":"0.00",
"urmtom":"30540.00",
"grexpo":"3915000.00",
"uzpnl_e_i":"15270.00",
"uzpnl_e_m":"61080.00",
"uzpnl_e_c":"-45810.00"
}

{
"stat":"Not_Ok",
"emsg":"Server Timeout : "
}
69
Market Info
Get Index List
Request to be POSTed to uri : /NorenWClient/GetIndexList
Request Details :
Name
exch* Exchange
Response Details :

value
stat Ok or Not_Ok TopListNames success or failure indication.
values Array Of Basket, Criteria pair.
Basket, Criteria pair Object :
70
idxname Index Name
token Index token used to subscribe
Sample Output:
{
"request_time": "20:12:29 13-12-2020",
"values": [
{
"idxname": "HangSeng BeES-NAV",
"token": "26016"
},
{
"idxname": "India VIX",
"token": "26017"
},
{
"idxname": "Nifty 50",
"token": "26000"
},
{
"idxname": "Nifty IT",
"token": "26008"
},
{
"idxname": "Nifty Next 50",
"token": "26013"
},
{
"idxname": "Nifty Bank",
"token": "26009"
},
{
"token": "26004"
},
{
71
"token": "26012"
},
{
"idxname": "Nifty Midcap 50",
"token": "26014"
},
{
"idxname": "Nifty Realty",
"token": "26018"
},
]
}
Get Top List Names

Request to be POSTed to uri : /NorenWClient/TopListName
Request Details :
Name
exch* Exchange
Response Details :

value
72
stat Ok or Not_Ok TopListNames success or failure indication.
values Array Of Basket, Criteria pair.
Basket, Criteria pair Object :
bskt Basket name
crt criteria

{
"request_time":"13:08:22 03-06-2020",
"values":[
{
"bskt":"NSEBL",
"crt":"VOLUME"
},
{
"bskt":"NSEBL",
"crt":"LTP"
},
{
"bskt":"NSEBL",
"crt":"VALUE"
},
{
"bskt":"NSEEQ",
"crt":"VOLUME"
},
{
"bskt":"NSEEQ",
"crt":"LTP"
},
{
"bskt":"NSEEQ",
"crt":"VALUE”
},
{
"bskt":"NSEALL",
73
"crt":"VOLUME"
},
{
"bskt":"NSEALL",
"crt":"LTP"
},
{
"bskt":"NSEALL",
"crt":"VALUE"
}
]
}

{
"stat":"Not_Ok",
}
Get Top List

Request to be POSTed to uri : /NorenWClient/TopList
Request Details :
Name
exch* Exchange
tb* T or B Top or Bottom
bskt* Basket name
crt* criteria
Response Details :
74

value
stat Ok or Not_Ok TopList success or failure indication.
values Array of top / bottom contracts object
top / bottom contracts object :

tsym Trading symbol
lp LTP
c Previous Close price
v volume
value Total traded value
oi Open interest
pc LTP percentage change

[
{
"stat":"Ok",
"request_time":"15:44:45 03-06-2020",
"values":[
{
"tsym":"AIRAN-EQ",
"lp":"950.00",
"c":"915.00",
"v":"42705",
"value":"40185405.00",
"oi":"0",
"Pc":"3.83"
},
75
{
"tsym":"SHRENIK-EQ",
"lp":"1850.00",
"c":"1785.00",
"v":"206846",
"value":"368806418.00",
"oi":"0",
"Pc":"3.64”
},
{
"tsym":"REMSONSIND-EQ",
"lp":"6000.00",
"c":"5795.00",
"v":"3948",
"value":"22752324.00",
"Oi":"0",
"pc":"3.54"
},
{
"tsym":"AXISNIFTY-EQ",
"lp":"106700.00",
"c":"103301.00",
"v":"422",
"value":"43825544.00",
"oi":"0",
"Pc":"3.29"
}
]
}
]
{
"stat":"Not_Ok",
"emsg":"Invalid Input : Missing uid or exch or bskt or tb or crt"
}
Get Time Price Data (Chart data)

Request to be POSTed to uri : /NorenWClient/TPSeries
Request Details :
Name
76
exch* Exchange
token*
Response Details :
Response data will be in json format in case for failure.

value
stat Not_Ok TPData failure indication.
Response data will be in json format in case for success.
stat Ok TPData success indication.
time DD/MM/CCYY hh:mm:ss
into Interval open
inth Interval high
intl Interval low
intc Interval close
intvwap Interval vwap
intv Interval volume
v volume
77
intoi Interval io change
oi oi

[
{
"stat":"Ok",
"time":"02-06-2020 15:46:23",
"into":"0.00",
"inth":"0.00",
"intl":"0.00",
"intc":"0.00",
"intvwap":"0.00",
"intv":"0",
"intoi":"0",
"v":"980515",
"oi":"128702"
},
{
"stat":"Ok",
"time":"02-06-2020 15:45:23",
"into":"0.00",
"inth":"0.00",
"intl":"0.00",
"intc":"0.00",
"intvwap":"0.00",
"intv":"0",
"intoi":"0",
"v":"980515",
"oi":"128702"
},
{
"stat":"Ok",
"time":"02-06-2020 15:44:23",
"into":"0.00",
"inth":"0.00",
"intl":"0.00",
"intc":"0.00",
"intvwap":"0.00",
"intv":"0",
"intoi":"0",
"v":"980515",
"oi":"128702"
},
{
78
"stat":"Ok",
"time":"02-06-2020 15:43:23",
"into":"1287.00",
"inth":"1287.00",
"intl":"0.00",
"intc":"1287.00",
"intvwap":"128702.00",
"intv":"4",
"intoi":"128702",
"v":"980515",
"oi":"128702"
},
{
"stat":"Ok",
"time":"02-06-2020 15:42:23",
"into":"0.00",
"inth":"0.00",
"intl":"0.00",
"intc":"0.00",
"intvwap":"0.00",
"intv":"0",
"intoi":"0",
"v":"980511",
"oi":"128702"
}
]

{
"stat":"Not_Ok",
}
Get Option Chain

Request to be POSTed to uri : /NorenWClient/GetOptionChain
Request Details :
Name
79
tsym* Search Text
exch* Exchange (UI need to check if exchange in NFO / CDS /

MCX / or any other exchange which has options, if not don't
allow)
strprc* Mid price for option chain selection
cnt* Number of strike to return on one side of the mid price for
PUT and CALL. (example cnt is 4, total 16 contracts will be
returned, if cnt is is 5 total 20 contract will be returned)
Response Details :

value

2) Session Expired

Array

NFO ...
optt Option Type
80
strprc Strike price
pp Price precision
ti Tick size
ls Lot size
Span Calculator
Request to be POSTed to uri : /NorenWClient/SpanCalc
Request Details :
Name
actid* Any Account id, preferably actual account id if sending from

post login screen
pos* Array of json objects. (object fields given in below table)
Json Fields of Possible value Description

object in values
Array
exch NFO, CDS, MCX ... Exchange
instname FUTSTK, FUTIDX, Instrument name

OPTSTK, FUTCUR...
symname USDINR, ACC, ABB, Symbol name

NIFTY..
expd 2020-10-29 YYYY-MM-DD format
optt CE, PE Option Type
81
strprc 11900.00, 71.0025 Strike price
buyqty Buy Open Quantity
sellqty Sell Open Quantity
netqty Net traded quantity
Response Details :

value
span Span value
expo Exposure margin
span_trade Span value ignoring input fields buyqty, sellqty
expo_trade Exposure margin ignoring input fields buyqty, sellqty
82
Web Socket API
Connect to wss://api.broker1.com/NorenStream/NorenWS
General Guidelines
1) As soon as connection is done, a connection request should be sent with User id and
login session id.
2) All input and output messages will be in json format.
Connect
Request:
t c ‘c’ represents connect task
uid User ID
actid Account id
source WEB / MOB Source should be same as login request.
susertoken User Session Token
Response :
t ck ‘ck’ represents connect acknowledgement
uid User ID
s Ok or Not_Ok(in case of invalid user id or session id)
83
Subscribe Touchline
Request :
t t ‘t’ represents touchline task
k One or more scriplist for subscription. Example

NSE|22#BSE|508123#NSE|NIFTY
Subscription Acknowledgement:
Number of Acknowledgements for a single subscription will be the same as the number of scrips
mentioned in the key (k) field.
t tk ‘tk’ represents touchline acknowledgement
e NSE, BSE, NFO .. Exchange name
tk 22 Scrip Token
pp 2 for NSE, BSE Price precision

4 for CDS USDINR
ts Trading Symbol
ti Tick size
ls Lot size
lp LTP
pc Percentage change
v volume
o Open price
h High price
l Low price
84
c Close price
ap Average trade price
TouchLine subscription Updates :

Accept for t, e, and tk other fields may / may not be present.
t tf ‘tf’ represents touchline feed
tk 22 Scrip Token
lp LTP
v volume
o Open price
h High price
l Low price
c Close price
Unsubscribe Touchline
Request:
t u ‘u’ represents Unsubscribe Touchline
k One or more scriplist for unsubscription. Example

NSE|22#BSE|508123
Response :
85
t uk ‘uk’ represents Unsubscribe Touchline acknowledgement

NSE|22#BSE|508123
Subscribe Depth
Request :
t d ‘d’ represents depth subscription
k One or more scriplist for subscription. Example

NSE|22#BSE|508123
Subscription Depth Acknowledgement:
Number of Acknowledgements for a single subscription will be the same as the number of scrips
mentioned in the key (k) field.
t dk ‘dk’ represents depth acknowledgement
tk 22 Scrip Token
lp LTP
v volume
o Open price
h High price
86
l Low price
c Close price
ltt Last trade time
ltq Last trade quantity
tbq Total Buy Quantity
tsq Total Sell Quantity
bq1 Best Buy Quantity 1
bp1 Best Buy Price 1
bo1 Best Buy Orders 1
sq1 Best Sell Quantity 1
87
sp1 Best Sell Price 1
so1 Best Sell Orders 1
lc Lower Circuit Limit
uc Upper Circuit Limit
52h 52 week high low in other exchanges, Life time high low in
mcx
52l 52 week high low in other exchanges, Life time high low in
mcx
Depth subscription Updates :
t df ‘df’ represents depth feed
tk 22 Scrip Token
lp LTP
88
v volume
o Open price
h High price
l Low price
c Close price
ltt Last trade time
ltq Last trade quantity
tbq Total Buy Quantity
tsq Total Sell Quantity
89
lc Lower Circuit Limit
uc Upper Circuit Limit
52h 52 week high low in other exchanges, Life time high low in
mcx
52l 52 week high low in other exchanges, Life time high low in
mcx
Sample Message :
{
"t": "df",
"e": "NSE",
"tk": "22",
"o": "1166.00",
90
"h": "1179.00",
"l": "1145.35",
"c": "1152.65",
"ap": "1159.74",
"v": "819881",
"tbq": "120952",
"tsq": "131730",
"bp1": "1156.00",
"sp1": "1156.50",
"bp2": "1155.80",
"sp2": "1156.55",
"bp3": "1155.75",
"sp3": "1156.65",
"bp4": "1155.70",
"sp4": "1156.70",
"bp5": "1155.65",
"sp5": "1156.75",
"bq1": "4",
"sq1": "10",
"bq2": "67",
"sq2": "63",
"bq3": "83",
"sq3": "1",
"bq4": "139",
"sq4": "53",
"bq5": "393",
"sq5": "94"
}
Unsubscribe Depth
Request:
t ud ‘ud’ represents Unsubscribe depth

NSE|22#BSE|508123
Response :
91
t udk ‘udk’ represents unsubscribe depth acknowledgement

NSE|22#BSE|508123
92
Subscribe Order Update
Request :
t o ‘o’ represents order update subscription task
actid Account id based on which order updated to be sent.
Subscription Acknowledgement:
t ok ‘ok’ represents order update subscription acknowledgement
Order Update subscription Updates :

t om ‘om’ represents touchline feed
uid User Id
actid Account ID
exch Exchange
tsym Trading symbol
qty Order quantity
prc Order Price
prd Product
status Order status (open, complete, rejected etc)
reporttype Order event for which this message is sent out. (fill,
rejected, canceled)
93
trantype Order transaction type, buy or sell
prctyp Order price type (LMT, MKT, SL-LMT, SL-MKT)
ret Order retention type (DAY, EOS, IOC,...)
fillshares Filled shares
avgprc Average fill price
rejreason Order rejection reason, if rejected
exchordid Exchange Order ID
cancelqty Canceled quantity, in case of canceled order
remarks User added tag, while placing order
dscqty Disclosed quantity
trgprc Trigger price for SL orders
Unsubscribe Order Update

Request:
t uo ‘uo’ represents Unsubscribe Order update
Response :
t uok ‘uok’ represents Unsubscribe Order update

acknowledgement
94

Noren MobileClient API v1.0.9.0

Uploaded by

Copyright:

Available Formats

Noren MobileClient API v1.0.9.0

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Noren MobileClient API v1.0.9.0

Uploaded by

Copyright:

Available Formats

1

KAMBALA SOLUTIONS PVT LTD

Login and User Details 7

Order and Trades 29

Holdings and Limits 61

Web Socket API 84

Version Changes Details

1.7.0 Change password dmsg added in case of successful password change

Get and Validate HS Get HandShake Token

1.8.0 Span Calculator

Exit order added.

1.9.0 Order margin API

Upper ckt limit and

52 week high / low

This document provides details of APIs to develop Web/Mobile applications for

jData* Should send json object with fields in below list

Json Fields Possible value Description

apkversion* Application version.

uid* User Id of the login user

pwd* Sha256 of the user entered password.

factor2* DOB or PAN as entered by the user.

vc* Vendor code provided by noren team, along with

appkey* Sha256 of uid|vendor_key

ip_address Optional field

source WEB / MOB

stat Ok or Not_Ok Login Success Or failure status

susertoken It will be present only on login success. This data to be sent

lastaccesstime It will be present only on login success.

spasswordreset Y If Y Mandatory password reset to be enforced. Otherwise

emsg This will be present only if Login fails.

Sample Success Response :

Sample Failure Response :

jData* Should send json object with fields in below list

Json Fields Possible value Description

uid* User Id of the login user

stat Ok or Not_Ok Logout Success Or failure status

request_time It will be present only on successful logout.

emsg This will be present only if Logout fails.

Sample Success Response :

Sample Failure Response :

jData* Should send json object with fields in below list

pan* Pan of the user

dob* Date of birth

stat Ok or Not_Ok Password reset is Success Or failure status

request_time Response received time.

emsg This will be present only if password reset fails. (“Invalid

Sample Success Response :

Sample Failure Response :

jData* Should send json object with fields in below list

oldpwd* Sha256 of old password

pwd* New password in plain text

stat Ok or Not_Ok Password reset is Success Or failure status

request_time Response received time.

dmsg This will be present only in case of success. Number of

emsg This will be present only if password change fails

Sample Success Response :

Sample Failure Response :

Set Device Pin

jData* Should send json object with fields in below list

jKey* Key Obtained on login success.