# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 0xArchive HIP-3 Builder Perps - Convenience API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-builder-perps-convenience-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['/v1/hyperliquid/hip3/freshness/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check how fresh a HIP-3 coin's data is
      effect: read
      questions:
      - When was each data type last updated for a HIP-3 coin?
      - Are HIP-3 coin names case-sensitive when checking freshness?
      instructions:
      - text: Check HIP-3 data freshness for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show when data last updated for builder perp {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/summary/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-call HIP-3 market summary
      effect: read
      questions:
      - Can I get a HIP-3 market's price, funding and open interest in one call?
      - What does the HIP-3 market summary include?
      instructions:
      - text: Get the HIP-3 market summary for {symbol}.
        slots:
          symbol: path.symbol
      - text: Give me price, mid, funding and OI for builder perp {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/prices/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get HIP-3 mark, oracle and mid price history
      effect: read
      questions:
      - Can I get only price fields over time for a HIP-3 coin?
      - Is there mid price history for builder perps?
      instructions:
      - text: Get HIP-3 price history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Show {interval} mark and oracle prices for {symbol}.
        slots:
          interval: query.interval
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/cvd/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cumulative volume delta for a HIP-3 perp
      effect: read
      questions:
      - Is buying or selling pressure winning on a builder perp each hour?
      - How many credits does the HIP-3 CVD route cost?
      instructions:
      - text: Get HIP-3 cumulative volume delta for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Show hourly CVD for builder perp {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'