0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive Lighter - Convenience API

4 actions 4 updates phrasing extends openapi/0xarchive-lighter-convenience-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 4

$.info

$.paths['/v1/lighter/freshness/{symbol}'].get

$.paths['/v1/lighter/summary/{symbol}'].get

$.paths['/v1/lighter/prices/{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 Lighter - Convenience API
  version: 1.0.0
extends: openapi/0xarchive-lighter-convenience-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: 3
- target: $.paths['/v1/lighter/freshness/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check how fresh a Lighter coin's data is
      effect: read
      questions:
      - When was each data type last updated for a Lighter coin?
      - Is the Lighter archive for a coin lagging?
      instructions:
      - text: Check Lighter data freshness for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show when Lighter data last updated for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/lighter/summary/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-call Lighter market summary
      effect: read
      questions:
      - Can I get a Lighter coin's price, funding and OI in one call?
      - What does the Lighter market summary include?
      instructions:
      - text: Get the Lighter market summary for {symbol}.
        slots:
          symbol: path.symbol
      - text: Give me price, funding and open interest for {symbol} on Lighter.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/lighter/prices/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Lighter mark and oracle price history
      effect: read
      questions:
      - Can I get only mark and oracle prices over time on Lighter?
      - Is there a lightweight Lighter price series at a chosen interval?
      instructions:
      - text: Get Lighter price history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Show {interval} Lighter oracle prices for {symbol}.
        slots:
          interval: query.interval
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'