# 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 - Order Book API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-builder-perps-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: 2
- target: $.paths['/v1/hyperliquid/hip3/orderbook/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the native 20-level HIP-3 L2 book
      effect: read
      questions:
      - Can I get the top 20 price levels of a HIP-3 book at a past moment?
      - How deep is the native HIP-3 order book snapshot?
      instructions:
      - text: Get the native HIP-3 order book for {symbol}.
        slots:
          symbol: path.symbol
      - text: Get the 20-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}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get native 20-level HIP-3 L2 book history
      effect: read
      questions:
      - Can I pull a series of native HIP-3 book snapshots over a range?
      - What timestamp format does HIP-3 order book history use?
      instructions:
      - text: Get native HIP-3 book history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page 20-level snapshots for {symbol} at depth {depth}.
        slots:
          symbol: path.symbol
          depth: query.depth
      method: generated
      generated: '2026-09-26'