0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive HIP-3 - Orders API

3 actions 3 updates phrasing extends openapi/0xarchive-hip-3-orders-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/orders/{symbol}/trigger-levels'].get
$.paths['/v1/hyperliquid/hip3/orders/{symbol}/trigger-levels/history'].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 - Orders API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-orders-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/orders/{symbol}/trigger-levels'].get
  update:
    x-apievangelist-phrasing:
      intent: See pending HIP-3 stop and take-profit levels
      effect: read
      questions:
      - Where are pending stop-losses clustered on a HIP-3 market?
      - Can I bucket HIP-3 trigger orders within a price range around mid?
      instructions:
      - text: Get current trigger levels for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show trigger levels for {symbol} within {range_pct} percent of price.
        slots:
          symbol: path.symbol
          range_pct: query.range_pct
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/orders/{symbol}/trigger-levels/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get past HIP-3 trigger level snapshots
      effect: read
      questions:
      - How have pending HIP-3 stop and take-profit clusters moved over time?
      - How often are HIP-3 trigger-level snapshots taken?
      instructions:
      - text: Get trigger level history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page trigger-level snapshots for {symbol} with cursor {cursor}.
        slots:
          symbol: path.symbol
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'