# 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 - L4 Order Book API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-builder-perps-l4-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}/l4'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order-level L4 book for a HIP-3 perp
      effect: read
      questions:
      - Can I see individual resting orders with IDs on a HIP-3 book?
      - Does the HIP-3 L4 book default to the latest snapshot?
      instructions:
      - text: Get the HIP-3 L4 order book for {symbol}.
        slots:
          symbol: path.symbol
      - text: Reconstruct the order-level 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}/l4/diffs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-order HIP-3 L4 diff events
      effect: read
      questions:
      - How do I see each order placement, fill and cancel on a builder perp book?
      - What does insert_before mean in HIP-3 L4 diffs?
      instructions:
      - text: Get HIP-3 L4 diffs for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page per-order book events 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}/l4/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List HIP-3 L4 checkpoints for replay
      effect: read
      questions:
      - Which full L4 snapshots can I replay from on a HIP-3 market?
      - Are orders within HIP-3 L4 checkpoints sorted by queue priority?
      instructions:
      - text: List HIP-3 L4 checkpoints for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Get the L4 checkpoint history for builder perp {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'