Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition Portfolio API

5 actions 5 updates phrasing extends openapi/upstox-portfolio-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v2/portfolio/convert-position'].put

$.paths['/v3/portfolio/mtf-positions'].get

$.paths['/v2/portfolio/short-term-positions'].get

$.paths['/v2/portfolio/long-term-holdings'].get

OpenAPI Overlay

# 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 Portfolio API
  version: 1.0.0
extends: openapi/upstox-portfolio-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: 4
- target: $.paths['/v2/portfolio/convert-position'].put
  update:
    x-apievangelist-phrasing:
      intent: Convert a position's product type
      effect: write
      questions:
      - How do I convert an intraday position to delivery?
      - Can I change the margin product of an open position without closing it?
      instructions:
      - text: Convert {quantity} of my {transaction_type} position in {instrument_token} from {old_product} to {new_product}.
        slots:
          quantity: requestBody.quantity
          transaction_type: requestBody.transaction_type
          instrument_token: requestBody.instrument_token
          old_product: requestBody.old_product
          new_product: requestBody.new_product
      - text: Switch {instrument_token} position ({transaction_type}, qty {quantity}) from {old_product} to {new_product}.
        slots:
          instrument_token: requestBody.instrument_token
          transaction_type: requestBody.transaction_type
          quantity: requestBody.quantity
          old_product: requestBody.old_product
          new_product: requestBody.new_product
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/portfolio/mtf-positions'].get
  update:
    x-apievangelist-phrasing:
      intent: List my margin trade funding positions
      effect: read
      questions:
      - Which stocks am I holding on margin trade funding?
      - What are my current MTF positions?
      instructions:
      - text: Show my MTF positions.
      - text: List stocks I bought with margin trade funding.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/portfolio/short-term-positions'].get
  update:
    x-apievangelist-phrasing:
      intent: List today's open positions
      effect: read
      questions:
      - What positions do I have open today?
      - What's my running profit on today's intraday and F&O positions?
      instructions:
      - text: Show my positions for today.
      - text: List my current short-term positions with P&L.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/portfolio/long-term-holdings'].get
  update:
    x-apievangelist-phrasing:
      intent: List my long-term holdings
      effect: read
      questions:
      - Which shares do I hold in my demat account?
      - What stocks did I buy in earlier sessions and still own?
      instructions:
      - text: Show my long-term holdings.
      - text: List the stocks in my demat portfolio.
      method: generated
      generated: '2026-09-26'