Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition WebSocket API

5 actions 5 updates phrasing extends openapi/upstox-websocket-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 5

$.info

$.paths['/v2/feed/portfolio-stream-feed'].get

$.paths['/v2/feed/portfolio-stream-feed/authorize'].get

$.paths['/v2/feed/market-data-feed'].get

$.paths['/v2/feed/market-data-feed/authorize'].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 WebSocket API
  version: 1.0.0
extends: openapi/upstox-websocket-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: 4
- target: $.paths['/v2/feed/portfolio-stream-feed'].get
  update:
    x-apievangelist-phrasing:
      intent: Connect to the portfolio updates stream
      effect: read
      questions:
      - How do I get real-time order and position updates pushed to my app?
      - Can I be redirected straight to the portfolio WebSocket?
      instructions:
      - text: Connect me to the portfolio update stream.
      - text: Open the portfolio WebSocket for update types {update_types}.
        slots:
          update_types: query.update_types
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/feed/portfolio-stream-feed/authorize'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the authorized portfolio stream URL
      effect: read
      questions:
      - Where do I get the authorized socket URI for portfolio updates?
      - Can I fetch the portfolio feed URL for my own WebSocket client instead of following a redirect?
      instructions:
      - text: Get the authorized portfolio feed URI.
      - text: Return the portfolio socket URL for {update_types} updates.
        slots:
          update_types: query.update_types
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/feed/market-data-feed'].get
  update:
    x-apievangelist-phrasing:
      intent: Connect to the live market data stream
      effect: read
      questions:
      - How do I stream live ticks for stocks over a WebSocket?
      - Which endpoint redirects me to the market data socket?
      instructions:
      - text: Connect me to the live market data feed.
      - text: Redirect to the market data WebSocket so I can stream prices.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/feed/market-data-feed/authorize'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the authorized market data stream URL
      effect: read
      questions:
      - Where do I get the authorized socket URI for market data?
      - Can I obtain the market feed URL to connect my own WebSocket client?
      instructions:
      - text: Get the authorized market data feed URI.
      - text: Return the socket URL I should use for live market data.
      method: generated
      generated: '2026-09-26'