# 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 Spot API
  version: 1.0.0
extends: openapi/0xarchive-hyperliquid-spot-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: 12
- target: $.paths['/v1/hyperliquid/spot/pairs'].get
  update:
    x-apievangelist-phrasing:
      intent: List Hyperliquid Spot pairs
      effect: read
      questions:
      - Which Hyperliquid Spot pairs have archived data?
      - Where can I find every spot pair symbol like HYPE-USDC?
      instructions:
      - text: List all Hyperliquid Spot pairs.
      - text: Show me every spot pair that is archived.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/spot/pairs/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for one Spot pair
      effect: read
      questions:
      - What metadata is available for a single spot pair?
      - Can I look up one Hyperliquid Spot pair by symbol?
      instructions:
      - text: Get metadata for spot pair {symbol}.
        slots:
          symbol: path.symbol
      - text: Show the details of the {symbol} spot pair.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/spot/orderbook/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Spot pair's L2 order book snapshot
      effect: read
      questions:
      - What does the spot order book for a pair look like right now?
      - Can I get a spot book snapshot at a past timestamp?
      instructions:
      - text: Get the aggregated L2 spot order book for {symbol}.
        slots:
          symbol: path.symbol
      - text: Get the {symbol} spot book at {timestamp} with depth {depth}.
        slots:
          symbol: path.symbol
          timestamp: query.timestamp
          depth: query.depth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/spot/trades/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get historical trades for a Spot pair
      effect: read
      questions:
      - Can I pull spot fills for a pair over a bounded time range?
      - Is spot trade history paginated with a cursor?
      instructions:
      - text: Get spot trades for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page historical spot fills for {symbol} with cursor {cursor}.
        slots:
          symbol: path.symbol
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/spot/trades/{symbol}/recent'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest trades for a Spot pair
      effect: read
      questions:
      - What were the last few trades on a spot pair?
      - Can I get the newest spot fills without giving a time range?
      instructions:
      - text: Get the most recent spot trades for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show the last {limit} trades on spot pair {symbol}.
        slots:
          limit: query.limit
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/spot/orderbook/{symbol}/l4'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order-level L4 book for a Spot pair
      effect: read
      questions:
      - Can I see individual resting orders on a spot pair's book?
      - Are spot L4 orders at each level sorted by queue priority?
      instructions:
      - text: Get the order-by-order L4 reconstruction for spot pair {symbol}.
        slots:
          symbol: path.symbol
      - text: Reconstruct the {symbol} spot order-level book at {timestamp}.
        slots:
          symbol: path.symbol
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/spot/orderbook/{symbol}/l4/diffs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-order L4 diffs for a Spot pair
      effect: read
      questions:
      - How do I replay every order change on a spot pair's L4 book?
      - What does insert_before mean on spot L4 diffs?
      instructions:
      - text: Get spot L4 diffs for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page per-order spot book events for {symbol} with cursor {cursor}.
        slots:
          symbol: path.symbol
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/spot/orderbook/{symbol}/l4/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Spot L4 book reconstruction history
      effect: read
      questions:
      - Which historical L4 reconstruction windows exist for a spot pair?
      - Can I list past spot L4 checkpoints to start a replay?
      instructions:
      - text: Get spot L4 history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: List the spot L4 checkpoints for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/spot/orders/{symbol}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get order events for a Spot pair
      effect: read
      questions:
      - Can I see historical order events on a spot pair?
      - Where do I find spot order placements and cancels over time?
      instructions:
      - text: Get spot order history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Show the order events on spot pair {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/spot/twap/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get TWAP data for a Spot pair
      effect: read
      questions:
      - What TWAP activity has run on a spot pair?
      - Can I get time-weighted average price orders for one pair?
      instructions:
      - text: Get TWAP data for spot pair {symbol}.
        slots:
          symbol: path.symbol
      - text: Show TWAP activity on {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/spot/twap/user/{user}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Spot TWAP data for a wallet
      effect: read
      questions:
      - Which spot TWAPs has a specific wallet run?
      - Can I scope spot TWAP data to one user address?
      instructions:
      - text: Get spot TWAP data for user {user}.
        slots:
          user: path.user
      - text: Show TWAPs by {user} between {start} and {end}.
        slots:
          user: path.user
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/spot/freshness/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check how fresh a Spot pair's data is
      effect: read
      questions:
      - When was spot order book, trade and TWAP data last updated for a pair?
      - Is the archive for a spot pair up to date?
      instructions:
      - text: Check spot data freshness for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show when each spot data type last updated for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'