# 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 - Liquidations API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-liquidations-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: 2
- target: $.paths['/v1/hyperliquid/hip3/liquidations/{symbol}/levels'].get
  update:
    x-apievangelist-phrasing:
      intent: See projected HIP-3 liquidation levels
      effect: read
      questions:
      - At what prices would HIP-3 positions get force-liquidated?
      - Can I view only long-side liquidation clusters near the mark price?
      instructions:
      - text: Get projected liquidation levels for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show {side} liquidation levels for {symbol} at {at}.
        slots:
          side: query.side
          symbol: path.symbol
          at: query.at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/liquidations/{symbol}/levels/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get past HIP-3 liquidation level snapshots
      effect: read
      questions:
      - How have projected HIP-3 liquidation clusters shifted over time?
      - Can I get just summary rows for liquidation-level history?
      instructions:
      - text: Get liquidation level history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page liquidation-level snapshots for {symbol} with cursor {cursor}.
        slots:
          symbol: path.symbol
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'