# 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 - Orders API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-builder-perps-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: 3
- target: $.paths['/v1/hyperliquid/hip3/orders/{symbol}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get order lifecycle events for a HIP-3 perp
      effect: read
      questions:
      - Can I see every placement, fill and cancel on a builder perp?
      - Can I filter HIP-3 order history by wallet, status or order type?
      instructions:
      - text: Get HIP-3 order history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Show {order_type} orders by {user} on {symbol}.
        slots:
          order_type: query.order_type
          user: query.user
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/orders/{symbol}/flow'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-minute order flow for a HIP-3 perp
      effect: read
      questions:
      - How fast are orders being placed and cancelled on a builder perp?
      - Can I set the granularity of HIP-3 order flow?
      instructions:
      - text: Get HIP-3 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/hip3/orders/{symbol}/tpsl'].get
  update:
    x-apievangelist-phrasing:
      intent: Get HIP-3 take-profit and stop-loss events
      effect: read
      questions:
      - When were TP/SL orders placed or triggered on a builder perp?
      - Can I see one wallet's HIP-3 stop-loss activity?
      instructions:
      - text: Get TP/SL 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'