0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive HIP-3 Builder Perps - Breadth API

3 actions 3 updates phrasing extends openapi/0xarchive-hip-3-builder-perps-breadth-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/hip3/breadth/above-vwap/current'].get
$.paths['/v1/hyperliquid/hip3/breadth/above-vwap'].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 HIP-3 Builder Perps - Breadth API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-builder-perps-breadth-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/breadth/above-vwap/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get current HIP-3 breadth above session VWAP
      effect: read
      questions:
      - What share of HIP-3 markets is trading above session VWAP right now?
      - Is the HIP-3 builder-perp market broadly bullish today?
      instructions:
      - text: Get the current HIP-3 breadth above VWAP.
      - text: Show the latest percentage of builder perps above their UTC-session VWAP.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/breadth/above-vwap'].get
  update:
    x-apievangelist-phrasing:
      intent: Get HIP-3 breadth above VWAP history
      effect: read
      questions:
      - How has HIP-3 market breadth above VWAP changed over the past week?
      - Can I get breadth snapshots at an hourly interval?
      instructions:
      - text: Get HIP-3 breadth-above-VWAP history from {start} to {end}.
        slots:
          start: query.start
          end: query.end
      - text: Pull {interval} breadth snapshots for HIP-3 markets.
        slots:
          interval: query.interval
      method: generated
      generated: '2026-09-26'