Gemini Trust Company · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for REST Market Data API

16 actions 16 updates phrasing extends openapi/gemini-trust-market-data-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Gemini Trust Company's API. It is a proposal applied on top of the contract, not a document Gemini Trust Company publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 16

$.info
$.paths['/v1/symbols'].get
$.paths['/v1/symbols/details/{symbol}'].get
$.paths['/v2/networks/{network}/assets'].get
$.paths['/v2/network/{token}'].get
$.paths['/v1/pubticker/{symbol}'].get
$.paths['/v1/book/{symbol}'].get
$.paths['/v1/trades/{symbol}'].get
$.paths['/v1/pricefeed'].get
$.paths['/v1/fundingamount/{symbol}'].get
$.paths['/v1/nextfundingtimestamp/{symbol}'].get
$.paths['/v1/fundingamountreport/records.xlsx'].get
$.paths['/v2/ticker/{symbol}'].get
$.paths['/v2/candles/{symbol}/{time_frame}'].get
$.paths['/v2/derivatives/candles/{symbol}/{time_frame}'].get
$.paths['/v2/fxrate/{symbol}/{timestamp}'].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 REST Market Data API
  version: 1.0.0
extends: openapi/gemini-trust-market-data-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 15
- target: $.paths['/v1/symbols'].get
  update:
    x-apievangelist-phrasing:
      intent: List all tradable symbols
      effect: read
      questions:
      - Which trading pairs can I trade on Gemini?
      - Is there a full list of symbols I can use when placing orders?
      instructions:
      - text: List every available trading symbol.
      - text: Give me all the pairs open for trading.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/symbols/details/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get order size and tick rules for a symbol
      effect: read
      questions:
      - What is the minimum order size and tick size for a trading pair?
      - How small can the quote increment be on ETHUSD?
      instructions:
      - text: Show minimum order size, tick size and quote increment for {symbol}.
        slots:
          symbol: path.symbol
      - text: Get the symbol details for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/networks/{network}/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List tokens enabled on a blockchain network
      effect: read
      questions:
      - Which tokens can my account deposit or withdraw on the Solana network?
      - Does the list of assets on a network depend on my account's permissions?
      instructions:
      - text: List the assets enabled for my account on the {network} network.
        slots:
          network: path.network
      - text: Show which tokens I can move over {network}.
        slots:
          network: path.network
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/network/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the networks a token supports
      effect: read
      questions:
      - On which blockchains can I deposit or withdraw USDC?
      - What replaced the retiring v1 network lookup for a token?
      instructions:
      - text: Show the networks available for token {token}.
        slots:
          token: path.token
      - text: Check which chains support deposits and withdrawals of {token} for my account.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/pubticker/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest bid, ask and last price
      effect: read
      questions:
      - What is the current bid, ask and last trade for BTCUSD?
      - Where do I get the basic v1 ticker with recent volume for a pair?
      instructions:
      - text: Get the v1 ticker for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show the latest bid, ask and last price on {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/book/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current order book for a symbol
      effect: read
      questions:
      - What bids and asks are resting on the book for ETHUSD right now?
      - Can I limit how many price levels of the order book are returned?
      instructions:
      - text: Show the order book for {symbol}.
        slots:
          symbol: path.symbol
      - text: Get the top {limit_bids} bids and {limit_asks} asks for {symbol}.
        slots:
          limit_bids: query.limit_bids
          limit_asks: query.limit_asks
          symbol: path.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/trades/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent public trades for a symbol
      effect: read
      questions:
      - What trades have executed recently on the BTCUSD market?
      - How far back can I pull public trade history for a pair?
      - Can I include broken trades in the results?
      instructions:
      - text: List recent market trades on {symbol}.
        slots:
          symbol: path.symbol
      - text: Show public {symbol} trades executed after trade id {since_tid}.
        slots:
          symbol: path.symbol
          since_tid: query.since_tid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/pricefeed'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the price feed for all pairs
      effect: read
      questions:
      - Can I get current prices for every pair in one request?
      - Where is a single price feed across all markets?
      instructions:
      - text: Get the price feed for all trading pairs.
      - text: Pull current prices across every market.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/fundingamount/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the funding amount for a perpetual
      effect: read
      questions:
      - What is the current funding amount on the BTC perpetual?
      - Where can I check the funding figure for a perps symbol?
      instructions:
      - text: Get the funding amount for perpetual {symbol}.
        slots:
          symbol: path.symbol
      - text: Show the current funding on {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/nextfundingtimestamp/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get when the next funding event happens
      effect: read
      questions:
      - When is the next funding time for a perpetual contract?
      - How long until funding is applied on BTCGUSDPERP?
      instructions:
      - text: Tell me the next funding timestamp for {symbol}.
        slots:
          symbol: path.symbol
      - text: Check when funding next occurs on {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/fundingamountreport/records.xlsx'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a perpetual's funding amount history
      effect: read
      questions:
      - Can I download historical funding amounts for a perpetual as a spreadsheet?
      - Do I need both a from date and a to date for the funding amount report?
      instructions:
      - text: Download the funding amount report for {symbol} from {fromDate} to {toDate}.
        slots:
          symbol: query.symbol
          fromDate: query.fromDate
          toDate: query.toDate
      - text: Export the last {numRows} funding amount records for {symbol}.
        slots:
          numRows: query.numRows
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/ticker/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the v2 ticker with recent activity
      effect: read
      questions:
      - Is there a newer ticker that summarizes recent trading activity for a pair?
      - What does the v2 ticker return for SOLUSD?
      instructions:
      - text: Get the v2 ticker for {symbol}.
        slots:
          symbol: path.symbol
      - text: Summarize recent trading activity on {symbol} from the v2 ticker.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/candles/{symbol}/{time_frame}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get price candles for a spot symbol
      effect: read
      questions:
      - Can I get one-hour OHLC candles for BTCUSD?
      - Which candle intervals are available for spot pairs?
      instructions:
      - text: Get {time_frame} candles for spot pair {symbol}.
        slots:
          time_frame: path.time_frame
          symbol: path.symbol
      - text: Chart {symbol} with {time_frame} spot candles.
        slots:
          symbol: path.symbol
          time_frame: path.time_frame
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/derivatives/candles/{symbol}/{time_frame}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get price candles for a perpetual contract
      effect: read
      questions:
      - Where do I get candle data for a perpetual futures symbol?
      - Are derivative candles limited to certain time frames?
      instructions:
      - text: Get {time_frame} candles for perpetual {symbol}.
        slots:
          time_frame: path.time_frame
          symbol: path.symbol
      - text: Pull derivatives candles on {symbol} at the {time_frame} interval.
        slots:
          symbol: path.symbol
          time_frame: path.time_frame
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/fxrate/{symbol}/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the historical FX rate at a timestamp
      effect: read
      questions:
      - What FX rate applied to a currency pair at a specific past moment?
      - Can I use historical exchange rates to chart market data in my local currency?
      instructions:
      - text: Get the FX rate for {symbol} at {timestamp}.
        slots:
          symbol: path.symbol
          timestamp: path.timestamp
      - text: Look up the historical {symbol} exchange rate as of {timestamp}.
        slots:
          symbol: path.symbol
          timestamp: path.timestamp
      method: generated
      generated: '2026-10-01'