Holding

The API helps build a holdings section in any application as well as providing various analytics options through the holdings data of the user. This API requires successful authentication of the user for which data is being fetched.

Endpoint

Base URL

https://connects.torusdigital.com/api/v1/holdings/

Header Parameters

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Request Parameter

Name	Value	Mandatory	Description
source	N	Y	Source of the request (e.g., "N")

Request

curl

cURL

curl --location 'https://connects.torusdigital.com/api/v1/holdings/' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "source": "N"
}'

Java

Java-Unirest

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://connects.torusdigital.com/api/v1/holdings/")
  .header("Authorization", "Bearer {{token}}")
  .header("Content-Type", "application/json")
  .body("{\r\n    \"source\": \"N\"\r\n}")
  .asString();

Go

Go-Native

package main

import (
	"fmt"
	"io/ioutil"
	"net/http"
	"strings"
)

func main() {
	url := "https://connects.torusdigital.com/api/v1/holdings/"
	method := "POST"

	payload := strings.NewReader(`{
    "source": "N"
  }`)

	client := &http.Client{}
	req, err := http.NewRequest(method, url, payload)

	if err != nil {
		fmt.Println(err)
		return
	}
	req.Header.Add("Authorization", "Bearer {{token}}")
	req.Header.Add("Content-Type", "application/json")

	res, err := client.Do(req)
	if err != nil {
		fmt.Println(err)
		return
	}
	defer res.Body.Close()

	body, err := ioutil.ReadAll(res.Body)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(string(body))
}

JavaScript

JavaScript-jQuery

var settings = {
  "url": "https://connects.torusdigital.com/api/v1/holdings/",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{token}}",
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "source": "N"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

Response

200

{
    "data": [
        {
            "collateral_qty_cur": 0,
            "collateral_perc": 25,
            "bse_tick_size": 1,
            "xirr": 0,
            "bse_security_id": "532776",
            "remaining_quantity": 20,
            "nse_security_id": "13756",
            "com_collateral": 0,
            "last_traded_price": 39,
            "isin_code": "INE637H01024",
            "total_quantity": 20,
            "row_no": 0,
            "nse_symbol": "SHIVAMAUTO",
            "collateral_qty_com": 0,
            "cost_price": 42.5,
            "market_value": 0,
            "quantity": 20,
            "security_source_type": "HLD",
            "cagr": 0,
            "nse_tick_size": 5,
            "drv_collateral": 0,
            "display_name": "SHIVAM AUTO.LTD",
            "exchange_inst_name": "Other",
            "utilized_quantity": 0,
            "collateral_qty": 0,
            "pledge_qty": 0,
            "bse_symbol": "SHIVAMAUTO",
            "exchange": "ALL",
            "cur_collateral": 0,
            "collateral_qty_drv": 0,
            "collateral": 0
        }
    ],
    "message": "Success",
    "status": "success"
}

Response Parameter

Parameter	Description
nse_symbol	Symbol of a security listed on NSE
nse_security_id	Unique identifier assigned by NSE to a security
bse_symbol	Symbol of a security listed on BSE
bse_security_id	Unique identifier assigned by BSE to a security
Exchange	Exchange on which the security is listed
mkt_pro_value	Market protection value associated with the security
settlor	Entity responsible for settling the security
encash_flag	Indicates if the security can be encashed
mkt_type	Market type in which the security is traded
strike_price	Strike price of an option contract
expiry_date	Expiry date of an option contract
opt_type	Type of option (call or put)
instrument	Type of financial instrument (e.g., equity, derivative)
lot_size	Standardized trading unit size for the security
series	Series of the security (e.g., 'A', 'B')
isin	International Securities Identification Number (ISIN)
display_name	Custom symbol name for the security
exchange_inst_name	Instrument name used on the exchange
placed_by	Entity that placed the order
tick_size	Minimum price movement of the security
algo_id	Algorithm ID associated with the security
placed_by_entity_id	Entity ID of the entity that placed the order
isin_code	ISIN code uniquely identifying the security
security_source_type	Source type of the security
Quantity	Tradable quantity of the security
utilized_quantity	Quantity of the security that has been utilized
remaining_quantity	Remaining quantity of the security
last_traded_price	Last traded price of the security
row_no	Row number or index associated with the security
cost_price	Cost price of the security
Collateral	Indicates if the security is held as collateral
market_value	Market value of the security
total_quantity	Total quantity of the security
Xirr	Extended Internal Rate of Return
Cagr	Compound Annual Growth Rate
nse_tick_size	Tick size for trading on NSE
bse_tick_size	Tick size for trading on BSE
pledge_qty	Quantity of the security that has been pledged