0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive Lighter - L3 Order Book API

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

$.paths['/v1/lighter/l3orderbook/{symbol}/history'].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 - L3 Order Book API
  version: 1.0.0
extends: openapi/0xarchive-lighter-l3-order-book-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/l3orderbook/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Lighter order-level L3 book snapshot
      effect: read
      questions:
      - Can I see individual resting orders and their owner accounts on Lighter?
      - How many orders per side does the Lighter L3 book return?
      instructions:
      - text: Get the Lighter L3 order book for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show resting orders on {symbol} owned by account {account}.
        slots:
          symbol: path.symbol
          account: query.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/lighter/l3orderbook/{symbol}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Lighter L3 order-level book history
      effect: read
      questions:
      - Can I pull historical order-level snapshots for a Lighter market?
      - Can I filter L3 history to one account's orders?
      instructions:
      - text: Get Lighter L3 history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Pull L3 snapshots for {symbol} at {granularity} granularity.
        slots:
          symbol: path.symbol
          granularity: query.granularity
      method: generated
      generated: '2026-09-26'