# 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 - Orders API
  version: 1.0.0
extends: openapi/0xarchive-hyperliquid-orders-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/orders/{symbol}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get order lifecycle events for a coin
      effect: read
      questions:
      - Can I see every placement, fill and cancel for a coin's orders?
      - How do I filter order history to one wallet or order type?
      - Can I restrict order events to triggered orders only?
      instructions:
      - text: Get order history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Show {status} orders for {symbol} placed by {user}.
        slots:
          status: query.status
          symbol: path.symbol
          user: query.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/orders/{symbol}/flow'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-minute order flow for a coin
      effect: read
      questions:
      - How fast are orders being placed and cancelled on a coin?
      - Can I change the granularity of aggregated order flow?
      instructions:
      - text: Get order flow for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Show order placement and cancel rates for {symbol} at {granularity}.
        slots:
          symbol: path.symbol
          granularity: query.granularity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/orders/{symbol}/tpsl'].get
  update:
    x-apievangelist-phrasing:
      intent: Get take-profit and stop-loss order events
      effect: read
      questions:
      - When were TP/SL orders placed, triggered or cancelled on a coin?
      - Can I see one wallet's stop-loss activity?
      instructions:
      - text: Get TP/SL order events for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show take-profit and stop-loss events by {user} on {symbol}.
        slots:
          user: query.user
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/orders/{symbol}/trigger-levels'].get
  update:
    x-apievangelist-phrasing:
      intent: See pending stop and take-profit trigger levels
      effect: read
      questions:
      - Where are pending stop-losses and take-profits clustered near the price?
      - Can I bucket voluntary trigger orders by price around mid?
      instructions:
      - text: Get current trigger levels for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show {side} trigger levels for {symbol} in {buckets} buckets.
        slots:
          side: query.side
          symbol: path.symbol
          buckets: query.buckets
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/orders/{symbol}/trigger-levels/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get past trigger level snapshots
      effect: read
      questions:
      - How have pending stop and take-profit clusters moved over time?
      - What cadence are trigger-level history snapshots taken at?
      instructions:
      - text: Get trigger level history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page trigger-level snapshots for {symbol} with cursor {cursor}.
        slots:
          symbol: path.symbol
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'