Kraken · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kraken Spot REST Account Data API

13 actions 13 updates phrasing extends openapi/kraken-account-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 13

$.info
$.paths['/0/private/Balance'].post
$.paths['/0/private/BalanceEx'].post
$.paths['/0/private/TradeBalance'].post
$.paths['/0/private/OpenOrders'].post
$.paths['/0/private/ClosedOrders'].post
$.paths['/0/private/QueryOrders'].post
$.paths['/0/private/TradesHistory'].post
$.paths['/0/private/QueryTrades'].post
$.paths['/0/private/OpenPositions'].post
$.paths['/0/private/Ledgers'].post
$.paths['/0/private/QueryLedgers'].post
$.paths['/0/private/TradeVolume'].post

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 Spot REST Account Data API
  version: 1.0.0
extends: openapi/kraken-account-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: 12
- target: $.paths['/0/private/Balance'].post
  update:
    x-apievangelist-phrasing:
      intent: Get spot account asset balances
      effect: read
      questions:
      - How much of each asset do I hold in my Kraken account?
      - What is my current crypto and cash balance per asset?
      instructions:
      - text: Show the balance of every asset in my account.
      - text: Get my asset balances using two-factor code {otp}.
        slots:
          otp: requestBody.otp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/BalanceEx'].post
  update:
    x-apievangelist-phrasing:
      intent: Get balances with amounts on hold and credit
      effect: read
      questions:
      - How much of my balance is on hold in open orders?
      - Can I see credit and held amounts alongside each asset balance?
      instructions:
      - text: Show my extended balances including amounts held for trades and credit.
      - text: Get my extended balance with held amounts using two-factor code {otp}.
        slots:
          otp: requestBody.otp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/TradeBalance'].post
  update:
    x-apievangelist-phrasing:
      intent: Get margin equity and free margin
      effect: read
      questions:
      - What is my margin level and how much free margin do I have?
      - Can I see my trade balance denominated in a particular asset?
      instructions:
      - text: Show my margin equity, used margin and free margin.
      - text: Get my trade balance expressed in {asset}.
        slots:
          asset: requestBody.asset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/OpenOrders'].post
  update:
    x-apievangelist-phrasing:
      intent: List open spot orders
      effect: read
      questions:
      - Which spot orders do I have open right now?
      - Can I filter my open orders by my own user reference number?
      instructions:
      - text: List all my open orders including related trades.
      - text: Show my open orders tagged with user reference {userref}.
        slots:
          userref: requestBody.userref
      - text: Find my open order with client order ID {cl_ord_id}.
        slots:
          cl_ord_id: requestBody.cl_ord_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/ClosedOrders'].post
  update:
    x-apievangelist-phrasing:
      intent: List closed or cancelled orders
      effect: read
      questions:
      - What orders of mine have closed or been cancelled recently?
      - Is closed-order history limited to 50 results per page?
      - Can I restrict closed orders to a date range?
      instructions:
      - text: List my 50 most recent closed orders.
      - text: Show orders I closed between {start} and {end}.
        slots:
          start: requestBody.start
          end: requestBody.end
      - text: Get the next page of closed orders starting at offset {ofs}.
        slots:
          ofs: requestBody.ofs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/QueryOrders'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up specific orders by ID
      effect: read
      questions:
      - Can I check the details of particular orders if I know their transaction IDs?
      - How many order IDs can I look up in one request?
      instructions:
      - text: Get details for orders {txid}.
        slots:
          txid: requestBody.txid
      - text: Look up order {txid} and include its trades.
        slots:
          txid: requestBody.txid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/TradesHistory'].post
  update:
    x-apievangelist-phrasing:
      intent: View my spot trade history
      effect: read
      questions:
      - What trades have I executed, newest first?
      - Can I see only my trades within a specific time window?
      instructions:
      - text: Show my trade history.
      - text: List my trades between {start} and {end}.
        slots:
          start: requestBody.start
          end: requestBody.end
      - text: Show only my {type} trades.
        slots:
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/QueryTrades'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up specific trades by ID
      effect: read
      questions:
      - Can I fetch the details of a trade if I have its trade ID?
      - What price and fee did a particular fill of mine have?
      instructions:
      - text: Get details for trade {txid}.
        slots:
          txid: requestBody.txid
      - text: Look up trades {txid} with their related trade info.
        slots:
          txid: requestBody.txid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/OpenPositions'].post
  update:
    x-apievangelist-phrasing:
      intent: List open margin positions
      effect: read
      questions:
      - What margin positions do I have open on spot pairs?
      - Can I see profit and loss calculated for my open margin positions?
      instructions:
      - text: List my open margin positions.
      - text: Show margin position {txid} with profit and loss calculated.
        slots:
          txid: requestBody.txid
      - text: Show my margin positions consolidated by {consolidation}.
        slots:
          consolidation: requestBody.consolidation
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/Ledgers'].post
  update:
    x-apievangelist-phrasing:
      intent: Browse ledger entries
      effect: read
      questions:
      - Where can I see a log of deposits, withdrawals, fees and transfers on my account?
      - Can I filter ledger entries by asset or entry type?
      instructions:
      - text: List my ledger entries.
      - text: Show ledger entries for {asset} between {start} and {end}.
        slots:
          asset: requestBody.asset
          start: requestBody.start
          end: requestBody.end
      - text: List only {type} ledger entries.
        slots:
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/QueryLedgers'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up ledger entries by ID
      effect: read
      questions:
      - Can I pull up specific ledger entries if I know their ledger IDs?
      - How many ledger IDs can I query at once?
      instructions:
      - text: Get ledger entries {id}.
        slots:
          id: requestBody.id
      - text: Look up ledger {id} and include trade details.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/TradeVolume'].post
  update:
    x-apievangelist-phrasing:
      intent: Check 30-day trading volume and fee tier
      effect: read
      questions:
      - What is my 30-day trading volume on Kraken?
      - Which fee tier am I on for a given pair?
      instructions:
      - text: Show my 30-day trade volume and current fee tier.
      - text: Get my fee schedule for pair {pair}.
        slots:
          pair: requestBody.pair
      method: generated
      generated: '2026-10-01'