Skip to main content

Periodicity Wise Balance​

This API allows you to fetch categorized fund balances such as cash deposits, overdraft limits, and miscellaneous deposits. These balances are organized based on periodicity, allowing for segmented financial insights.

🔍Query Parameters (Optional)​

ParameterTypeDescriptionExample
periodicityintegerPeriodicity ID (Refer MarginInfo API - type list)3

🔑Header Parameters​

HeaderTypeDescriptionExample
AuthorizationstringBearer token for authenticationBearer {{access_token}}
Content-TypestringContent type for requestapplication/json
x-api-keystringAPI key for access control{{x-api-key}}

🟢Success Response - 200 Ok​

FieldTypeDescriptionExample/ENUM
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSuccess message"Success message"
dataarrayArray of Periodicity Balance ObjectsSee below

📑Data Object Info Fields​

FieldTypeDescriptionExample/ENUM
idstringUnique Periodicity ID"3"
namestringPeriodicity Name"NSE Equities"
dataarrayBalance Details ListSee below

🧭Balance Details Info Fields​

FieldTypeDescriptionExample/ENUM
sSignstringSign of Balance Type"+" or "-"
sDescriptionstringDescription of Balance Type"Cash Deposit"
nTradingintegerTrading Account Balance150000
nIPOintegerIPO Balance20000
nMFintegerMutual Funds Balance10000
nTotalintegerTotal Balance180000
sIndicatorstringIndicator"Deposit"