Balance
This API can be used to retrieve the latest balance with broker for allowed segments.
Responses
🟢 Success Response - 200 OK
| Field | Type | Description | Example |
|---|
| status | string | Indicates the request status | success |
| code | string | Response code for the request | 200 |
| message | string | Success message of the request | Success message |
| data | object | Contains the balance details | { equity: {...}, commodity: {...}, currency: {...} } |
Equity Segment
| Field | Type | Description | Example |
|---|
| id | string | Identification of balance type | EQ |
| name | string | Display name of balance type | Equity |
| net_available | number | Net available balance | 10000.50 |
| total_available | number | Total Trading Power Limit | 15000.00 |
| total_utilised | number | Total utilised balance | 5000.00 |
| total_withdrawable | number | Total withdrawable balance | 8000.00 |
| net_payin_payout | number | Cumulative funds transferred today | 2000.00 |
Equity → Available
| Field | Type | Description | Example |
|---|
| cash | number | Cash balance available | 5000.00 |
| collateral | number | Collateral balance available | 3000.00 |
| credit_for_sale | number | Credit of sale balance available | 1000.00 |
| option_credit_for_sale | number | Options credit of sale balance available | 500.00 |
Equity → Utilised
| Field | Type | Description | Example |
|---|
| limit | number | Limits utilised | 2000.00 |
| pnl_realised | number | Realised profit/loss | 150.00 |
| pnl_unrealised | number | Unrealised profit/loss | -50.00 |
| option_premium | number | Net premium | 100.00 |
Commodity Segment
| Field | Type | Description | Example |
|---|
| id | string | Identification of balance type | COM |
| name | string | Display name of balance type | Commodity |
| net_available | number | Net available balance | 8000.00 |
| total_available | number | Total balance | 12000.00 |
| total_utilised | number | Total utilised balance | 4000.00 |
| total_withdrawable | number | Total withdrawable balance | 6000.00 |
| net_payin_payout | number | Cumulative funds transferred today | 1500.00 |
Commodity → Available
| Field | Type | Description | Example |
|---|
| cash | number | Cash balance available | 4000.00 |
| collateral | number | Collateral balance available | 2500.00 |
| credit_for_sale | number | Credit of sale balance available | 800.00 |
| option_credit_for_sale | number | Options credit of sale balance available | 400.00 |
Commodity → Utilised
| Field | Type | Description | Example |
|---|
| limit | number | Limits utilised | 1500.00 |
| pnl_realised | number | Realised profit/loss | 100.00 |
| pnl_unrealised | number | Unrealised profit/loss | -30.00 |
| option_premium | number | Net premium | 80.00 |
Currency Segment
| Field | Type | Description | Example |
|---|
| id | string | Identification of balance type | CUR |
| name | string | Display name of balance type | Currency |
| net_available | number | Net available balance | 5000.00 |
| total_available | number | Total Trading Power Limit | 7000.00 |
| total_utilised | number | Total utilised balance | 2000.00 |
| total_withdrawable | number | Total withdrawable balance | 4000.00 |
| net_payin_payout | number | Cumulative funds transferred today | 1000.00 |
Currency → Available
| Field | Type | Description | Example |
|---|
| cash | number | Cash balance available | 2500.00 |
| collateral | number | Collateral balance available | 1500.00 |
| credit_for_sale | number | Credit of sale balance available | 600.00 |
| option_credit_for_sale | number | Options credit of sale balance available | 300.00 |
Currency → Utilised
| Field | Type | Description | Example |
|---|
| limit | number | Limits utilised | 1000.00 |
| pnl_realised | number | Realised profit/loss | 50.00 |
| pnl_unrealised | number | Unrealised profit/loss | -20.00 |
| option_premium | number | Net premium | 40.00 |
🔴 Error Response - 400 Bad Request
| Field | Type | Description | Example |
|---|
| status | string | Indicates the request status | error |
| code | string | Error code | "e-101" |
| message | string | Reason for failed request | Error message |