Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition History API

4 actions 4 updates phrasing extends openapi/upstox-history-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 4

$.info

$.paths['/v2/historical-candle/{instrumentKey}/{interval}/{to_date}'].get

$.paths['/v2/historical-candle/{instrumentKey}/{interval}/{to_date}/{from_date}'].get

$.paths['/v2/historical-candle/intraday/{instrumentKey}/{interval}'].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 History API
  version: 1.0.0
extends: openapi/upstox-history-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: 3
- target: $.paths['/v2/historical-candle/{instrumentKey}/{interval}/{to_date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get historical candles up to an end date
      effect: read
      questions:
      - How do I get past daily candles for a stock ending on a certain date without picking a start?
      - How much history comes back for weekly or monthly candles up to an end date?
      instructions:
      - text: Get {interval} candles for {instrumentKey} up to {to_date}.
        slots:
          interval: path.interval
          instrumentKey: path.instrumentKey
          to_date: path.to_date
      - text: Pull the default lookback of {interval} OHLC data for {instrumentKey} ending {to_date}.
        slots:
          interval: path.interval
          instrumentKey: path.instrumentKey
          to_date: path.to_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/historical-candle/{instrumentKey}/{interval}/{to_date}/{from_date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get historical candles for a date range
      effect: read
      questions:
      - Can I fetch OHLC candles between a specific start and end date?
      - How do I get 30-minute bars for a stock across a chosen date range?
      instructions:
      - text: Get {interval} candles for {instrumentKey} from {from_date} to {to_date}.
        slots:
          interval: path.interval
          instrumentKey: path.instrumentKey
          from_date: path.from_date
          to_date: path.to_date
      - text: Download OHLC bars at {interval} for {instrumentKey} between {from_date} and {to_date}.
        slots:
          interval: path.interval
          instrumentKey: path.instrumentKey
          from_date: path.from_date
          to_date: path.to_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/historical-candle/intraday/{instrumentKey}/{interval}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get today's intraday candles
      effect: read
      questions:
      - How do I get today's intraday candles for a stock while the market is open?
      - What OHLC bars has an instrument printed so far in the current session?
      instructions:
      - text: Get today's {interval} intraday candles for {instrumentKey}.
        slots:
          interval: path.interval
          instrumentKey: path.instrumentKey
      - text: Show the current session's OHLC bars for {instrumentKey} at {interval}.
        slots:
          instrumentKey: path.instrumentKey
          interval: path.interval
      method: generated
      generated: '2026-09-26'