# 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 - Full-Depth L2 Order Book API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-builder-perps-full-depth-l2-order-book-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/orderbook/{symbol}/l2'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a full-depth HIP-3 L2 book snapshot
      effect: read
      questions:
      - Can I see a HIP-3 book beyond the native 20 levels?
      - From what date is full-depth HIP-3 L2 available?
      instructions:
      - text: Get the full-depth HIP-3 L2 book for {symbol}.
        slots:
          symbol: path.symbol
      - text: Get the full-depth book for {symbol} at {timestamp}.
        slots:
          symbol: path.symbol
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/orderbook/{symbol}/l2/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get full-depth HIP-3 L2 checkpoint history
      effect: read
      questions:
      - Can I page past full-depth L2 checkpoints for a builder perp?
      - Does full-depth HIP-3 history accept a depth override?
      instructions:
      - text: Get full-depth HIP-3 L2 history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page full-depth checkpoints for {symbol} with cursor {cursor}.
        slots:
          symbol: path.symbol
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/orderbook/{symbol}/l2/diffs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tick-level full-depth HIP-3 L2 diffs
      effect: read
      questions:
      - How do I replay every tick change to a HIP-3 aggregated book?
      - Are full-depth L2 diffs derived from order-level deltas for builder perps?
      instructions:
      - text: Get full-depth HIP-3 L2 diffs for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Stream tick-level book changes for builder perp {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'