Skip to main content

Get Fund And Margin

API to retrieve user funds data for both the equity and commodity markets, including data such as the margin utilized by the user, the available margin for trading, and the total payin amount during the day.

Header Parameters

AuthorizationtruestringRequires the format Bearer access_token where access_token is obtained from the Token API.
AccepttruestringDefines the content format the client expects, which should be set to application/json.

Query Parameters

segmentfalsestringDetermines the market segment related to the transaction. Without a specified segment in the request, the response will encompass results for both commodities and equities.
Possible values: for Equity use SEC, for Commodity use COM

Response Body

"status": "success",
"data": {
"commodity": {
"used_margin": 555.23,
"payin_amount": 107.0,
"span_margin": 360.0,
"adhoc_margin": 0.0,
"notional_cash": 0.0,
"available_margin": 3874.5,
"exposure_margin": 75.13
"equity": {
"used_margin": 0.8,
"payin_amount": 200.0,
"span_margin": 0.0,
"adhoc_margin": 0.0,
"notional_cash": 0.0,
"available_margin": 15507.46,
"exposure_margin": 0.0
statusstringA string indicating the outcome of the request. Typically success for successful operations.
dataobjectResponse data for Balance
data.used_marginfloatPositive values denote the amount blocked into an Open order or position. Negative value denotes the amount being released.
data.payin_amountfloatInstant payin will reflect here
data.span_marginfloatAmount blocked on futures and options towards SPAN
data.adhoc_marginfloatPayin amount credited through a manual process
data.notional_cashfloatThe amount maintained for withdrawal
data.available_marginfloatTotal margin available for trading
data.exposure_marginfloatAmount blocked on futures and options towards Exposure

  • The Funds service is down for maintenance from 12:00 AM to 5:30 AM IST daily and is not available for usage during these hours. Users are advised to plan their activities accordingly.


A comprehensive set of examples is provided to illustrate various use cases and implementation scenarios for this API. To view detailed examples and access sample code, please refer to: API Examples.