0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive Hyperliquid - Full-Depth L2 Order Book API

4 actions 4 updates phrasing extends openapi/0xarchive-hyperliquid-full-depth-l2-order-book-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for 0xArchive's API. It is a proposal applied on top of the contract, not a document 0xArchive publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v1/hyperliquid/orderbook/{symbol}/l2'].get

$.paths['/v1/hyperliquid/orderbook/{symbol}/l2/history'].get

$.paths['/v1/hyperliquid/orderbook/{symbol}/l2/diffs'].get

OpenAPI Overlay

# 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 - Full-Depth L2 Order Book API
  version: 1.0.0
extends: openapi/0xarchive-hyperliquid-full-depth-l2-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}/l2'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a full-depth L2 order book snapshot
      effect: read
      questions:
      - Can I see the whole Hyperliquid book beyond the 20-level native snapshot?
      - What date does full-depth aggregated L2 data start from?
      instructions:
      - text: Get the full-depth L2 order book for {symbol}.
        slots:
          symbol: path.symbol
      - text: Get the full-depth L2 book for {symbol} at {timestamp}.
        slots:
          symbol: path.symbol
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/orderbook/{symbol}/l2/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get full-depth L2 checkpoint history
      effect: read
      questions:
      - Can I page through historical full-depth L2 checkpoints for a coin?
      - Does the full-depth L2 history route let me limit depth per request?
      instructions:
      - text: Get full-depth L2 checkpoint history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page full-depth L2 snapshots for {symbol} with cursor {cursor}.
        slots:
          symbol: path.symbol
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/orderbook/{symbol}/l2/diffs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tick-level full-depth L2 diffs
      effect: read
      questions:
      - How do I replay every change to the aggregated full-depth book tick by tick?
      - Are there L2 diffs derived from order-level deltas?
      instructions:
      - text: Get full-depth L2 diffs for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Stream the tick-level L2 book changes for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'