Funds¶
Use funds() to fetch the current funds and margin snapshot for the account, including available cash, blocked margin, collateral, MTM values, brokerage, and withdrawal-related fields.
LLM guidance
Use this page for fetched capital and margin visibility, not for live streaming updates or pre-trade request-specific margin simulation. Use Get Margin when the goal is to estimate margin for a specific order payload.
Basic Usage¶
from nubra_python_sdk.portfolio.portfolio_data import NubraPortfolio
from nubra_python_sdk.start_sdk import InitNubraSdk, NubraEnv
nubra = InitNubraSdk(NubraEnv.UAT, env_creds=True)
portfolio = NubraPortfolio(nubra)
result = portfolio.funds()
Accessing Data¶
pfm = result.port_funds_and_margin
print(pfm.client_code)
print(pfm.start_of_day_funds)
print(pfm.net_trading_amount)
print(pfm.net_withdrawal_amount)
print(pfm.total_collateral)
print(pfm.net_margin_available)
print(pfm.total_margin_blocked)
print(pfm.derivative_margin_blocked)
print(pfm.brokerage)
Request Contract¶
| Input | Meaning |
|---|---|
funds() |
fetch the current funds and margin snapshot |
Response Contract¶
| Field | Type | Meaning |
|---|---|---|
message |
str |
response message |
port_funds_and_margin.client_code |
str |
trading account client code |
port_funds_and_margin.start_of_day_funds |
int |
opening funds balance |
port_funds_and_margin.net_trading_amount |
int |
net trading amount |
port_funds_and_margin.net_withdrawal_amount |
int |
net withdrawal amount |
port_funds_and_margin.total_collateral |
int |
total collateral |
port_funds_and_margin.net_margin_available |
int |
currently available margin |
port_funds_and_margin.total_margin_blocked |
int |
total blocked margin |
port_funds_and_margin.derivative_margin_blocked |
int |
blocked derivative margin |
port_funds_and_margin.brokerage |
int |
brokerage field when present |
Response Meaning¶
Important funds-level fields include:
| Field | Meaning |
|---|---|
pay_in_credit |
funds credited through pay-in |
pay_out_debit |
funds debited through payout |
net_derivative_prem_buy |
option premium paid |
net_derivative_prem_sell |
option premium received |
cash_blocked_cnc_traded |
cash blocked for CNC trades |
cash_blocked_cnc_open |
cash blocked for open CNC orders |
cash_blocked_deriv_open |
cash blocked for open derivative orders |
mtm_deriv |
derivative mark-to-market value |
mtm_eq_iday_cnc |
intraday and CNC equity MTM |
mtm_eq_delivery |
delivery equity MTM |
start_of_day_collateral |
opening collateral value |
iday_collateral_pledge |
intraday collateral from pledged holdings |
iday_collateral_pledge_sell |
intraday collateral from sell-side pledge benefit |
margin_used_deriv_traded |
used margin for derivative trades |
margin_block_deriv_open_order |
blocked margin for derivative open orders |
margin_used_eq_iday |
used intraday equity margin |
margin_blocked_eq_iday_open |
blocked intraday equity order margin |
Important Rules¶
Important Rules
- Funds are account-state snapshots. The response does not auto-update after it is returned.
- Cash, collateral, margin, MTM, and brokerage fields are typically returned in exchange-native integer units such as paise for NSE-linked values.
- Use
funds()for available-capital visibility, not as a substitute for pre-trade margin estimation. - Use Get Margin before order placement when you need request-specific margin requirements.
- Use environment-correct login and account context. UAT and PROD funds are separate.
