Holdings and Limits

Holdings and Limits¶

Holdings¶

POST : https://skypro.skybroking.com/NorenWClientTP/Holdings

Request Details :

Parameter Name	Possiblevalue	Description
jData*		Should send json object with fields in below list
jKey*		Key Obtained on login success.

Json Fields	Possiblevalue	Description
uid*		Logged in User Id
actid*		Account id of the logged in user.
prd*		Product name

Request structure:Success Response:Failure Response :

jData=
{
    "uid": "J171",
    "actid": "J171",
    "prd": "C"
}
&jKey=33f901a267c4f1a00294e7700dc578bdd42c686f4d25efd6b06eec766f0d80f7

[
    {
        "stat": "Ok",
        "exch_tsym": [
            {
                "exch": "NSE",
                "token": "419",
                "tsym": "BEPL-EQ",
                "pp": "2",
                "ti": "0.05",
                "ls": "1",
                "isin": "INE922A01025"
            },
            {
                "exch": "BSE",
                "token": "500052",
                "tsym": "BEPL",
                "pp": "2",
                "ti": "0.01",
                "ls": "1",
                "isin": "INE922A01025"
            }
        ],
        "upldprc": "92.11",
        "sell_amt": "0.000000",
        "holdqty": "1",
        "hair_cut": "0.21",
        "dpqty": "0",
        "benqty": "0",
        "unplgdqty": "0",
        "colqty": "0",
        "brkcolqty": "0",
        "s_prdt_ali": "CNC",
        "prd": "C",
        "btstqty": "0",
        "usedqty": "0",
        "trdqty": "0"
    },
    {
        "stat": "Ok",
        "exch_tsym": [
            {
                "exch": "NSE",
                "token": "25017",
                "tsym": "BODALCHEM-EQ",
                "pp": "2",
                "ti": "0.05",
                "ls": "1",
                "isin": "INE338D01028"
            },
            {
                "exch": "BSE",
                "token": "524370",
                "tsym": "BODALCHEM",
                "pp": "2",
                "ti": "0.01",
                "ls": "1",
                "isin": "INE338D01028"
            }
        ],
        "upldprc": "82.61",
        "sell_amt": "0.000000",
        "holdqty": "1",
        "hair_cut": "0.22",
        "dpqty": "0",
        "benqty": "0",
        "unplgdqty": "0",
        "colqty": "0",
        "brkcolqty": "0",
        "s_prdt_ali": "CNC",
        "prd": "C",
        "btstqty": "0",
        "usedqty": "0",
        "trdqty": "0"
    },
]

{
"stat":"Not_Ok",
"emsg":"Invalid Input : Missing uid or actid or prd."
}

Response Details : Response data will be in json format with below fields in case of Success:

Json Fields	Possiblevalue	Description
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
dpqty		DP Holding quantity
npoadqty		Non Poa display quantity
colqty		Collateral quantity
benqty		Beneficiary quantity
unplgdqty		Unpledged quantity
brkcolqty		Broker Collateral
btstqty		BTST quantity
btstcolqty		BTST Collateral quantity
usedqty		Holding used today
upldprc		Average price uploaded along with holdings
hair_cut		Hair Cut
prd		Product
s_prdt_ali		Product display name
trdqty		Trade Quantity
sell_amt		Sell Amount

Note

Valuation : btstqty + holdqty + brkcolqty + unplgdqty + benqty + Max(npoadqty, dpqty) - usedqty Salable: btstqty + holdqty + unplgdqty + benqty + dpqty - usedqty

Exch_tsym object:

Json Fields of object in valuesArray	Possiblevalue	Description
exch	NSE, BSE, NFO ...	Exchange
tsym		Trading symbol of the scrip (contract)
token		Token of the scrip (contract)
pp		Price precision
ti		Tick size
ls		Lot size

Response data will be in json format with below fields in case of failure:

Json Fields	Possiblevalue	Description
stat	Not_Ok	Position book request failure indication.
request_time		Response received time.
emsg		Error message

Limits¶

POST : https://skypro.skybroking.com/NorenWClientTP/Limits

Request Details :

Parameter Name	Possiblevalue	Description
jData*		Should send json object with fields in below list
jKey*		Key Obtained on login success.

Json Fields	Possiblevalue	Description
uid*		Logged in User Id
actid*		Account id of the logged in user.
prd		Product name
s_prdt_ali		Product display name
seg	EQT/DER/FX/COM	Segment
exch		Exchange

Request structure:Success Response:Failure Response :

jData=
{
    "uid": "J171",
    "actid": "J171"
}
&jKey=33f901a267c4f1a00294e7700dc578bdd42c686f4d25efd6b06eec766f0d80f7

{
    "request_time": "13:18:22 03-05-2024",
    "stat": "Ok",
    "prfname": "NSE",
    "cash": "4754.00",
    "payin": "0.00",
    "payout": "0.00",
    "brkcollamt": "0.00",
    "unclearedcash": "0.00",
    "aux_daycash": "0.00",
    "aux_brkcollamt": "0.00",
    "aux_unclearedcash": "0.00",
    "daycash": "0.00",
    "turnoverlmt": "1000000000000.00",
    "pendordvallmt": "1000000000000.00",
    "turnover": "1151225.00",
    "marginused": "72.54",
    "margincurper": "1.53",
    "premium": "32.50",
    "brokerage": "40.04",
    "premium_d_m": "32.50",
    "brkage_d_m": "40.04",
    "blk_amt": "0.00",
    "mr_der_u": "0.33"
}

{
"stat":"Not_Ok",
"emsg":"Invalid Input : Missing uid or actid or prd."
}

Response Details : Response data will be in json format with below fields.

Json Fields	Possible value	Description
stat	Ok or Not_Ok	Limits request success or failure indication.
actid		Account id
prd		Product name
seg	EQT/DER/FX/ COM	Segment
exch		Exchange

Cash Primary Fields

Json Fields	Possible value	Description
cash		Cash Margin available
payin		Total Amount transferred using Payins today
payout		Total amount requested for withdrawal today

Cash Additional Fields

Json Fields	Possible value	Description
brkcollamt		Prevalued Collateral Amount
unclearedcash		Uncleared Cash (Payin through cheques)
daycash		Additional leverage amount / Amount added to handle system errors - by broker.

Margin Utilized

Json Fields	Possible value	Description
marginused		Total margin / fund used today
mtomcurper		Mtom current percentage

Margin Used components

Json Fields	Possible value	Description
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

Json Fields	Possible value	Description
turnoverlmt
pendordvallmt

Additional Risk Indicators

Json Fields	Possible value	Description
turnover		Turnover
pendordval		Pending Order value

Margin used detailed breakup fields

Json Fields	Possible value	Description
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)
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)
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_ d_i		Additional scrip basket margin (Derivative Intraday)
addscripbskmrg_d_m		Additional scrip basket margin (Derivative Margin)
addscripbskmrg_f_i		Additional scrip basket margin (FX Intraday)
addscripbskmrg_f_m		Additional scrip basket margin (FX Margin)
addscripbskmrg_ c_i		Additional scrip basket margin (Commodity Intraday)
addscripbskmrg_ c_m		Additional scrip basket margin (Commodity Margin)
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)
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)
peak_mar		Peak margin used by the client
mr_eqt_u		MR equity used
mr_der_u		MR derivatives used
mr_fx_u		MR fx used
mr_com_u		MR commodity used
mr_sell		MR sell credit
mr_t1sell		MR t1 sell credit
mr_eqt_a		MR equity allocated
mr_der_a		MR derivatives allocated
mr_fx_a		MR fx allocated
mr_com_a		MR commodity allocated
request_time		This will be present only in a successful response.
emsg		This will be present only in a failure response.

Get Sub Limits¶

POST : https://skypro.skybroking.com/NorenWClientTP/GetSubLimits

Request Details :

Parameter Name	Possiblevalue	Description
jData*		Should send json object with fields in below list
jKey*		Key Obtained on login success.

Json Fields	Possiblevalue	Description
uid*		Logged in User Id
actid*		Account id of the logged in user.

Request structure:Success Response:Failure Response :

jData=
{
    "uid": "J171",
    "actid": "J171"
}
&jKey=33f901a267c4f1a00294e7700dc578bdd42c686f4d25efd6b06eec766f0d80f7

[
{
    "request_time": "10:45:23 03-06-2024",
    "stat": "Ok",
    "prfname": "NSE",
    "cash": "4588.00",
    "daycash": "0.00",
    "blk_amt": "0.00",
    "unclearedcash": "0.00",
    "brkcollamt": "0.00",
    "payin": "0.00",
    "payout": "0.00"
},
{
    "request_time": "10:45:23 03-06-2024",
    "stat": "Ok",
    "prfname": "MCX",
    "cash": "746.00",
    "daycash": "0.00",
    "blk_amt": "0.00",
    "unclearedcash": "0.00",
    "brkcollamt": "0.00",
    "payin": "0.00",
    "payout": "0.00",
    "seg": "COM"
}
]

{
"stat":"Not_Ok",
"emsg":"Invalid Input : Missing uid or actid or prd."
}

Response Details :

Response data will be in json Array of objects with below fields in case of success.

Json Fields	Possiblevalue	Description
stat	Ok or Not_Ok	Limits request success or failure indication.
actid		Account id
prd		Product name
s_prdt_ali		Product display name
seg	EQT/DER/FX/ COM	Segment
exch		Exchange

Cash Primary Fields

Json Fields	Possible value	Description
cash		Cash Margin available
payin		Total Amount transferred using Payins today
payout		Total amount requested for withdrawal today

Cash Additional Fields

Json Fields	Possible value	Description
brkcollamt		Prevalued Collateral Amount
unclearedcash		Uncleared Cash (Payin through cheques)
daycash		Additional leverage amount / Amount added to handle system errors - by broker.

Margin Utilized

Json Fields	Possible value	Description
marginused		Total margin / fund used today
mtomcurper		Mtom current percentage

Margin Used components

Json Fields	Possible value	Description
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

Margin used detailed breakup fields

Json Fields	Possible value	Description
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)
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)
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_d_i		Additional scrip basket margin (Derivative Intraday)
Addscripbskmrg _d_m		Additional scrip basket margin (Derivative Margin)
addscripbskmrg_f _i		Additional scrip basket margin (FX Intraday)
addscripbskmrg_f_m		Additional scrip basket margin (FX Margin)
addscripbskmrg_c_i		Additional scrip basket margin (Commodity Intraday)
addscripbskmrg_c_m		Additional scrip basket margin (Commodity Margin)
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)
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)
peak_mar		Peak margin used by the client
request_time		This will be present only in a successful response.
emsg		This will be present only in a failure response.

Get Max Payout Amount:¶

POST : https://skypro.skybroking.com/NorenWClientTP/GetMaxPayoutAmount

Request Details :

Parameter Name	Possiblevalue	Description
jData*		Should send json object with fields in below list
jKey*		Key Obtained on login success.

Json Fields	Possiblevalue	Description
uid*		User id of the logged in user.
actid*		Login users account ID
seg		EQT/FX/DER/COM can be sent if limits are managed at segregated level
exch		NSE/BSE/NFO… can be sent if limits are managed at exchange level
prd		C/I/M/F/H/B can be sent if limits are set at product level

Request structure:Success Response:Failure Response :

jData=
{
    "uid": "J171",
    "actid": "J171",
    "exch":"NSE",
    "seg":"com"
}
&jKey=33f901a267c4f1a00294e7700dc578bdd42c686f4d25efd6b06eec766f0d80f7

{
    "request_time": "11:00:32 03-06-2024",
    "stat": "Ok",
    "actid": "C-J171",
    "payout": "1000.00"
}

{
"stat":"Not_Ok",
"emsg":"Invalid Input : Missing uid or actid or prd."
}

Response Details :

Response data will have below fields.

Json Fields	Possiblevalue	Description
stat		success or failure indication.
request_time		This will be present only in a successful response.
actid		Account id
payout		Maximum payout amount

Annexure¶

Report Type:

Possible Values
NewAck
ModAck
CanAck
PendingNew
PendingReplace
PendingCancel
New
Replaced
Canceled
Fill
Rejected
ReplaceRejected
CancelRejected
INVALID_REPORT_TYPE

Status Type:

Possible Values
PENDING
CANCELED
OPEN
REJECTED
COMPLETE
TRIGGER_PENDING
INVALID_STATUS_TYPE

Internal Status Type:

Possible Values
COMPLETE
REJECTED
CANCELED
MODIFY PENDING
CANCEL PENDING
ORDER PENDING
OPEN
ORDER ACK
MODIFY ACK
CANCEL ACK
TRIGGER_PENDING
AMO OPEN
AMO MODIFIED
AMO CANCELED

Retention Type :

Exchange		Possible Values
NSE		DAY ,IOC
BSE		EOS,DAY, IOC
NFO		DAY,IOC
CDS		DAY, IOC
NCX		DAY, IOC
BFO		EOS, DAY, IOC
BCD		EOS, DAY, IOC