Balance

Balance The Balance API call encompasses a wealth of information pertinent to users. This information encompasses details regarding equity and derivatives limits, upfront margin requirements, available exposure, and various other balance components relevant to Risk Management System (RMS). This API call serve as a valuable resource for users seeking comprehensive insights into their financial standing, empowering them with the data needed to make informed trading decisions.

Method: GET

{{SERVER_URL}}/api/V2/accounts/balance?clientID=

Headers

Content-Type	Value
Authorization	{{AUTH_TOKEN}}

Query Params

Param	Value
clientID	Required in case of dealer

Response: 200

{
    "code": 200,
    "description": "OK",
    "result": {
        "limitHeader": "ALL|ALL|ALL",
        "limitObject": {
            "RMSSubLimits": {
                "CashAvailable": 99999999999,
                "Collateral": 0,
                "marginUtilized": 0,
                "netMarginAvailable": 99999999999,
                "MTM": 0,
                "UnrealizedMTM": 0,
                "RealizedMTM": 0
            },
            "marginAvailable": {
                "CashMarginAvailable": 99999999999,
                "AdhocMargin": 0,
                "NotinalCash": 0,
                "PayInAmount": 0,
                "PayOutAmount": 0,
                "CNCSellBenifit": 0,
                "DirectCollateral": 0,
                "HoldingCollateral": 0,
                "ClientBranchAdhoc": 0,
                "SellOptionsPremium": 0,
                "TotalBranchAdhoc": 0,
                "AdhocFOMargin": 0,
                "AdhocCurrencyMargin": 0,
                "AdhocCommodityMargin": 0
            },
            "marginUtilized": {
                "GrossExposureMarginPresent": 0,
                "BuyExposureMarginPresent": 0,
                "SellExposureMarginPresent": 0,
                "VarELMarginPresent": 0,
                "ScripBasketMarginPresent": 0,
                "GrossExposureLimitPresent": 0,
                "BuyExposureLimitPresent": 0,
                "SellExposureLimitPresent": 0,
                "CNCLimitUsed": 0,
                "CNCAmountUsed": 0,
                "MarginUsed": 0,
                "LimitUsed": 0,
                "TotalSpanMargin": 0,
                "ExposureMarginPresent": 0
            },
            "limitsAssigned": {
                "CNCLimit": 0,
                "TurnoverLimitPresent": 0,
                "MTMLossLimitPresent": 0,
                "BuyExposureLimit": 0,
                "SellExposureLimit": 0,
                "GrossExposureLimit": 0,
                "GrossExposureDerivativesLimit": 0,
                "BuyExposureFuturesLimit": 0,
                "BuyExposureOptionsLimit": 0,
                "SellExposureOptionsLimit": 0,
                "SellExposureFuturesLimit": 0
            },
            "AccountID": "CLIENT1"
        }
    },
    "type": "success"
}