# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 0xArchive Hyperliquid - Convenience API
  version: 1.0.0
extends: openapi/0xarchive-hyperliquid-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: 5
- target: $.paths['/v1/hyperliquid/liquidations/{symbol}/volume'].get
  update:
    x-apievangelist-phrasing:
      intent: Get bucketed liquidation volume for a coin
      effect: read
      questions:
      - How much long versus short liquidation volume hit a coin each hour?
      - Can I get pre-aggregated liquidation totals in USD per time bucket?
      instructions:
      - text: Get {interval} liquidation volume for {symbol} from {start} to {end}.
        slots:
          interval: query.interval
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Show long and short liquidation USD volume for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/freshness/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check how fresh a coin's data is
      effect: read
      questions:
      - When was each data type last updated for a Hyperliquid coin?
      - Is the archived data for a coin lagging right now?
      instructions:
      - text: Check data freshness for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show when trades, funding and order book data last updated for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/summary/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-call market summary for a coin
      effect: read
      questions:
      - Can I get price, funding, open interest, volume and liquidations in one call?
      - What does a coin's combined market summary include?
      instructions:
      - text: Get the market summary for {symbol}.
        slots:
          symbol: path.symbol
      - text: Give me a snapshot of price, funding and OI for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/prices/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get mark and oracle price history
      effect: read
      questions:
      - Is there a lightweight way to get only mark and oracle prices over time?
      - Can I get oracle price history for a coin at a set interval?
      instructions:
      - text: Get {interval} mark and oracle price history for {symbol} from {start} to {end}.
        slots:
          interval: query.interval
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Show the oracle price history for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/cvd/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cumulative volume delta for a core perp
      effect: read
      questions:
      - Is buying or selling pressure dominating a Hyperliquid coin by hour?
      - Can I get hourly cumulative volume delta buckets for a core symbol?
      instructions:
      - text: Get cumulative volume delta for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Show hourly CVD for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'