Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition Market Holidays and Timings API

14 actions 14 updates phrasing extends openapi/upstox-market-holidays-and-timings-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 14

$.info
$.paths['/v2/market/timings/{date}'].get
$.paths['/v2/market/status/{exchange}'].get
$.paths['/v2/market/smartlist/options'].get
$.paths['/v2/market/smartlist/mtf'].get
$.paths['/v2/market/smartlist/futures'].get
$.paths['/v2/market/pcr'].get
$.paths['/v2/market/oi'].get
$.paths['/v2/market/max-pain'].get
$.paths['/v2/market/holidays'].get
$.paths['/v2/market/holidays/{date}'].get
$.paths['/v2/market/fii'].get
$.paths['/v2/market/dii'].get
$.paths['/v2/market/change-oi'].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 Market Holidays and Timings API
  version: 1.0.0
extends: openapi/upstox-market-holidays-and-timings-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: 13
- target: $.paths['/v2/market/timings/{date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get exchange trading hours on a date
      effect: read
      questions:
      - What time do NSE and MCX open and close on a particular day?
      - Are there special trading hours on a given date, like a Muhurat session?
      instructions:
      - text: Get the exchange timings for {date}.
        slots:
          date: path.date
      - text: Show the open and close times of each exchange on {date}.
        slots:
          date: path.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/status/{exchange}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether an exchange is open
      effect: read
      questions:
      - Is the NSE market open right now?
      - What is the current status of a specific exchange?
      instructions:
      - text: Check the market status of {exchange}.
        slots:
          exchange: path.exchange
      - text: Tell me if {exchange} is open for trading now.
        slots:
          exchange: path.exchange
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/smartlist/options'].get
  update:
    x-apievangelist-phrasing:
      intent: List top options by activity or movement
      effect: read
      questions:
      - Which options are most actively traded today?
      - What index options have the biggest open interest gains?
      - Can I see the top price-gaining stock options?
      instructions:
      - text: Show the {category} options smartlist.
        slots:
          category: query.category
      - text: List {category} options for {asset_type} underlyings.
        slots:
          category: query.category
          asset_type: query.asset_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/smartlist/mtf'].get
  update:
    x-apievangelist-phrasing:
      intent: List stocks eligible for margin trade funding
      effect: read
      questions:
      - Which stocks can I buy with margin trade funding?
      - What is the MTF smartlist with live prices?
      instructions:
      - text: Show the MTF stock smartlist.
      - text: List page {page_number} of margin-funded stocks, {page_size} per page.
        slots:
          page_number: query.page_number
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/smartlist/futures'].get
  update:
    x-apievangelist-phrasing:
      intent: List top futures by activity or movement
      effect: read
      questions:
      - Which futures contracts are most traded today?
      - What commodity futures are the top OI losers right now?
      instructions:
      - text: Show the {category} futures smartlist.
        slots:
          category: query.category
      - text: List {category} futures on {asset_type}.
        slots:
          category: query.category
          asset_type: query.asset_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/pcr'].get
  update:
    x-apievangelist-phrasing:
      intent: Get put-call ratio for an underlying and expiry
      effect: read
      questions:
      - What is the put-call ratio for Nifty options this expiry?
      - How has PCR moved through the day in fixed-minute buckets?
      instructions:
      - text: Get PCR for {instrument_key} expiring {expiry} on {date} in {bucket_interval}-minute buckets.
        slots:
          instrument_key: query.instrument_key
          expiry: query.expiry
          date: query.date
          bucket_interval: query.bucket_interval
      - text: Show the put-call ratio trend of {instrument_key} for the {expiry} expiry on {date}, bucketed every {bucket_interval} minutes.
        slots:
          instrument_key: query.instrument_key
          expiry: query.expiry
          date: query.date
          bucket_interval: query.bucket_interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/oi'].get
  update:
    x-apievangelist-phrasing:
      intent: Get open interest for an underlying and expiry
      effect: read
      questions:
      - What is the open interest across strikes for an index option expiry?
      - Where is open interest building up for a given expiry on a certain day?
      instructions:
      - text: Get open interest for {instrument_key} expiry {expiry} on {date}.
        slots:
          instrument_key: query.instrument_key
          expiry: query.expiry
          date: query.date
      - text: Show OI by strike for {instrument_key}, {expiry} contracts, as of {date}.
        slots:
          instrument_key: query.instrument_key
          expiry: query.expiry
          date: query.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/max-pain'].get
  update:
    x-apievangelist-phrasing:
      intent: Get max pain level for an options expiry
      effect: read
      questions:
      - What is the max pain strike for this week's Bank Nifty expiry?
      - How has the max pain level shifted during the trading day?
      instructions:
      - text: Get max pain for {instrument_key} expiry {expiry} on {date} with {bucket_interval}-minute buckets.
        slots:
          instrument_key: query.instrument_key
          expiry: query.expiry
          date: query.date
          bucket_interval: query.bucket_interval
      - text: Track the max pain strike of {instrument_key} for {expiry} on {date} every {bucket_interval} minutes.
        slots:
          instrument_key: query.instrument_key
          expiry: query.expiry
          date: query.date
          bucket_interval: query.bucket_interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/holidays'].get
  update:
    x-apievangelist-phrasing:
      intent: List this year's market holidays
      effect: read
      questions:
      - Which days are stock market holidays this year?
      - When is the exchange closed for trading during the current year?
      instructions:
      - text: List all market holidays for the current year.
      - text: Show me this year's exchange holiday calendar.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/holidays/{date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a date is a market holiday
      effect: read
      questions:
      - Is the market closed on a specific date?
      - Which exchanges are shut for a holiday on a given day?
      instructions:
      - text: Check whether {date} is a market holiday.
        slots:
          date: path.date
      - text: Tell me which exchanges are closed on {date}.
        slots:
          date: path.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/fii'].get
  update:
    x-apievangelist-phrasing:
      intent: Get FII trading activity
      effect: read
      questions:
      - How much are foreign institutional investors buying or selling in index futures?
      - What has FII activity in index options looked like month by month?
      instructions:
      - text: Get FII activity for {data_type} at {interval} interval.
        slots:
          data_type: query.data_type
          interval: query.interval
      - text: Show foreign institutional flows in {data_type} by {interval} starting {from}.
        slots:
          data_type: query.data_type
          interval: query.interval
          from: query.from
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/dii'].get
  update:
    x-apievangelist-phrasing:
      intent: Get DII cash market activity
      effect: read
      questions:
      - Are domestic institutions net buyers in the cash market today?
      - What is the monthly trend of DII buying and selling?
      instructions:
      - text: Get DII activity for {data_type} at {interval} interval.
        slots:
          data_type: query.data_type
          interval: query.interval
      - text: Show domestic institutional flows in {data_type} per {interval} from {from}.
        slots:
          data_type: query.data_type
          interval: query.interval
          from: query.from
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/market/change-oi'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change in open interest over days
      effect: read
      questions:
      - How much has open interest changed at each strike over the last few days?
      - Where is fresh OI being added or unwound for an expiry?
      instructions:
      - text: Get the change in OI for {instrument_key} expiry {expiry} on {date} over {interval} days.
        slots:
          instrument_key: query.instrument_key
          expiry: query.expiry
          date: query.date
          interval: query.interval
      - text: Show OI added or unwound in {instrument_key} {expiry} contracts across {interval} days up to {date}.
        slots:
          instrument_key: query.instrument_key
          expiry: query.expiry
          interval: query.interval
          date: query.date
      method: generated
      generated: '2026-09-26'