Funds

This API allows you to fetch the available balance of your capital and commodity accounts.

USE CASE

Check how much balance is available before placing an order.

Details

Shows the balance available for the user for capital as well as the commodity market.
Your app needs the Transactions Info permission. Funds is part of that template, along with Orders, Positions, Trades, Holdings and Market Status.
The request takes no parameters. The response returns a fund_limit list with one row per ledger heading.
Each row has an id, a title, an equityAmount for the capital ledger and a commodityAmount for the commodity ledger.
The sample response lists these titles: Total Balance, Utilized Amount, Clear Balance, Realized Profit and Loss, Collaterals, Fund Transfer, Receivables, Adhoc Limit, Limit at start of the day and Available Balance.
Look up the row you need, for example Available Balance, by its title instead of relying on its position in the list.
To find out the margin a specific order needs, use the Margin Calculator.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Response Attributes

Attribute	Data Type	Description
`id`	int	Unique identity for particular fund
`title`	string	Each title represents a heading of the ledger
`equityAmount`	float	The amount in the capital ledger for the above-mentioned title
`commodityAmount`	float	The amount in the commodity ledger for the above-mentioned title

Request

from fyers_apiv3 import fyersModel

client_id = "XC4XXXXM-100"
access_token = "eyJ0eXXXXXXXX2c5-Y3RgS8wR14g"

# Initialize the FyersModel instance with your client_id, access_token, and enable async mode
fyers = fyersModel.FyersModel(client_id=client_id, token=access_token,is_async=False, log_path="")

# Make a request to get the funds information
response = fyers.funds()
print(response)

{
    "code":200,
    "message":"",
    "s":"ok",
    "fund_limit":[
        {
          "id":1,
          "title":"Total Balance",
          "equityAmount":58.150000000000006,
          "commodityAmount":0
        },
        {
          "id":2,
          "title":"Utilized Amount",
          "equityAmount":0.3,
          "commodityAmount":0
        },
        {
          "id":3,
          "title":"Clear Balance",
          "equityAmount":58.150000000000006,
          "commodityAmount":0
        },
        {
          "id":4,
          "title":"Realized Profit and Loss",
          "equityAmount":-0.3,
          "commodityAmount":0
        },
        {
          "id":5,
          "title":"Collaterals",
          "equityAmount":0,
          "commodityAmount":0
        },
        {
          "id":6,
          "title":"Fund Transfer",
          "equityAmount":0,
          "commodityAmount":0
        },
        {
          "id":7,
          "title":"Receivables",
          "equityAmount":0,
          "commodityAmount":0
        },
        {
          "id":8,
          "title":"Adhoc Limit",
          "equityAmount":0,
          "commodityAmount":0
        },
        {
          "id":9,
          "title":"Limit at start of the day",
          "equityAmount":58.45,
          "commodityAmount":0
        },
        {
          "id":10,
          "title":"Available Balance",
          "equityAmount":58.150000000000006,
          "commodityAmount":0
        }
    ]
  }

Funds

Response Attributes

Video learning