Kraken · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kraken Market Data API

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

What the actions change

x-apievangelist-phrasing

Targets 16

$.info
$.paths['/instruments'].get
$.paths['/instruments/status'].get
$.paths['/tickers'].get
$.paths['/tickers/{symbol}'].get
$.paths['/orderbook'].get
$.paths['/history'].get
$.paths['/0/public/Time'].get
$.paths['/0/public/SystemStatus'].get
$.paths['/0/public/Assets'].get
$.paths['/0/public/AssetPairs'].get
$.paths['/0/public/Ticker'].get
$.paths['/0/public/OHLC'].get
$.paths['/0/public/Depth'].get
$.paths['/0/public/Trades'].get
$.paths['/0/public/Spread'].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 Kraken Market Data API
  version: 1.0.0
extends: openapi/kraken-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['/instruments'].get
  update:
    x-apievangelist-phrasing:
      intent: List futures instruments
      effect: read
      questions:
      - Which futures contracts can I trade?
      - What are the contract specifications for available futures instruments?
      instructions:
      - text: List all supported futures instruments.
      - text: Show metadata for every futures contract.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instruments/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check futures instrument trading status
      effect: read
      questions:
      - Is trading paused on any futures instruments right now?
      - Which futures contracts are currently open for trading?
      instructions:
      - text: Show the trading status of every futures instrument.
      - text: Check which futures instruments are paused.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tickers for all futures instruments
      effect: read
      questions:
      - What are the latest prices across all futures contracts?
      - Can I get every futures ticker in one call?
      instructions:
      - text: Get the latest ticker for every futures instrument.
      - text: Show current prices for all futures contracts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickers/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the ticker for one futures instrument
      effect: read
      questions:
      - What is the latest price of a specific futures contract?
      - Can I get the ticker for just one futures symbol?
      instructions:
      - text: Get the latest futures ticker for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show the current price of futures contract {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orderbook'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the order book for a futures instrument
      effect: read
      questions:
      - What does the futures order book look like for a contract?
      - How deep are bids and asks on a futures instrument?
      instructions:
      - text: Get the futures order book for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show bids and asks for futures contract {symbol}.
        slots:
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get public trade history for a futures instrument
      effect: read
      questions:
      - What trades recently happened on a futures contract?
      - Can I page futures trade history back from a given time?
      instructions:
      - text: Show recent public trades for futures contract {symbol}.
        slots:
          symbol: query.symbol
      - text: List futures trades for {symbol} before {lastTime}.
        slots:
          symbol: query.symbol
          lastTime: query.lastTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/public/Time'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the exchange server time
      effect: read
      questions:
      - What time does the Kraken server think it is?
      - How can I sync my client clock with the exchange?
      instructions:
      - text: Get the current server time.
      - text: Check the exchange clock so I can sync my client.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/public/SystemStatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Check exchange system status
      effect: read
      questions:
      - Is the exchange online or in maintenance right now?
      - Is trading currently limited to cancel-only or post-only?
      instructions:
      - text: Check the current exchange system status.
      - text: Tell me if the exchange is in maintenance.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/public/Assets'].get
  update:
    x-apievangelist-phrasing:
      intent: Get info about supported assets
      effect: read
      questions:
      - What precision and collateral value does an asset have?
      - Which assets are supported and what is their status?
      instructions:
      - text: List all supported assets.
      - text: Show asset details for {asset}.
        slots:
          asset: query.asset
      - text: List assets in class {aclass}.
        slots:
          aclass: query.aclass
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/public/AssetPairs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tradable spot pair details
      effect: read
      questions:
      - What is the minimum order size for a trading pair?
      - Which spot pairs can I trade and what are their fee schedules?
      instructions:
      - text: List all tradable spot pairs.
      - text: Show pair details for {pair}.
        slots:
          pair: query.pair
      - text: Get {info} info for pair {pair}.
        slots:
          info: query.info
          pair: query.pair
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/public/Ticker'].get
  update:
    x-apievangelist-phrasing:
      intent: Get spot ticker for trading pairs
      effect: read
      questions:
      - What are the current bid, ask and 24-hour volume for a spot pair?
      - Can I get high, low and VWAP for several pairs at once?
      instructions:
      - text: Get the spot ticker for {pair}.
        slots:
          pair: query.pair
      - text: Show last price and 24h volume for all spot pairs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/public/OHLC'].get
  update:
    x-apievangelist-phrasing:
      intent: Get OHLC candles for a spot pair
      effect: read
      questions:
      - How do I get candlestick data for a spot trading pair?
      - Which candle intervals are supported for spot OHLC data?
      instructions:
      - text: Get OHLC candles for {pair}.
        slots:
          pair: query.pair
      - text: Get {interval}-minute candles for {pair} since {since}.
        slots:
          interval: query.interval
          pair: query.pair
          since: query.since
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/public/Depth'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the order book for a spot pair
      effect: read
      questions:
      - What are the current bids and asks for a spot pair?
      - Can I limit the spot order book depth to a set number of levels?
      instructions:
      - text: Get the spot order book for {pair}.
        slots:
          pair: query.pair
      - text: Show the top {count} bids and asks for {pair}.
        slots:
          count: query.count
          pair: query.pair
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/public/Trades'].get
  update:
    x-apievangelist-phrasing:
      intent: Get recent public trades for a spot pair
      effect: read
      questions:
      - What trades just happened on a spot pair?
      - Can I fetch spot trades since a specific cursor?
      instructions:
      - text: Show recent public trades for {pair}.
        slots:
          pair: query.pair
      - text: List up to {count} trades on {pair} since {since}.
        slots:
          count: query.count
          pair: query.pair
          since: query.since
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/public/Spread'].get
  update:
    x-apievangelist-phrasing:
      intent: Get recent bid/ask spreads for a spot pair
      effect: read
      questions:
      - How wide has the bid/ask spread been on a pair lately?
      - Can I see spread snapshots since a given point?
      instructions:
      - text: Show recent spreads for {pair}.
        slots:
          pair: query.pair
      - text: Get spread snapshots for {pair} since {since}.
        slots:
          pair: query.pair
          since: query.since
      method: generated
      generated: '2026-10-01'