0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive Hyperliquid Spot - Order Book API

2 actions 2 updates phrasing extends openapi/0xarchive-hyperliquid-spot-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 2

$.info

$.paths['/v1/hyperliquid/spot/orderbook/{symbol}/history'].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 Spot - Order Book API
  version: 1.0.0
extends: openapi/0xarchive-hyperliquid-spot-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: 1
- target: $.paths['/v1/hyperliquid/spot/orderbook/{symbol}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Spot L2 order book history
      effect: read
      questions:
      - Can I pull historical L2 book snapshots for a spot pair?
      - Which symbols does spot order book history accept?
      instructions:
      - text: Get spot order book history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page spot L2 snapshots for {symbol} at depth {depth}.
        slots:
          symbol: path.symbol
          depth: query.depth
      method: generated
      generated: '2026-09-26'