Torus Digital Open API
  • Introduction
  • Get Started
  • Authentication
    • Login
    • Session Token
  • SDK
    • Self Generated SDK'S
  • Orders
    • Order Entry
    • Order Modify
    • Order Cancel
    • Order Convert To delivery
    • Order Margin
    • Order Book
    • Order Details
  • Holdings and Portfolio
    • Portfolio
    • Holding
    • Holding Details
    • Net Positions
  • Market
    • Market Status
  • Trade
    • Trade Book
    • Trade Details
  • Funds
    • Fund limits
    • Fund limits details
  • Historical Data
    • Search Stock
    • Company Basic Detail
    • Indices List
    • Monthly/Yearly Returns
    • Share Holding Pattern
    • Balance Sheet
    • Cash Flow
    • Profit and Loss
Powered by GitBook
On this page
  1. Historical Data

Monthly/Yearly Returns

This API provides market return predictions for various time horizons: 1 month, 6 months, 1 year and 3 years. It returns forecasted values and percentage changes for these periods, helping users assess potential market trends and make informed investment decisions.

Note: cocode can be obtained from the Search Stock or Company Basic Detail API.

Endpoint

https://connects.torusdigital.com/api/v1/returns/{exchange}/{cocode}/{reportType}

Request Parameter

Name
Mandatory
Description

exchange

Y

The stock exchange for which the returns are being retrieved (e.g., "NSE", "BSE").

cocode

Y

The unique company code identifier.

reportType

Y

The type of report to retrieve. Report type (S - Single or C - Consolidated)

Request

cURL
curl -X 'GET' \
'https://connects.torusdigital.com/api/v1/returns/{exchange}/{cocode}/{reportType}' \
  -H 'accept: application/json'
Java-Unirest
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://connects.torusdigital.com/api/v1/returns/{exchange}/{cocode}/{reportType}")
  .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/returns/{exchange}/{cocode}/{reportType}"
	method := "GET"

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

	if err != nil {
		fmt.Println(err)
		return
	}
	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/returns/{exchange}/{cocode}/{reportType}",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json"
  },
};

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

Response

{
  "1monthReturns": -0.44000733345555154,
  "6monthReturns": 3.5932920590326516,
  "1yearReturns": 27.61434766818348,
  "3yearReturns": 32.12901684597961
}

Response Parameters

Parameters
Description

1monthReturns

Predicted percentage return for the next month.

6monthReturns

Predicted percentage return for the next 6 months.

1yearReturns

Predicted percentage return for the next year.

3yearReturns

Predicted percentage return for the next 3 years.

PreviousIndices ListNextShare Holding Pattern

Last updated 8 months ago