0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive Legacy API

11 actions 11 updates phrasing extends openapi/0xarchive-legacy-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 11

$.info
$.paths['/v1/orderbook/{symbol}'].get
$.paths['/v1/orderbook/{symbol}/history'].get
$.paths['/v1/trades/{symbol}'].get
$.paths['/v1/trades/{symbol}/cursor'].get
$.paths['/v1/instruments'].get
$.paths['/v1/instruments/{symbol}'].get
$.paths['/v1/openinterest/{symbol}'].get
$.paths['/v1/openinterest/{symbol}/current'].get
$.paths['/v1/funding/{symbol}'].get
$.paths['/v1/funding/{symbol}/current'].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 Legacy API
  version: 1.0.0
extends: openapi/0xarchive-legacy-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: 10
- target: $.paths['/v1/orderbook/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order book via the deprecated route
      effect: read
      questions:
      - Does the old unprefixed order book endpoint still work?
      - Which route replaces the deprecated order book snapshot?
      instructions:
      - text: Get the order book for {symbol} from the legacy unprefixed endpoint.
        slots:
          symbol: path.symbol
      - text: Fetch a legacy order book snapshot for {symbol} at {timestamp}.
        slots:
          symbol: path.symbol
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orderbook/{symbol}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get order book history via the deprecated route
      effect: read
      questions:
      - Can I still pull order book history from the old /v1/orderbook route?
      - What replaces the deprecated order book history endpoint?
      instructions:
      - text: Get legacy order book history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Pull deprecated-route order book snapshots for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/trades/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get trades via the deprecated route
      effect: read
      questions:
      - Is the old /v1/trades endpoint still available for fills?
      - Which venue-specific route should replace the legacy trades call?
      instructions:
      - text: Get trades for {symbol} from the old unprefixed trades endpoint.
        slots:
          symbol: path.symbol
      - text: Pull legacy fills for {symbol} between {start} and {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/trades/{symbol}/cursor'].get
  update:
    x-apievangelist-phrasing:
      intent: Page trades via the deprecated cursor route
      effect: read
      questions:
      - Is there a legacy trades route that uses cursor pagination?
      - How does the old cursor trades route differ from the plain legacy trades call?
      instructions:
      - text: Page through legacy trades for {symbol} using cursor {cursor}.
        slots:
          symbol: path.symbol
          cursor: query.cursor
      - text: Use the deprecated cursor trades route for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/instruments'].get
  update:
    x-apievangelist-phrasing:
      intent: List instruments via the deprecated route
      effect: read
      questions:
      - Can I still list all instruments from the unprefixed /v1/instruments route?
      - What replaced the old instruments list?
      instructions:
      - text: List instruments from the legacy endpoint.
      - text: Pull the deprecated all-instruments list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/instruments/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one instrument via the deprecated route
      effect: read
      questions:
      - Does the legacy single-instrument lookup still return specs?
      - Which venue route replaces the old single-instrument lookup?
      instructions:
      - text: Get legacy instrument details for {symbol}.
        slots:
          symbol: path.symbol
      - text: Look up {symbol} on the deprecated instrument endpoint.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/openinterest/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get open interest history via the deprecated route
      effect: read
      questions:
      - Can I still pull open interest history from the old unprefixed route?
      - What replaces the deprecated open interest history call?
      instructions:
      - text: Get legacy open interest history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Pull deprecated-route open interest for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/openinterest/{symbol}/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get current open interest via the deprecated route
      effect: read
      questions:
      - Does the legacy current open interest endpoint still respond?
      - Which venue route should replace the old current open interest call?
      instructions:
      - text: Get the current open interest for {symbol} from the legacy route.
        slots:
          symbol: path.symbol
      - text: Check latest open interest for {symbol} using the deprecated endpoint.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/funding/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get funding history via the deprecated route
      effect: read
      questions:
      - Can I still get historical funding rates from /v1/funding?
      - Which route replaces the deprecated funding history call?
      instructions:
      - text: Get legacy funding rate history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Pull deprecated-route funding history for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/funding/{symbol}/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current funding rate via the deprecated route
      effect: read
      questions:
      - Does the old current funding rate endpoint still work?
      - What replaced the old current funding rate route?
      instructions:
      - text: Get the current funding rate for {symbol} from the legacy route.
        slots:
          symbol: path.symbol
      - text: Check latest funding for {symbol} using the deprecated endpoint.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'