# 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 - Liquidations API
  version: 1.0.0
extends: openapi/0xarchive-hyperliquid-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: 4
- target: $.paths['/v1/hyperliquid/liquidations/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get liquidation events for a coin
      effect: read
      questions:
      - Which liquidations happened on a Hyperliquid coin last week?
      - How far back do liquidation events go?
      instructions:
      - text: Get liquidation events for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: List recent liquidations on {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/liquidations/user/{user}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get liquidations for a wallet address
      effect: read
      questions:
      - Was a particular wallet ever liquidated on Hyperliquid?
      - Can I filter a user's liquidations to one coin?
      instructions:
      - text: Get liquidations for user {user}.
        slots:
          user: path.user
      - text: Show liquidations of {user} on {symbol} since {start}.
        slots:
          user: path.user
          symbol: query.symbol
          start: query.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/liquidations/{symbol}/levels'].get
  update:
    x-apievangelist-phrasing:
      intent: See projected forced-liquidation levels
      effect: read
      questions:
      - At what prices would open positions get force-liquidated?
      - Can I see liquidation clusters for only longs or only shorts near the mark price?
      instructions:
      - text: Get projected liquidation levels for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show {side} liquidation levels for {symbol} within {range_pct} percent of mark.
        slots:
          side: query.side
          symbol: path.symbol
          range_pct: query.range_pct
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/liquidations/{symbol}/levels/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get past projected liquidation level snapshots
      effect: read
      questions:
      - How have projected liquidation clusters shifted over time?
      - Since when are liquidation-level snapshots retained?
      instructions:
      - text: Get liquidation level history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page historical liquidation-level snapshots for {symbol} with cursor {cursor}.
        slots:
          symbol: path.symbol
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'