0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive Lighter - Liquidations API

3 actions 3 updates phrasing extends openapi/0xarchive-lighter-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/lighter/liquidations/{symbol}'].get

$.paths['/v1/lighter/liquidations/{symbol}/volume'].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 Lighter - Liquidations API
  version: 1.0.0
extends: openapi/0xarchive-lighter-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/lighter/liquidations/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Lighter liquidation events
      effect: read
      questions:
      - Which liquidations happened on a Lighter market recently?
      - Is Lighter liquidation data backfilled before live capture began?
      instructions:
      - text: Get Lighter liquidations for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Page Lighter liquidation events for {symbol} with cursor {cursor}.
        slots:
          symbol: path.symbol
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/lighter/liquidations/{symbol}/volume'].get
  update:
    x-apievangelist-phrasing:
      intent: Get bucketed Lighter liquidation volume
      effect: read
      questions:
      - How much long and short liquidation volume hit a Lighter market per hour?
      - How many credits does the Lighter liquidation volume route cost?
      instructions:
      - text: Get {interval} Lighter liquidation volume for {symbol}.
        slots:
          interval: query.interval
          symbol: path.symbol
      - 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'