Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition Instruments API

2 actions 2 updates phrasing extends openapi/upstox-instruments-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/instruments/search'].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 Instruments API
  version: 1.0.0
extends: openapi/upstox-instruments-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/instruments/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search for tradable instruments
      effect: read
      questions:
      - How do I find the instrument key for a stock or option by typing its name?
      - Can I search for the at-the-money Nifty option for a given expiry?
      - Is it possible to narrow an instrument search to certain exchanges or segments?
      instructions:
      - text: Search instruments for {query}.
        slots:
          query: query.query
      - text: Find {query} contracts on {exchanges} expiring {expiry}.
        slots:
          query: query.query
          exchanges: query.exchanges
          expiry: query.expiry
      - text: Look up {query} restricted to instrument types {instrument_types} in segments {segments}.
        slots:
          query: query.query
          instrument_types: query.instrument_types
          segments: query.segments
      - text: Find the option {atm_offset} strikes from the money for {query}.
        slots:
          atm_offset: query.atm_offset
          query: query.query
      method: generated
      generated: '2026-09-26'