Analytics Details

POST tradeview/analyticsDetails

The TradeView Analytics Details API retrieves detailed analytics for a given duration and filter type, providing insights on trading strategies or market characteristics. It returns metrics such as average win/loss size, success probability, holding periods, and transaction summaries categorized by strategy or other parameters.

Request Parameters

Parameter	Type	Possible Values	Description
`duration`	String	ALL / 1Y / 6M / 1M	Specifies the time duration for which analytics details are retrieved. If not provided, it defaults to `ALL`.
`filter`	String	strategy / market cap / sector	Specifies the category by which analytics are filtered. If not provided, it defaults to `strategy`.

Sample Request Body

json

{
    "duration":"1M",
    "filter":"strategy"
}

Sample Code

cURLJavaNodeJsPython

bash

curl -X POST 'https://tradeapi.samco.in/tradeview/analyticsDetails' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-session-token: <SESSION_TOKEN>' \
  -d '{"duration":"1M","filter":"strategy"}'

java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Sample {
  public static void main(String[] args) throws Exception {
    String requestBody = """
        {
          "duration": "1M",
          "filter": "strategy"
        }
        """;

    HttpClient client = HttpClient.newHttpClient();

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://tradeapi.samco.in/tradeview/analyticsDetails"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("x-session-token", "<SESSION_TOKEN>")
        .POST(HttpRequest.BodyPublishers.ofString(requestBody))
        .build();

    HttpResponse<String> response =
        client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  }
}

(async () => {
  const headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'x-session-token': '<SESSION_TOKEN>',
  };

  const requestBody = {
    duration: "1M",
    filter: "strategy"
  };

  const response = await fetch('https://tradeapi.samco.in/tradeview/analyticsDetails', {
    method: 'POST',
    headers,
    body: JSON.stringify(requestBody),
  });

  const data = await response.json();
  console.log(data);
})();

import requests
import json

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'x-session-token': '<SESSION_TOKEN>',
}

requestBody = {
  "duration": "1M",
  "filter": "strategy"
}

r = requests.post('https://tradeapi.samco.in/tradeview/analyticsDetails',
  data=json.dumps(requestBody),
  headers=headers)

print(r.json())

Sample Response

json

{
    "serverTime": "29/10/24 13:05:39",
    "msgId": "1d3cacfa-cce8-4a6c-941e-0a8baaa53455",
    "status": "Success",
    "statusMessage": "Analytics Details retrieved successfully.",
    "analyticsDetails": {
        "averageWinSize": "0.00",
        "averageLossSize": "0.15",
        "samcoSuccessProbabilityRatio": "0.00",
        "strikeRateWinningTrades": "0.00",
        "strikeRateLosingTrades": "100.00",
        "averageHoldingPeriodWin": "0",
        "averageHoldingPeriodLoss": "0",
        "startDate": "2024-09-29",
        "endDate": "2024-10-29",
        "averageGainPercentage": "0.00",
        "averageLossPercentage": "0.99",
        "strategyList": [
            {
                "groupName": "Equity-Cash Market",
                "strategywiseList": [
                    {
                        "strategy": "Long Intraday",
                        "averagePL": "-0.15",
                        "plContribution": "0.00",
                        "winningTradesPercentage": "0.00",
                        "losingTradesPercentage": "100.00",
                        "sspRatio": "0.00",
                        "strikeRateWinningTrades": "0.00",
                        "strikeRateLosingTrades": "100.00",
                        "averageGainPercentage": "0.00",
                        "averageLossPercentage": "0.99",
                        "strikeRatePercentage": "0.00",
                        "averageWinSize": "0.00",
                        "averageLossSize": "0.15",
                        "holdingPeriodWinners": "0",
                        "holdingPeriodLossers": "0",
                        "avgHoldingPeriodWin": "0",
                        "avgHoldingPeriodLoss": "0",
                        "totalTransaction": 2
                    }
                ]
            }
        ]
    }
}

Response Key Descriptions

Parameter	Type	Description
`serverTime`	String	Timestamp of the response in the format `DD/MM/YY HH:MM:SS`.
`msgId`	String	Unique identifier for the message.
`status`	String	Status of the API call (e.g., "Success").
`statusMessage`	String	Message providing additional information about the status.
`analyticsDetails`	Object	Main container for analytics details.
`analyticsDetails.averageWinSize`	String	Average size of winning trades.
`analyticsDetails.averageLossSize`	String	Average size of losing trades.
`analyticsDetails.samcoSuccessProbabilityRatio`	String	Success probability ratio for trades.
`analyticsDetails.strikeRateWinningTrades`	String	Percentage of trades that were successful.
`analyticsDetails.strikeRateLosingTrades`	String	Percentage of trades that were unsuccessful.
`analyticsDetails.averageHoldingPeriodWin`	String	Average holding period for winning trades.
`analyticsDetails.averageHoldingPeriodLoss`	String	Average holding period for losing trades.
`analyticsDetails.startDate`	String	Start date of the specified duration (format `YYYY-MM-DD`).
`analyticsDetails.endDate`	String	End date of the specified duration (format `YYYY-MM-DD`).
`analyticsDetails.averageGainPercentage`	String	Average percentage gain on trades.
`analyticsDetails.averageLossPercentage`	String	Average percentage loss on trades.
`analyticsDetails.strategyList`	Array	List of strategy group details within the analytics data.
`strategyList[].groupName`	String	Name of the strategy group, such as "Equity-Cash Market."
`strategyList[].strategywiseList`	Array	Detailed list of analytics for each strategy.
`strategywiseList[].strategy`	String	Name of the trading strategy (e.g., "Long Intraday").
`strategywiseList[].averagePL`	String	Average profit/loss for the strategy.
`strategywiseList[].plContribution`	String	Contribution of this strategy to overall P/L.
`strategywiseList[].winningTradesPercentage`	String	Percentage of winning trades in this strategy.
`strategywiseList[].losingTradesPercentage`	String	Percentage of losing trades in this strategy.
`strategywiseList[].sspRatio`	String	Success probability ratio within the strategy.
`strategywiseList[].strikeRateWinningTrades`	String	Strike rate for winning trades in this strategy.
`strategywiseList[].strikeRateLosingTrades`	String	Strike rate for losing trades in this strategy.
`strategywiseList[].averageGainPercentage`	String	Average gain percentage for trades in this strategy.
`strategywiseList[].averageLossPercentage`	String	Average loss percentage for trades in this strategy.
`strategywiseList[].strikeRatePercentage`	String	Overall strike rate percentage for this strategy.
`strategywiseList[].averageWinSize`	String	Average size of winning trades in this strategy.
`strategywiseList[].averageLossSize`	String	Average size of losing trades in this strategy.
`strategywiseList[].holdingPeriodWinners`	String	Holding period for winning trades.
`strategywiseList[].holdingPeriodLossers`	String	Holding period for losing trades.
`strategywiseList[].avgHoldingPeriodWin`	String	Average holding period for winning trades.
`strategywiseList[].avgHoldingPeriodLoss`	String	Average holding period for losing trades.
`strategywiseList[].totalTransaction`	Integer	Total transactions made under this strategy.

Analytics Details ​

Request Parameters ​

Sample Request Body ​

Sample Code ​