Skip to content

Holdings

Holdings contain long and short-term equity delivery stocks. You will be able to see Demat Holdings, Collateral Holding, and Unsettled holding which is supposed to get delivered from the exchange.


POST: /apiV2/holdings

https://connect.thefirstock.com/apiV2/holdings

Request Details

Parameter Description
userId User id of the logged in user.
jKey Key Obtained on login success.

Code

curl -X POST 'https://connect.thefirstock.com/apiV2/holdings' \
-H 'Content-Type: application/json' \
-d '{
    "userId": "",
    "jKey": "",
}'
from thefirstock import thefirstock

holdings = thefirstock.firstock_Holding()
const Firstock = require('thefirstock');

const firstock = new Firstock();

firstock.holdings({ product: "" }, (err, result) => {
    console.log("Error, ", err)
    console.log("Result: ", result)
})
using thefirstock;

class Program
{
public static void Main()
{
    Firstock firstock = new Firstock();
    var result = firstock.holdings(product: "I");
}
}

Response Success Details

Parameter Description
data.requestTime Response received time.
Status Success
data.holdQuantity Holding quantity
data.dpQuantity DP Holding quantity
data.npoadqty Non Poa display quantity
data.brokerCollateralQuantity Broker Collateral
data.BTSTQuantity BTST quantity
data.usedQuantity Holding used today
data.hairCut Hair Cut
data.unPledgeQuantity Unpledged quantity

Response Details: Json Fields of object in values Array

Parameter Description
exchange NSE/BSE
tsym Trading symbol of the scrip (contract)
token Token of the scrip (contract)
pricePrecision Not_Ok Price precision
tickSize Tick size
lotSize Lot size

Failure Response Details

Parameter Description
Status Failed
requestTime Response received time.
data Type of error

Sample Response

{
"Status": "Success",
"data": [
        {
            "exchangeTradingSymbol": [
                {
                    "exchange": "",
                    "token": "",
                    "tradingSymbol": "",
                    "pricePrecision": "",
                    "tickSize": "",
                    "lotSize": ""
                },
                {
                    "exchange": "",
                    "token": "",
                    "tradingSymbol": "",
                    "pricePrecision": "",
                    "tickSize": "",
                    "lotSize": ""
                }
            ],
            "sellAmount": "",
            "holdQuantity": "",
            "hairCut": "",
            "dpQuantity": "",
            "unPledgeQuantity": "",
            "uploadPrice": "",
            "brokerCollateralQuantity": "",
            "BTSTQuantity": "",
            "usedQuantity": "",
            "tradeQuantity": ""
        },
        {
            "exchangeTradingSymbol": [
                {
                    "exchange": "",
                    "token": "",
                    "tradingSymbol": "",
                    "pricePrecision": "",
                    "tickSize": "",
                    "lotSize": ""
                },
                {
                    "exchange": "",
                    "token": "",
                    "tradingSymbol": "",
                    "pricePrecision": "",
                    "tickSize": "",
                    "lotSize": ""
                }
            ],
            "sellAmount": "",
            "holdQuantity": "",
            "hairCut": "",
            "dpQuantity": "",
            "unPledgeQuantity": "",
            "uploadPrice": "",
            "brokerCollateralQuantity": "",
            "BTSTQuantity": "",
            "usedQuantity": "",
            "tradeQuantity": ""
        }
    ]
}   
{
  "Status": "Failed",
  "data": ",
  "requestTime": ""
}