Get Fund and Margin V3 API
Effective April 10, 2026
We are excited to announce the release of the Get Fund and Margin V3 API. This new version provides a significantly more detailed balance breakdown compared to the existing v2 endpoint, giving developers precise visibility into every component of a user's funds and margin.
What's New?
No segment parameter required
Unlike v2, the v3 API returns a unified response covering all segments in a single call. There is no
segmentquery parameter.Available-to-trade breakdown
The response now splits available funds into two distinct sub-categories:
- Cash available to trade — includes opening balance, payin/payout activity, stock sale credits, and a detailed breakdown of cash margin in use (SPAN+exposure, VAR+ELM, premium, delivery margin, MTF, and realised/unrealised loss).
- Pledge available to trade — includes margin received from pledged equity stocks and mutual funds, alongside a corresponding margin-used breakdown.
Unavailable-to-trade visibility
The response also surfaces funds that exist in the account but cannot currently be used for trading:
- Unsettled profit — broken into today's profit and profit from previous days.
- Unavailable pledge collateral — separately reported for equity and mutual fund pledges.
Migration from V2
| Aspect | V2 | V3 |
|---|---|---|
| Segment parameter | Required (SEC / COM) | Not required |
| Response structure | Flat per-segment object | Nested available/unavailable breakdown |
| Pledged margin visibility | Not available | Fully detailed |
| Unsettled profit | Not available | Included |
How to Get Started
- Documentation: Refer to the Get Fund and Margin V3 API page for the full endpoint reference, request format, response field descriptions, and code examples.
- Feedback: Share your thoughts and questions in the Upstox Developer Community.
Thank You
We appreciate your continued support. Please let us know how we can keep improving the API experience for your trading applications.