Skip to content

Funds

Fetch the current funds and margin snapshot for a V3 mapped account, including available cash, blocked margin, collateral, MTM values, brokerage, and withdrawal-related fields.

Method: GET
Endpoint: /sentinel/portfolio/user_funds_and_margin

Base URLs

Environment Base URL
PROD https://api.nubra.io
UAT https://uatapi.nubra.io

cURL

curl --location 'https://api.nubra.io/sentinel/portfolio/user_funds_and_margin' \
--header 'Authorization: Bearer <session_token>' \
--header 'x-device-id: <device_id>'

Request Payload

This is a GET endpoint and does not require a request body.

Response Structure

{
  "message": "portfolio and funds values fetched successfully",
  "portFundsAndMargin": {
    "clientCode": "XXXXX",
    "startOfDayFunds": 2888888,
    "payInCredit": 0,
    "payOutDebit": 0,
    "netDerivativePremBuy": 5612625,
    "netDerivativePremSell": 5538000,
    "netDerivativePrem": -74625,
    "cashBlockedCncTraded": 1868,
    "cashBlockedCncOpen": 0,
    "cashBlockedDerivOpen": 0,
    "cashCncTradedAndOpen": 1868,
    "mtmDeriv": -74625,
    "mtmEqIdayCnc": -555,
    "mtmEqDelivery": -222027,
    "netTradingAmount": 28680916,
    "netWithdrawalAmount": 23115099,
    "totalPayinCash": 0,
    "startOfDayCollateral": 0,
    "idayCollateralPledge": 0,
    "idayCollateralPledgeSell": 0,
    "totalCollateral": 0,
    "marginUsedDerivTraded": 0,
    "marginBlockDerivOpenOrder": 0,
    "marginUsedEqIday": 27817,
    "marginBlockedEqIdayOpen": 0,
    "netMarginAvailable": 28653099,
    "totalMarginBlocked": 27817,
    "derivativeMarginBlocked": 0,
    "brokerage": 18788
  }
}

Response Attributes

Field Type Description
message string Response message
portFundsAndMargin.clientCode string Trading account client code
portFundsAndMargin.startOfDayFunds number Opening funds balance
portFundsAndMargin.netTradingAmount number Net trading amount
portFundsAndMargin.netWithdrawalAmount number Net withdrawal amount
portFundsAndMargin.totalCollateral number Total collateral
portFundsAndMargin.netMarginAvailable number Currently available margin
portFundsAndMargin.totalMarginBlocked number Total blocked margin
portFundsAndMargin.derivativeMarginBlocked number Blocked derivative margin
portFundsAndMargin.brokerage number Brokerage field when present

Important funds-level fields include:

Field Description
portFundsAndMargin.payInCredit Funds credited through pay-in
portFundsAndMargin.payOutDebit Funds debited through payout
portFundsAndMargin.netDerivativePremBuy Option premium paid
portFundsAndMargin.netDerivativePremSell Option premium received
portFundsAndMargin.netDerivativePrem Net derivative premium
portFundsAndMargin.cashBlockedCncTraded Cash blocked for CNC trades
portFundsAndMargin.cashBlockedCncOpen Cash blocked for open CNC orders
portFundsAndMargin.cashBlockedDerivOpen Cash blocked for open derivative orders
portFundsAndMargin.cashCncTradedAndOpen Cash blocked across CNC traded and open orders
portFundsAndMargin.mtmDeriv Derivative mark-to-market value
portFundsAndMargin.mtmEqIdayCnc Intraday and CNC equity MTM
portFundsAndMargin.mtmEqDelivery Delivery equity MTM
portFundsAndMargin.totalPayinCash Total pay-in cash
portFundsAndMargin.startOfDayCollateral Opening collateral value
portFundsAndMargin.idayCollateralPledge Intraday collateral from pledged holdings
portFundsAndMargin.idayCollateralPledgeSell Intraday collateral from sell-side pledge benefit
portFundsAndMargin.marginUsedDerivTraded Used margin for derivative trades
portFundsAndMargin.marginBlockDerivOpenOrder Blocked margin for derivative open orders
portFundsAndMargin.marginUsedEqIday Used intraday equity margin
portFundsAndMargin.marginBlockedEqIdayOpen Blocked intraday equity order margin

Important Rules

Important Rules

  • Use this endpoint for V3 mapped accounts.
  • This endpoint is a funds and margin snapshot. 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 this endpoint for available-capital visibility, not as a substitute for pre-trade margin estimation.
  • Use Get Order Margin before order placement when you need request-specific margin requirements.
  • Use the environment that matches the mapped account. PROD and UAT funds are separate.
NEO Assistant