# 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 Fundamentals API
  version: 1.0.0
extends: openapi/upstox-fundamentals-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: 8
- target: $.paths['/v2/fundamentals/{isin}/share-holdings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's shareholding pattern
      effect: read
      questions:
      - How much of a company do promoters, FIIs and the public own?
      - What is the shareholding pattern for a listed Indian company?
      instructions:
      - text: Show the shareholding pattern for ISIN {isin}.
        slots:
          isin: path.isin
      - text: Break down who owns the shares of company {isin}.
        slots:
          isin: path.isin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/fundamentals/{isin}/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's profile
      effect: read
      questions:
      - What does a company do, and what are its basic profile details, given its ISIN?
      - Where can I read a short overview of a listed company on Upstox?
      instructions:
      - text: Get the company profile for ISIN {isin}.
        slots:
          isin: path.isin
      - text: Tell me about the business behind {isin}.
        slots:
          isin: path.isin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/fundamentals/{isin}/key-ratios'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's key financial ratios
      effect: read
      questions:
      - What are the P/E, ROE and other key ratios for a stock?
      - Can I pull valuation and profitability ratios for a company by ISIN?
      instructions:
      - text: Fetch the key financial ratios for {isin}.
        slots:
          isin: path.isin
      - text: Show valuation and return ratios for company {isin}.
        slots:
          isin: path.isin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/fundamentals/{isin}/income-statement'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's income statement
      effect: read
      questions:
      - What were a company's revenue and profit over recent quarters?
      - Can I get consolidated or standalone profit and loss figures, yearly or quarterly?
      - How do I pull the full income statement rather than a summary?
      instructions:
      - text: Get the income statement for {isin}.
        slots:
          isin: path.isin
      - text: Show the {type} income statement for {isin} on a {time_period} basis.
        slots:
          type: query.type
          isin: path.isin
          time_period: query.time_period
      - text: Pull the full {time_period} revenue and profit statement for {isin} with fs={fs}.
        slots:
          time_period: query.time_period
          isin: path.isin
          fs: query.fs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/fundamentals/{isin}/corporate-actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's corporate actions
      effect: read
      questions:
      - Has a company announced dividends, splits or bonus issues?
      - Which corporate actions are on record for a stock?
      instructions:
      - text: List the corporate actions for {isin}.
        slots:
          isin: path.isin
      - text: Show dividends, splits and bonuses announced by {isin}.
        slots:
          isin: path.isin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/fundamentals/{isin}/cash-flow'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's cash flow statement
      effect: read
      questions:
      - How much cash does a company generate from operations?
      - Can I see standalone versus consolidated cash flow for a stock?
      instructions:
      - text: Get the cash flow statement for {isin}.
        slots:
          isin: path.isin
      - text: Show the {type} cash flows for {isin}.
        slots:
          type: query.type
          isin: path.isin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/fundamentals/{isin}/balance-sheet'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's balance sheet
      effect: read
      questions:
      - What are a company's assets, liabilities and debt levels?
      - Where do I get the consolidated balance sheet for a listed company?
      instructions:
      - text: Get the balance sheet for {isin}.
        slots:
          isin: path.isin
      - text: Show the {type} assets and liabilities of {isin}.
        slots:
          type: query.type
          isin: path.isin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/fundamentals/{instrument_key}/competitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's competitors
      effect: read
      questions:
      - Which companies compete with a given stock?
      - How do I find peer companies to compare against a listed stock?
      instructions:
      - text: List the competitors of {instrument_key}.
        slots:
          instrument_key: path.instrument_key
      - text: Find peer companies for instrument {instrument_key}.
        slots:
          instrument_key: path.instrument_key
      method: generated
      generated: '2026-09-26'