0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive Hyperliquid - Open Interest API

3 actions 3 updates phrasing extends openapi/0xarchive-hyperliquid-open-interest-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 3

$.info
$.paths['/v1/hyperliquid/openinterest/{symbol}'].get
$.paths['/v1/hyperliquid/openinterest/{symbol}/current'].get

OpenAPI Overlay

Raw ↑ 
# 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 - Open Interest API
  version: 1.0.0
extends: openapi/0xarchive-hyperliquid-open-interest-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/openinterest/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Hyperliquid open interest history
      effect: read
      questions:
      - How has open interest in a Hyperliquid coin changed over time?
      - Does open interest history include mark price, oracle price and volume?
      instructions:
      - text: Get open interest history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Pull {interval} open interest for {symbol}.
        slots:
          interval: query.interval
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/openinterest/{symbol}/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get current Hyperliquid open interest
      effect: read
      questions:
      - What is the open interest on a Hyperliquid perp right now?
      - Can I get the latest OI together with market context?
      instructions:
      - text: Get the current open interest for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show latest OI and market context for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'