Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition User API

8 actions 8 updates phrasing extends openapi/upstox-user-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 8

$.info

$.paths['/v2/user/ip'].get

$.paths['/v2/user/ip'].put

$.paths['/v2/user/kill-switch'].get

$.paths['/v2/user/kill-switch'].post

$.paths['/v3/user/get-funds-and-margin'].get

$.paths['/v2/user/profile'].get

$.paths['/v2/user/get-funds-and-margin'].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 User API
  version: 1.0.0
extends: openapi/upstox-user-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: 7
- target: $.paths['/v2/user/ip'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my registered static IPs
      effect: read
      questions:
      - Which static IP addresses are registered for my API orders?
      - What primary and secondary IPs are whitelisted on my account?
      instructions:
      - text: Show my registered static IPs.
      - text: List the primary and secondary IPs on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/ip'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my registered static IPs
      effect: write
      questions:
      - How do I register a new static IP for placing orders through the API?
      - Can I set a secondary IP as a backup?
      instructions:
      - text: Set my primary IP to {primary_ip}.
        slots:
          primary_ip: requestBody.primary_ip
      - text: Register {primary_ip} as primary and {secondary_ip} as secondary IP.
        slots:
          primary_ip: requestBody.primary_ip
          secondary_ip: requestBody.secondary_ip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/kill-switch'].get
  update:
    x-apievangelist-phrasing:
      intent: Check kill switch status by segment
      effect: read
      questions:
      - Which trading segments have I disabled with the kill switch?
      - Is trading currently blocked on any segment of my account?
      instructions:
      - text: Show my kill switch status for every segment.
      - text: Tell me which segments are enabled or disabled for trading.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/kill-switch'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable trading segments
      effect: write
      questions:
      - How do I turn on the kill switch to stop myself trading F&O?
      - Can I re-enable a trading segment I switched off?
      instructions:
      - text: Turn on the kill switch for these segments.
      - text: Re-enable trading on the segments I previously disabled.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/user/get-funds-and-margin'].get
  update:
    x-apievangelist-phrasing:
      intent: Get detailed funds and margin breakdown (v3)
      effect: read
      questions:
      - How much of my balance is pledged margin versus cash available to trade?
      - Why is part of my money unavailable to trade?
      instructions:
      - text: Show my detailed v3 funds breakdown.
      - text: Break down my cash, pledged margin and available-to-trade balance.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my account profile
      effect: read
      questions:
      - Which exchanges, products and order types are enabled on my account?
      - What profile details does Upstox hold for the logged-in user?
      instructions:
      - text: Show my user profile.
      - text: List the exchanges and products enabled for me.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/get-funds-and-margin'].get
  update:
    x-apievangelist-phrasing:
      intent: Get funds and margin by segment (v2)
      effect: read
      questions:
      - How much money do I have for equity versus commodity trading?
      - What's my available margin in the commodity segment?
      instructions:
      - text: Show my equity and commodity funds.
      - text: Get my available margin for segment {segment}.
        slots:
          segment: query.segment
      method: generated
      generated: '2026-09-26'