Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition History V3 API

4 actions 4 updates phrasing extends openapi/upstox-history-v3-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['/v3/historical-candle/{instrumentKey}/{unit}/{interval}/{to_date}'].get

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

$.paths['/v3/historical-candle/intraday/{instrumentKey}/{unit}/{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 V3 API
  version: 1.0.0
extends: openapi/upstox-history-v3-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['/v3/historical-candle/{instrumentKey}/{unit}/{interval}/{to_date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom-interval candles up to an end date
      effect: read
      questions:
      - Can I get candles in custom units like 3 minutes or 2 hours up to an end date?
      - How do I request historical bars with a unit and interval ending on a date?
      instructions:
      - text: Get {interval} {unit} candles for {instrumentKey} up to {to_date}.
        slots:
          interval: path.interval
          unit: path.unit
          instrumentKey: path.instrumentKey
          to_date: path.to_date
      - text: Pull {instrumentKey} bars sized {interval} {unit} ending on {to_date}.
        slots:
          instrumentKey: path.instrumentKey
          interval: path.interval
          unit: path.unit
          to_date: path.to_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/historical-candle/{instrumentKey}/{unit}/{interval}/{to_date}/{from_date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom-interval candles for a date range
      effect: read
      questions:
      - How do I fetch 5-minute or 4-hour candles between two dates?
      - Can I choose both the time unit and interval size for a historical date range?
      instructions:
      - text: Get {interval} {unit} candles for {instrumentKey} from {from_date} to {to_date}.
        slots:
          interval: path.interval
          unit: path.unit
          instrumentKey: path.instrumentKey
          from_date: path.from_date
          to_date: path.to_date
      - text: Download {instrumentKey} OHLC in {interval} {unit} bars between {from_date} and {to_date}.
        slots:
          instrumentKey: path.instrumentKey
          interval: path.interval
          unit: path.unit
          from_date: path.from_date
          to_date: path.to_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/historical-candle/intraday/{instrumentKey}/{unit}/{interval}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get today's candles in a custom interval
      effect: read
      questions:
      - How do I get today's intraday bars in a custom size like 3 minutes?
      - What has a stock done so far today in custom unit and interval candles?
      instructions:
      - text: Get today's {interval} {unit} intraday candles for {instrumentKey}.
        slots:
          interval: path.interval
          unit: path.unit
          instrumentKey: path.instrumentKey
      - text: Show the current session for {instrumentKey} in {interval} {unit} bars.
        slots:
          instrumentKey: path.instrumentKey
          interval: path.interval
          unit: path.unit
      method: generated
      generated: '2026-09-26'