Get Report Meta Data

Header Parameters

Name	Required	Type	Description
Authorization	true	string	Requires the format Bearer access_token where access_token is obtained from the Token API.
Accept	true	string	Defines the content format the client expects, which should be set to application/json.

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.

Examples

A comprehensive set of examples is provided to illustrate various use cases and implementation scenarios for this API. To view detailed examples and access sample code, please refer to: API Examples.

Loading...