Get Report Meta Data

Request

curl -X 'GET'
   'https://api.upstox.com/v2/trade/profit-loss/metadata?start_date=01-04-2022&emd_date=30-03-2023&segment=EQ&financial_year=2223'
 -H 'Content-Type: application/json'
 -H 'accept: application/json'
 -H 'Authorization: Bearer access_token'

Additional samples in various languages are available in the Sample Code section on this page.

Query Parameters

Name	Required	Type	Description
from_date	false	string	Date from which data needs to be fetched. from_date and to_date should fall under the same financial year as mentioned in financial_year attribute. Date in dd-mm-yyyy format
to_date	false	string	Date till which data needs to be fetched. from_date and to_date should fall under the same financial year as mentioned in financial_year attribute. Date in dd-mm-yyyy format
segment	true	string	Segment for which data is requested can be from the following options EQ - Equity, FO - Futures and Options, COM - Commodity, CD - Currency Derivatives
financial_year	true	string	Financial year for which data has been requested. Concatenation of last 2 digits of from year and to year Sample:for 2021-2022, financial_year will be 2122. For the regex pattern applicable to this field, see the Field Pattern Appendix.

Responses

• 200
• 4XX

---

Response Body

{
  "status": "success",
  "data": {
    "trades_count": 10,
    "page_size_limit": 5000
  }
}

Name	Type	Description
status	string	A string indicating the outcome of the request. Typically success for successful operations.
data	object	Response data for brokerage
data.trades_count	integer	Total count of trades in the trade wise P and L report
data.page_size_limit	integer	Maximum number of trades in a page of the trade wise P and L report API

Error codes

Error code	Description
UDAPI1067	The 'segment' is required - You must provide the 'segment' for this operation.
UDAPI1066	The 'segment' is invalid - The provided 'segment' value isn't recognized or accepted.
UDAPI1070	The financial_year is required - Please specify the 'financial_year' in your request.
UDAPI1074	The financial_year is invalid - The 'financial_year' you've provided isn't recognized or valid.
UDAPI100051	Invalid financial year - The financial year you've entered doesn't match any recognized formats or values.
UDAPI1075	to_date must be greater than or equal to from_date and Date should be in valid format: dd-mm-yyyy - Ensure your date ranges and formats are correct.
UDAPI1105	The provided dates do not fall within the specified financial year - The given dates are outside the specified financial year.

Sample Code

A comprehensive set of examples is provided to illustrate various use cases and implementation scenarios for this API.

Python

import requests

url = 'https://api.upstox.com/v2/trade/profit-loss/metadata'
headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer {your_access_token}'
}

params = {
    'from_date': '05-11-2023',
    'to_date': '19-12-2023',
    'segment': 'EQ',
    'financial_year': '2324'
}

response = requests.get(url, headers=headers, params=params)

print(response.status_code)
print(response.json())

Node.js

const axios = require('axios');

const url = 'https://api.upstox.com/v2/trade/profit-loss/metadata';
const headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {your_access_token}'
};

const params = {
  'from_date': '05-11-2023',
  'to_date': '19-12-2023',
  'segment': 'EQ',
  'financial_year': '2324'
};

axios.get(url, { headers, params })
  .then(response => {
    console.log(response.status);
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error:', error.message || error);
  });

Java

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;

public class Main {
    public static void main(String[] args) throws Exception {
        String url = "https://api.upstox.com/v2/trade/profit-loss/metadata";
        String contentTypeHeader = "application/json";
        String acceptHeader = "application/json";
        String authToken = "Bearer {your_access_token}";

        String fromDate = "05-11-2023";
        String toDate = "19-12-2023";
        String segment = "EQ";
        String financialYear = "2324";

        String encodedParams = String.format("from_date=%s&to_date=%s&segment=%s&financial_year=%s",
                URLEncoder.encode(fromDate, "UTF-8"),
                URLEncoder.encode(toDate, "UTF-8"),
                URLEncoder.encode(segment, "UTF-8"),
                URLEncoder.encode(financialYear, "UTF-8"));

        String fullUrl = url + "?" + encodedParams;

        URL obj = new URL(fullUrl);
        HttpURLConnection connection = (HttpURLConnection) obj.openConnection();

        // Set request method
        connection.setRequestMethod("GET");

        connection.setRequestProperty("Content-Type", contentTypeHeader);
        connection.setRequestProperty("Accept", acceptHeader);
        connection.setRequestProperty("Authorization", authToken);

        int responseCode = connection.getResponseCode();

        System.out.println("Sending 'GET' request to URL: " + fullUrl);
        System.out.println("Response Code: " + responseCode);

        BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
        String inputLine;
        StringBuilder response = new StringBuilder();

        while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
        }
        in.close();

        // Print the response
        System.out.println("Response: " + response.toString());
    }
}

PHP

<?php

$url = 'https://api.upstox.com/v2/trade/profit-loss/metadata';
$contentTypeHeader = 'application/json';
$acceptHeader = 'application/json';
$authToken = 'Bearer {your_access_token}';

$fromDate = '05-11-2023';
$toDate = '19-12-2023';
$segment = 'EQ';
$financialYear = '2324';

$params = [
    'from_date' => $fromDate,
    'to_date' => $toDate,
    'segment' => $segment,
    'financial_year' => $financialYear
];

$encodedParams = http_build_query($params);
$fullUrl = $url . '?' . $encodedParams;

$headers = [
    'Content-Type: ' . $contentTypeHeader,
    'Accept: ' . $acceptHeader,
    'Authorization: ' . $authToken,
];

$ch = curl_init($fullUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

curl_close($ch);

echo 'URL: ' . $fullUrl . PHP_EOL;
echo 'Response Code: ' . $httpCode . PHP_EOL;
echo 'Response: ' . $response . PHP_EOL;
?>

Python SDK

import upstox_client
from upstox_client.rest import ApiException

configuration = upstox_client.Configuration()
configuration.access_token = '{your_access_token}'

api_instance = upstox_client.TradeProfitAndLossApi(upstox_client.ApiClient(configuration))
segment = 'EQ'
financial_year = '2324' # str | Financial year for which data has been requested. Concatenation of last 2 digits of from year and to year Sample:for 2021-2022, financial_year will be 2122
api_version = '2.0' # str | API Version Header
from_date = '02-04-2023' # str | Date from which data needs to be fetched. from_date and to_date should fall under the same financial year as mentioned in financial_year attribute. Date in dd-mm-yyyy format (optional)
to_date = '20-03-2024' # str | Date till which data needs to be fetched. from_date and to_date should fall under the same financial year as mentioned in financial_year attribute. Date in dd-mm-yyyy format (optional)

try:
    # Get Trade-wise Profit and Loss Report Data
    api_response = api_instance.get_trade_wise_profit_and_loss_meta_data(segment, financial_year, api_version, from_date=from_date, to_date=to_date)
    print(api_response)
except ApiException as e:
    print("Exception when calling TradeProfitAndLossApi->get_trade_wise_profit_and_loss_data: %s\n" % e)

Node.js SDK

let UpstoxClient = require('upstox-js-sdk');
let defaultClient = UpstoxClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAUTH2
let OAUTH2 = defaultClient.authentications['OAUTH2'];
OAUTH2.accessToken = '{your_access_token}';

let apiInstance = new UpstoxClient.TradeProfitAndLossApi();
let segment = "EQ"; // String | Segment for which data is requested can be from the following options EQ - Equity,   FO - Futures and Options,   COM  - Commodity,   CD - Currency Derivatives
let financialYear = "2324"; // String | Financial year for which data has been requested. Concatenation of last 2 digits of from year and to year Sample:for 2021-2022, financial_year will be 2122
let apiVersion = "2.0"; // String | API Version Header
let opts = { 
  'fromDate': "02-04-2023", // String | Date from which data needs to be fetched. from_date and to_date should fall under the same financial year as mentioned in financial_year attribute. Date in dd-mm-yyyy format
  'toDate': "20-03-2024" // String | Date till which data needs to be fetched. from_date and to_date should fall under the same financial year as mentioned in financial_year attribute. Date in dd-mm-yyyy format
};
apiInstance.getTradeWiseProfitAndLossMetaData(segment, financialYear, apiVersion, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + JSON.stringify(data));
  }
});

Java SDK

import com.upstox.ApiClient;
import com.upstox.ApiException;
import com.upstox.Configuration;
import com.upstox.api.GetTradeWiseProfitAndLossMetaDataResponse;
import com.upstox.auth.*;
import io.swagger.client.api.TradeProfitAndLossApi;

public class Main {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        OAuth OAUTH2 = (OAuth) defaultClient.getAuthentication("OAUTH2");
        OAUTH2.setAccessToken("{your_access_token}");
        TradeProfitAndLossApi apiInstance = new TradeProfitAndLossApi();
        String segment = "EQ";
        String financialYear = "2324";
        String apiVersion = "2.0";
        String fromDate = "02-04-2023";
        String toDate = "20-03-2024";
        try {
            GetTradeWiseProfitAndLossMetaDataResponse result = apiInstance.getTradeWiseProfitAndLossMetaData(segment, financialYear, apiVersion, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TradeProfitAndLossApi#getTradeWiseProfitAndLossMetaData");
            e.printStackTrace();
        }
    }
}

Loading...