# 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-4 Outcomes - Order Book API
  version: 1.0.0
extends: openapi/0xarchive-hip-4-outcomes-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: 5
- target: $.paths['/v1/hyperliquid/hip4/orderbook/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a HIP-4 outcome side L2 book snapshot
      effect: read
      questions:
      - What does the order book for a HIP-4 outcome side look like now?
      - Can I get a HIP-4 L2 snapshot at a past timestamp?
      instructions:
      - text: Get the HIP-4 L2 order book for {symbol}.
        slots:
          symbol: path.symbol
      - text: Get the L2 book for outcome side {symbol} at {timestamp}.
        slots:
          symbol: path.symbol
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip4/orderbook/{symbol}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get HIP-4 L2 book history
      effect: read
      questions:
      - Can I pull historical L2 book snapshots for a HIP-4 side?
      - Since when is HIP-4 order book history available?
      instructions:
      - text: Get HIP-4 L2 book history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page L2 snapshots for outcome side {symbol} at depth {depth}.
        slots:
          symbol: path.symbol
          depth: query.depth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip4/orderbook/{symbol}/l4'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order-level L4 book for a HIP-4 side
      effect: read
      questions:
      - Can I see individual resting orders on a HIP-4 outcome book?
      - Does the HIP-4 L4 book default to the latest snapshot?
      instructions:
      - text: Get the HIP-4 L4 order book for {symbol}.
        slots:
          symbol: path.symbol
      - text: Reconstruct the order-level book for outcome side {symbol} at {timestamp}.
        slots:
          symbol: path.symbol
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip4/orderbook/{symbol}/l4/diffs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-order HIP-4 L4 diff events
      effect: read
      questions:
      - How do I replay each order placement and cancel on a HIP-4 book?
      - What is insert_before in HIP-4 L4 diffs?
      instructions:
      - text: Get HIP-4 L4 diffs for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page per-order events for outcome side {symbol} with cursor {cursor}.
        slots:
          symbol: path.symbol
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip4/orderbook/{symbol}/l4/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List HIP-4 L4 checkpoints for replay
      effect: read
      questions:
      - Which full L4 checkpoints can I replay from on a HIP-4 side?
      - What is the default limit for HIP-4 L4 checkpoint history?
      instructions:
      - text: List HIP-4 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 outcome side {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'