0xArchive · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/0xarchive-hip-3-builder-perps-liquidations-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/liquidations/{symbol}'].get
$.paths['/v1/hyperliquid/hip3/liquidations/{symbol}/volume'].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 - Liquidations API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-builder-perps-liquidations-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/liquidations/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get liquidation fills for a HIP-3 perp
      effect: read
      questions:
      - Which liquidations hit a builder perp since a given time?
      - Do HIP-3 liquidation results include counterparty rows?
      instructions:
      - text: Get HIP-3 liquidations for {symbol} since {start}.
        slots:
          symbol: path.symbol
          start: query.start
      - text: List liquidation fills for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip3/liquidations/{symbol}/volume'].get
  update:
    x-apievangelist-phrasing:
      intent: Get bucketed HIP-3 liquidation volume
      effect: read
      questions:
      - How much liquidation volume hit a builder perp per hour?
      - Why might long and short HIP-3 liquidation subtotals not add up to the total?
      instructions:
      - text: Get {interval} liquidation volume for {symbol} starting {start}.
        slots:
          interval: query.interval
          symbol: path.symbol
          start: query.start
      - text: Show aggregated liquidation volume for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'