Skip to main content

FUNDS VIEW SUMMARY​

This API is used to fetch detailed funds summary information for a user, including deposits, collateral, trading limits, utilization, P&L, and available funds.

🔑 Header Parameters​

HeaderTypeDescriptionExample
Content-TypestringSpecifies the media type of the request payloadapplication/json
AuthorizationstringDealer authentication tokenBearer {{access_token}}
x-api-keystringAPI key used to authorize the request{{x-api-key}}

📑 Request Body Parameters​

FieldTypeRequiredDescriptionExample
userIdstringYesClient ID to fetch funds data. Leave empty for dealer-level"VISHAL1"
groupIdstringYesGroup ID of the user"GRP01"
periodicityNamestringYesPeriodicity name"T+1 Balance"
productTypeintegerYesProduct type identifier1

🟢 Success Response - 200 OK​

Content-Type: application/json

FieldTypeDescriptionExample
statusbooleanStatus of API calltrue
resultobject[]Array containing status and funds summaryRefer below

📦 Result Object Structure​

✅ Status Array​

FieldTypeDescriptionExample
StatusstringStatus of request execution"SUCCESS"
ErrorMsgstringError message if any""

💰 Funds Summary Array​

FieldTypeDescriptionExample
ProductstringProduct ID"EQFO"
DepositstringTotal deposit amount"100000"
Funds Transferred TodaystringFunds transferred today"5000"
CollateralstringCollateral value"25000"
Credit for SalestringCredit available from sell"10000"
Option CFSstringOption Credit for Sale"2000"
Total Trading Power LimitstringTotal trading limit"150000"
Limit UtilizationstringUtilized limit"75000"
Booked P&LstringRealized profit/loss"5000"
MTM P&LstringMark-to-market profit/loss"2000"
Total UtilizationstringTotal utilized funds"77000"
Net Available FundsstringAvailable funds for trading"73000"
For Allocation/WithdrawalstringAmount available for withdrawal"50000"
Exposure MarginstringMargin blocked for exposure"10000"
Cash DepositstringCash deposit amount"80000"
Adhoc DepositintegerAdditional deposit amount5000