Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition Charge API

3 actions 3 updates phrasing extends openapi/upstox-charge-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 3

$.info
$.paths['/v2/charges/margin'].post
$.paths['/v2/charges/brokerage'].get

OpenAPI Overlay

Raw ↑ 
# 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 Charge API
  version: 1.0.0
extends: openapi/upstox-charge-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: 2
- target: $.paths['/v2/charges/margin'].post
  update:
    x-apievangelist-phrasing:
      intent: Calculate margin required for instruments
      effect: read
      questions:
      - How much margin do I need before placing these trades on Upstox?
      - Can I compute the combined margin for several instruments in one call?
      - What margin will a basket of futures and options positions block?
      instructions:
      - text: Calculate the margin required for {instruments}.
        slots:
          instruments: requestBody.instruments
      - text: 'Work out the total margin blocked if I trade this basket: {instruments}.'
        slots:
          instruments: requestBody.instruments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/charges/brokerage'].get
  update:
    x-apievangelist-phrasing:
      intent: Estimate brokerage and charges for an order
      effect: read
      questions:
      - What brokerage and charges will I pay on a trade before I place it?
      - How much do taxes and fees add to buying a given quantity of a stock?
      - Does the brokerage differ between intraday and delivery for the same order?
      instructions:
      - text: Estimate brokerage for a {transaction_type} of {quantity} units of {instrument_token} at {price} as {product}.
        slots:
          transaction_type: query.transaction_type
          quantity: query.quantity
          instrument_token: query.instrument_token
          price: query.price
          product: query.product
      - text: Show the full charges breakdown for selling {quantity} of {instrument_token} at {price} under product {product}, side {transaction_type}.
        slots:
          quantity: query.quantity
          instrument_token: query.instrument_token
          price: query.price
          product: query.product
          transaction_type: query.transaction_type
      method: generated
      generated: '2026-09-26'