0xArchive · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/0xarchive-hip-3-builder-perps-oracle-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/oracle/external-price/{symbol}'].get

$.paths['/v1/hyperliquid/hip3/oracle/discovery-bounds/{symbol}'].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 HIP-3 Builder Perps - Oracle API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-builder-perps-oracle-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/oracle/external-price/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a HIP-3 deployer's external reference price
      effect: read
      questions:
      - What external reference price has the deployer pushed for a HIP-3 market?
      - How does a builder perp's mark price compare to its oracle feed?
      instructions:
      - text: Get the oracle external price for {symbol}.
        slots:
          symbol: path.symbol
      - text: Compare the deployer reference price and mark price for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/oracle/discovery-bounds/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get HIP-3 price discovery bounds
      effect: read
      questions:
      - What price range can a HIP-3 market trade within right now?
      - Can the full ratcheted discovery range be wider than the instantaneous bounds?
      instructions:
      - text: Get the oracle discovery bounds for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show the current price discovery limits for builder perp {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'