Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition Post Trade API

2 actions 2 updates phrasing extends openapi/upstox-post-trade-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 2

$.info

$.paths['/v2/charges/historical-trades'].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 Post Trade API
  version: 1.0.0
extends: openapi/upstox-post-trade-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: 1
- target: $.paths['/v2/charges/historical-trades'].get
  update:
    x-apievangelist-phrasing:
      intent: Get trade history for a date range
      effect: read
      questions:
      - How do I get all my trades from past months, not just today?
      - Can I filter historical trades to the equity or F&O segment?
      instructions:
      - text: Get my trades from {start_date} to {end_date}, page {page_number} with {page_size} per page.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          page_number: query.page_number
          page_size: query.page_size
      - text: List {segment} trades between {start_date} and {end_date}, page {page_number}, size {page_size}.
        slots:
          segment: query.segment
          start_date: query.start_date
          end_date: query.end_date
          page_number: query.page_number
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'