0xArchive · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/0xarchive-hip-3-builder-perps-instruments-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/instruments'].get

$.paths['/v1/hyperliquid/hip3/instruments/{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 - Instruments API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-builder-perps-instruments-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/instruments'].get
  update:
    x-apievangelist-phrasing:
      intent: List available HIP-3 builder perps
      effect: read
      questions:
      - Which builder-deployed perpetuals are live on Hyperliquid?
      - Can I see mark price and open interest for all HIP-3 markets at once?
      instructions:
      - text: List all HIP-3 instruments.
      - text: Show every builder perp with its latest mark price and OI.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/instruments/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one HIP-3 instrument
      effect: read
      questions:
      - What are the latest details of a single HIP-3 market?
      - 'Do I need the builder prefix like xyz: when looking up a HIP-3 coin?'
      instructions:
      - text: Get HIP-3 instrument {symbol}.
        slots:
          symbol: path.symbol
      - text: Show latest market data for builder perp {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'