# 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 - L4 Order Book API
  version: 1.0.0
extends: openapi/0xarchive-hyperliquid-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/orderbook/{symbol}/l4'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order-level L4 book snapshot
      effect: read
      questions:
      - Can I see individual resting orders with order IDs on the book?
      - Does the L4 book return the latest snapshot if I omit a timestamp?
      instructions:
      - text: Get the 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/orderbook/{symbol}/l4/diffs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-order L4 book diff events
      effect: read
      questions:
      - How do I see each order placement, modification, fill and cancel on the book?
      - What does the insert_before field mean in an L4 diff?
      instructions:
      - text: Get L4 order book 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/orderbook/{symbol}/l4/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List L4 book checkpoints for replay
      effect: read
      questions:
      - Which full L4 snapshots can I use as a starting point for replay?
      - Are orders within each L4 checkpoint level sorted by queue priority?
      instructions:
      - text: List 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 {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'