Portfolio

The Portfolio API provides access to detailed information about an investment portfolio. It allows clients to retrieve a comprehensive view of a portfolio and is useful for portfolio management systems, financial institutions, and individual investors.

Endpoint

Base URL

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

Header Parameters

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Request

cURL

curl -X 'GET' \
'https://connects.torusdigital.com/api/v1/portfolio' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {{token}}'\

Java-Unirest

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://connects.torusdigital.com/api/v1/portfolio/")
  .header("Authorization", "Bearer {{token}}")
  .header("Content-Type", "application/json")
  .asString();

Go-Native

package main

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

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

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

	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-jQuery

var settings = {
  "url": "https://connects.torusdigital.com/api/v1/portfolio/",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{token}}",
    "Content-Type": "application/json"
  },
};

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

Response

{
    "status": "S",
    "message": "SUCCESS",
    "lastUpdatedOn": null,
    "url": "",
    "id": null,
    "userID": null,
    "data": [
        {
            "ScripID": 0,
            "L3_ClientID": 0,
            "L4_AccountTypeID": 1,
            "L5_AccountID": 4,
            "ProcessDate": "2024-09-16T00:00:00",
            "AssetClassID": 14,
            "ID": 0,
            "ScripName": "Vodafone Idea Ltd",
            "MaturityDate": "",
            "Units": 3.000,
            "PurchaseNav": 29.157,
            "ValueAtcost": 87.47,
            "CurrentNAV": 13.410,
            "CurrentMarketValuation": 40,
            "Dividend": 0.0000,
            "AbsoluteGainOrLoss": -47.24,
            "AbsoluteGainORLossPercentage": -117.4,
            "XIRR": -74.4,
            "AvgDaysInvested": 50,
            "Category": "Direct Equity",
            "SIP": 0.00,
            "AsonDate": "13 Sep 2024",
            "realizedGainLossValue": 0.0000,
            "realizedGainLossPercentage": 0.00,
            "NetPL": -47.24,
            "DividendPayout": 0.00,
            "currentValuePercentage": 100.0,
            "CategorycurrentValuePercentage": 100.0,
            "TotalXIRR": -74.4,
            "CategoryXIRR": -74.4,
            "TotalDividend": 0.00,
            "TotalNetPl": -47.24,
            "CategoryDividend": 0.00,
            "CategoryNetPl": -47.24,
            "TotalValuetAtCost": 87.47,
            "CategoryValuetAtCost": 87.47,
            "TotalMarketValue": 40.00,
            "CategoryMarketValue": 40.23,
            "CategoryAbsoluteGainOrLoss": -47.24,
            "TotalAbsoluteGainOrLoss": -47.24,
            "UCC": "",
            "ISIN": "ISINNumber",
            "StrCategoryXIRR": "-74.4",
            "PurchaseAllowed": true,
            "RedemptionAllowed": true,
            "STPAllowed": true,
            "SwitchAllowed": true,
            "SWPAllowed": false
        }
    ],
    "table1": null,
    "table2": null,
    "table3": null,
    "table4": null,
    "table5": null,
    "table6": null,
    "table7": null,
    "table8": null,
    "table9": null,
    "table10": null,
    "table11": null,
    "table12": null
}

Response Parameter

Parameter

status

Status of the API response, e.g., "S" for Success.

message

Message describing the status, e.g., "SUCCESS".

lastUpdatedOn

Timestamp of when the portfolio was last updated, if available.

url

A URL for further details or related resources (if applicable).

A unique identifier for the portfolio (if available).

userID

Unique identifier for the user (if applicable).

data

Array of portfolio data objects containing detailed information about each asset in the portfolio.

ScriptID

Unique identifier for the asset (scrip) in the portfolio.

L3_ClientID

Level 3 client ID associated with the portfolio (if applicable).

L4_AccountTypeID

Level 4 account type identifier for the portfolio, e.g., type of account holding the asset.

L5_AccountID

Level 5 account identifier for the specific account holding the asset.

ProcessDate

Date when the data was processed, in ISO 8601 format (e.g., "2024-09-16T00:00:00").

AssetClassID

Identifier for the asset class of the holding (e.g., stocks, bonds, etc.).

Unique identifier for the portfolio entry.

ScripName

Name of the asset or company (e.g., "Vodafone Idea Ltd").

MaturityDate

Maturity date for assets like bonds or fixed deposits (if applicable).

Units

Number of units of the asset held in the portfolio.

PurchaseNav

Net Asset Value (NAV) or price at which the asset was purchased.

ValueAtcost

Value of the asset at the time of purchase (at cost).

CurrentNAV

Current Net Asset Value or price of the asset.

CurrentMarketValuation

Current market value of the asset based on its price/NAV.

Dividend

Total dividends received from the asset.

AbsoluteGainOrLoass

Absolute gain or loss for the asset in terms of currency value.

AbsoluteGainOrLoassPercentage

Absolute percentage gain or loss for the asset.

XIPR

Extended Internal Rate of Return (XIRR) for the asset, showing its annualized performance.

AvgDaysInvested

Average number of days the asset has been held in the portfolio.