Margin Info

This API fetches margin details in multiple formats based on the requested type. You can retrieve a list of allowed periodicities, limit utilization, scrip-wise margin utilization, product-type-wise margin utilization, or detailed limit utilization.

🛣️Path Parameters

Parameter	Type	Required	Description	Example	Allowed Values
type	string	Yes	Type of margin information to fetch. Determines the format of the response data.	"detailed_limit"	"list", "limit", "tokenwise", "producttypewise", "detailed_limit"

🔑Header Parameters

Parameter	Type	Description	Example
Content-Type	string	Content type for request	application/json
Authorization	string	Bearer token for authentication	Bearer {{access_token}}
x-api-key	string	API key for access control	{{x-api-key}}

🟢Success Response - 200 Ok

Field	Type	Description	Example/ENUM
status	string	Status of API call	"success"
code	string	Response code	"s-101"
message	string	Success message	"Success Message"
data	array	Array of margin information objects	See below

📘Margin Info - List Data Fields

Field	Type	Description	Example
PeriodicityName	string	Name of the periodicity	"All Exchange combined"
nPeriodicity	string	Periodicity ID or code	"8589934591"

📘Margin Info - Limit Data Fields

Field	Type	Description	Example
Deposit	string	Total deposit amount	"1000000000"
DPSecurityCollateralDeposit	string	DP security collateral deposit	"0"
POOLSecurityCollateralDeposit	string	Pool security collateral deposit	"0"
SARSecurityCollateralDeposit	string	SAR security collateral deposit	"0"
DPCreditIFSaleDeposit	string	DP credit IF sale deposit	"0"
POOLCreditIFSaleDeposit	string	Pool credit IF sale deposit	"0"
SARCreditIFSaleDeposit	string	SAR credit IF sale deposit	"0"
AdhocDeposit	string	Adhoc deposit amount	"0"
IntrumentType	string	Instrument type	""
Periodicity	string	Periodicity description	""
GrossExposureLimit	number	Gross exposure limit	1000000000
MaxGrossExposure	string	Maximum gross exposure	"0"
NetPurchaseExposureLimit	string	Net purchase exposure limit	"-1"
NetPremiumExposureLimit	string	Net premium exposure limit	"-1"
MaxNetExposure	string	Maximum net exposure	"0"
MaxNetPremiumExposure	string	Maximum net premium exposure	"0"
NetSalesExposureLimit	string	Net sales exposure limit	"-1"
NetWriteExposureLimit	string	Net write exposure limit	"-1"
MaxNetSaleExposure	string	Maximum net sale exposure	"0"
MaxNetWriteExposure	string	Maximum net write exposure	"-1"
NetPositionLimit	string	Net position limit	"-1"
MaxNetPosition	string	Maximum net position	"0"
TurnoverLimit	string	Turnover limit	"-1"
MaxTurnover	string	Maximum turnover	"0"
IMLimit	string	Initial margin limit	"1000000000"
MaxIM	number	Maximum initial margin	0
MTMLossLimit	string	MTM loss limit	"1000000000"
nPeriodicity	string	Periodicity ID or code	"8589934591"
MaxCollateral	number	Maximum collateral value	0
MaxCreditIFSale	number	Maximum credit IF sale	0
NotionalDeposit	number	Notional deposit amount	0
MiscDeposit	number	Miscellaneous deposit	0
ManualCollateral	number	Manual collateral amount	0
OverDraft	number	Overdraft amount	0
DPPledgeCollateral	number	DP pledged collateral	0
POOLPledgeCollateral	number	Pool pledged collateral	0
OptionCFS	number	Option CFS value	0
MaxOptionCFS	number	Maximum option CFS	0
MFUtilize	number	Mutual fund utilization	0

📘Margin Info - Tokenwise

Field	Type	Description	Example
Exchange	string	Exchange name	"EQ Combined"
Scrip	string	Scrip or symbol name	"KOLTEPATIL"
Product Type	string	Product category	"Margin"
Margin Utilized	number	Margin amount utilized	109.84
Exposure Margin	number	Exposure margin value	0
Booked P & L	number	Realized profit and loss	0
MTM P & L	number	Mark-to-market profit and loss	0

📘Margin Info - ProductType Wise

Field	Type	Description	Example
Exchange	string	Exchange name	"BSE Equity"
Product Type	string	Product category	"Margin"
Total Limit	number | null	Total margin limit	null
Margin Utilized	number	Margin amount utilized	109.84
Exposure Margin	number	Exposure margin value	0
Booked P & L	number	Realized profit and loss	0
MTM P & L	number	Mark-to-market profit and loss	0
Net Available	number | null	Net available margin	null

📘Margin Info - ProductType Wise Periodicity

Field	Type	Description	Example
Exchange	string	Exchange name	"BSE Derivative"
Product Type	string	Product category	"ALL"
Total Limit	number | null	Total margin limit	null
Margin Utilized	number	Margin amount utilized	529677
Exposure Margin	number	Exposure margin value	117966.3
Booked P & L	number	Realized profit and loss	0
MTM P & L	number	Mark-to-market profit and loss	-33420
Net Available	number | null	Net available margin	null

📘Margin Info - Detailed Limit

Field	Type	Description	Example
Deposit	string	Total deposit amount	"1000000000000"
DPSecurityCollateralDeposit	string	DP security collateral deposit	"837335092"
POOLSecurityCollateralDeposit	string	Pool security collateral deposit	"0"
SARSecurityCollateralDeposit	string	SAR security collateral deposit	"0"
DPCreditIFSaleDeposit	string	DP credit IF sale deposit	"0"
POOLCreditIFSaleDeposit	string	Pool credit IF sale deposit	"0"
SARCreditIFSaleDeposit	string	SAR credit IF sale deposit	"0"
AdhocDeposit	string	Adhoc deposit amount	"0"
IntrumentType	string	Instrument type	""
Periodicity	string	Periodicity description	""
GrossExposureLimit	number	Gross exposure limit	1000000000000
MaxGrossExposure	string	Maximum gross exposure	"6210"
NetPurchaseExposureLimit	string	Net purchase exposure limit	"1000000000000"
NetPremiumExposureLimit	string	Net premium exposure limit	"1000000000000"
MaxNetExposure	string	Maximum net exposure	"0"
MaxNetPremiumExposure	string	Maximum net premium exposure	"0"
NetSalesExposureLimit	string	Net sales exposure limit	"1000000000000"
NetWriteExposureLimit	string	Net write exposure limit	"1000000000000"
MaxNetSaleExposure	string	Maximum net sale exposure	"6210"
MaxNetWriteExposure	string	Maximum net write exposure	"1000000000000"
NetPositionLimit	string	Net position limit	"1000000000000"
MaxNetPosition	string	Maximum net position	"-6210"
TurnoverLimit	string	Turnover limit	"1000000000000"
MaxTurnover	string	Maximum turnover	"6210"
IMLimit	string	Initial margin limit	"1000000000000"
MaxIM	number	Maximum initial margin utilized	16.5869
MTMLossLimit	string	MTM loss limit	"1000000000000"
nPeriodicity	string	Periodicity ID or code	"8589934591"
GrossOrNet	number	Gross or net calculation flag	0
CurrentMTMLoss	number	Current MTM loss	0
MaxGrossingGrossExposure	number	Max grossing gross exposure	6210
CurrentTradeBasedGrossingGrossExposure	number	Current trade-based grossing gross exposure	2070
CurrentTradeBasedNetPosition	number	Current trade-based net position	-2070
CurrentTradeBasedGrossExposure	number	Current trade-based gross exposure	2070
MaxGrossingNetExposure	number	Max grossing net exposure	0
MaxGrossingNetSaleExposure	number	Max grossing net sale exposure	0
CurrentTurnover	number	Current turnover	0
CurrentPendingOrders	number	Current pending orders value	4140
CurrentTradeBasedIM	number	Current trade-based initial margin	5.52897
ExposureMargin	number	Exposure margin	0
GrossExposureMultiplier	number	Gross exposure multiplier	10000
NetPurchaseExposureMultiplier	number	Net purchase exposure multiplier	10000
NetPremiumExposureMultiplier	number	Net premium exposure multiplier	10000
NetSalesExposureMultiplier	number	Net sales exposure multiplier	10000
NetWriteExposureMultiplier	number	Net write exposure multiplier	10000
NetPositionMultiplier	number	Net position multiplier	10000
TurnoverMultiplier	number	Turnover multiplier	10000
MTMLossMultiplier	number	MTM loss multiplier	10000
IMMultiplier	number	Initial margin multiplier	10000
RetainMultiplier	number	Retain multiplier value	0
nIncludeDepositPreferencesValue	string	Deposit preference inclusion value	"0"
MarginLimitForMargin	string	Margin limit for margin product	"1000000000000"
MarginLimitForDelivery	string	Margin limit for delivery	"1000000000000"
MarginLimitForMTFC	string	Margin limit for MTFC	"1000000000000"
MarginLimitForPTST	string	Margin limit for PTST	"1000000000000"
MarginLimitForMarginPlus	string	Margin limit for margin plus	"1000000000000"
CurrentMTMForMargin	number	Current MTM for margin	0
CurrentBPLForMargin	number	Current booked P&L for margin	0
OverruleCRPLI	number	Override CRP limit indicator	0
LimitInclusionValue	string	Limit inclusion value	"269509296899"
MaxCollateral	number	Maximum collateral	0
MaxCreditIFSale	number	Maximum credit IF sale	0
NotionalDeposit	number	Notional deposit	0
MiscDeposit	number	Miscellaneous deposit	0
ManualCollateral	number	Manual collateral	0
OverDraft	number	Overdraft amount	0
DPPledgeCollateral	number	DP pledged collateral	0
POOLPledgeCollateral	number	Pool pledged collateral	0
OptionCFS	number	Option CFS value	0
MaxOptionCFS	number	Maximum option CFS	0
nBrokerageForMargin	number	Brokerage for margin	0
nBrokerageForMTM	number	Brokerage for MTM	0
MaxSingleTransValue	number	Max single transaction value	-1
MaxSingleTransQty	number	Max single transaction quantity	-1
PendingOrdersLimit	number	Pending orders limit	-1
NetQuantityLimit	number	Net quantity limit	-1
CurrentBookedProfitOrLoss	number	Current booked profit or loss	0
MFUtilize	number	Mutual fund utilized	0
MarginLimitforMutualFund	string	Margin limit for mutual fund	"0"
DealerCode	string	Dealer code	"NWSYF"
nOPTBuyPremiumVal	number	Option buy premium value	0
nMTFMaxIM	number	MTF maximum IM	0
nMTFBookedProfitOrLoss	number	MTF booked profit or loss	0
nPostClosingMarginValue	number	Post-closing margin value	0
nTplus5SettledCollateral	number	T+5 settled collateral	0
nTplus5UnsettledCollateral	number	T+5 unsettled collateral	0
nTplus5HaircutCollateral	number	T+5 haircut collateral	0
nTplus5CFS	number	T+5 CFS value	0
nManualCFS	number	Manual CFS value	0
nLastUpdateTime	string	Last update timestamp	"20230509145707988"
Token	number	Token value	-9
MarketSegmentId	string	Market segment ID	"-1"
nCashCollateralWLI	number	Cash collateral WLI	10000000000
nAdhocDepositWLI	number	Adhoc deposit WLI	0
dOverDraftWLI	number	Overdraft WLI	0
dNotionalDepositWLI	number	Notional deposit WLI	0
dMiscDepositWLI	number	Misc deposit WLI	0
dManualCollateralWLI	number	Manual collateral WLI	0
SARCollateralWLI	number	SAR collateral WLI	0
DPCollateralWLI	number	DP collateral WLI	0
POOLCollateralWLI	number	Pool collateral WLI	0
dDPPledgeCollateralWLI	number	DP pledge collateral WLI	0
dPOOLPledgeCollateralWLI	number	Pool pledge collateral WLI	0
DPCreditForSaleWLI	number	DP credit for sale WLI	0
POOLCreditForSaleWLI	number	Pool credit for sale WLI	0
SARCreditForSaleWLI	number	SAR credit for sale WLI	0
dOptionCFSWLI	number	Option CFS WLI	0