PERIODICITY-WISE BALANCE API

This API provides the periodicity-wise fund balance details of a user. It includes categorized balances such as cash deposit, adhoc deposit, miscellaneous deposit, overdraft limits, etc.

🔍 Query Parameters

Parameter	Type	Required	Description	Example
client_id	string	No	Client ID to fetch balance details for an end user	client_id=VISHAL1
periodicity	integer	No	Periodicity ID used to filter balance data. It can be obtained from the Margin Info API	periodicity=30847

🔑 Header Parameters

Header	Type	Description	Example
Content-Type	string	Specifies the media type of the request payload	application/json
Authorization	string	Dealer authentication token	Bearer {{access_token}}
x-api-key	string	API key used to authorize the request	{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

Field	Type	Description	Example
status	string	Status of API call	"success"
code	string	Response code to user request	"s-110"
message	string	Success message	"Balance fetched successfully"
data	object[]	Array of periodicity-wise balance objects	Refer below

📦 Periodicity Balance Object Fields

Field	Type	Description	Example
id	string	Periodicity ID	"30847"
name	string	Exchange or balance category	"NSE"
data	object[]	Array containing detailed balance entries	Refer below

📊 Balance Data Object Fields

Field	Type	Description	Example
sSign	string	Indicates whether balance is added or deducted	"+" / "-"
sDescription	string	Description of the balance type	"Cash Deposit"
nTrading	integer	Amount available for trading	50000
nIPO	integer	Amount available for IPO trading	10000
nMF	integer	Amount available for Mutual Fund trading	5000
nTotal	integer	Total balance amount	65000
sIndicator	string	Type/category of balance	"Deposit"
nId	integer	Unique identifier for the balance entry	1