Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition Options API

3 actions 3 updates phrasing extends openapi/upstox-options-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/option/contract'].get

$.paths['/v2/option/chain'].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 Options API
  version: 1.0.0
extends: openapi/upstox-options-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/option/contract'].get
  update:
    x-apievangelist-phrasing:
      intent: List active option contracts for an underlying
      effect: read
      questions:
      - Which option contracts are currently tradable on an index or stock?
      - Can I list option contracts for every expiry, not just one?
      instructions:
      - text: List option contracts for {instrument_key}.
        slots:
          instrument_key: query.instrument_key
      - text: Show the tradable option contracts of {instrument_key} expiring {expiry_date}.
        slots:
          instrument_key: query.instrument_key
          expiry_date: query.expiry_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/option/chain'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the option chain for an expiry
      effect: read
      questions:
      - What does the Nifty option chain look like for this expiry?
      - How do I see calls and puts side by side with prices and OI for each strike?
      instructions:
      - text: Get the option chain for {instrument_key} at expiry {expiry_date}.
        slots:
          instrument_key: query.instrument_key
          expiry_date: query.expiry_date
      - text: Show calls and puts by strike for {instrument_key}, {expiry_date} expiry.
        slots:
          instrument_key: query.instrument_key
          expiry_date: query.expiry_date
      method: generated
      generated: '2026-09-26'