Sign in

v1

latestOpenAPI 3.0.32026-07-24190128.9 KB

Fetch holdings

Fetch holdings and positions using our Holdings Import feature.

get/{gatewayname}/engine/user/holdings

Path parameters

gatewaynamestring required

Query parameters

versionstring

To fetch holdings data in v2 format

mfHoldingsboolean

To include mutual funds holdings in the response, pass the mfHoldings=true query param

Headers

x-gateway-secretstring required

Required | apiSecret shared for authentication

x-gateway-authtokenstring required

Required | JWT signed with shared secret & payload for connected user

Response

200

OR

Example response

{
  "success": true,
  "data": {
    "smallcases": {
      "public": [
        {
          "scid": "SCAW_0001",
          "name": "Timeless Asset Allocation",
          "investmentDetailsURL": "https://smallcase.zerodha.com/details/5f2d22636678954954f29a2d?",
          "shortDescription": "Diversify with equity, gold & fixed income ETFs for recession-proof investing",
          "imageUrl": "https://assets.smallcase.com/images/smallcases/200/SCAW_0001.png",
          "stats": {
            "currentValue": 4921.89,
            "totalReturns": -36.65253999999927
          },
          "constituents": [
            {
              "ticker": "NIFTYBEES",
              "shares": 10
            }
          ]
        }
      ],
      "private": {
        "stats": {
          "currentValue": 57.31,
          "totalReturns": 1.3100000000000023
        }
      }
    },
    "securities": [
      {
        "holdings": {
          "quantity": 4,
          "averagePrice": 36.68
        },
        "positions": {
          "nse": {
            "quantity": 1,
            "averagePrice": 34.1
          },
          "bse": {
            "quantity": 1,
            "averagePrice": 34.1
          }
        },
        "transactableQuantity": 5,
        "smallcaseQuantity": 2,
        "nseTicker": "J&KBANK",
        "bseTicker": "J&KBANK",
        "isin": "INE168A01041",
        "name": "Jammu and Kashmir Bank Ltd"
      }
    ],
    "lastUpdate": "2022-03-24T11:24:00.871Z",
    "snapshotDate": "2022-03-24T11:24:00.871Z",
    "smallcaseAuthId": "6195e288360acf9ebc060d23",
    "broker": "groww"
  }
}