Generated by API Evangelist
Written by API Evangelist tooling for Upstox's API. It is a proposal applied on top of the contract, not a document Upstox publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for OpenAPI definition Trade Profit And Loss API
version: 1.0.0
extends: openapi/upstox-trade-profit-and-loss-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v2/trade/profit-loss/metadata'].get
update:
x-apievangelist-phrasing:
intent: Get P&L report metadata
effect: read
questions:
- How many trades are in my realised P&L report and what page size is allowed?
- What summary information is available before I pull my P&L report?
instructions:
- text: Get the P&L report metadata for {segment} in financial year {financial_year}.
slots:
segment: query.segment
financial_year: query.financial_year
- text: Show P&L metadata for {segment}, FY {financial_year}, from {from_date} to {to_date}.
slots:
segment: query.segment
financial_year: query.financial_year
from_date: query.from_date
to_date: query.to_date
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/trade/profit-loss/data'].get
update:
x-apievangelist-phrasing:
intent: Get trade-wise realised profit and loss
effect: read
questions:
- What profit or loss did I book on each trade this financial year?
- Can I page through my realised P&L trade by trade?
instructions:
- text: Get trade-wise P&L for {segment} in FY {financial_year}, page {page_number} of size {page_size}.
slots:
segment: query.segment
financial_year: query.financial_year
page_number: query.page_number
page_size: query.page_size
- text: List realised gains and losses per trade in {segment} from {from_date} to {to_date}, FY {financial_year}, page {page_number}, {page_size} rows.
slots:
segment: query.segment
from_date: query.from_date
to_date: query.to_date
financial_year: query.financial_year
page_number: query.page_number
page_size: query.page_size
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/trade/profit-loss/charges'].get
update:
x-apievangelist-phrasing:
intent: Get charges paid on my trades
effect: read
questions:
- How much have I paid in brokerage, taxes and fees this financial year?
- What charges did my F&O trades incur over a date range?
instructions:
- text: Get the trade charges for {segment} in FY {financial_year}.
slots:
segment: query.segment
financial_year: query.financial_year
- text: Show brokerage and taxes paid on {segment} trades from {from_date} to {to_date}, FY {financial_year}.
slots:
segment: query.segment
from_date: query.from_date
to_date: query.to_date
financial_year: query.financial_year
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.