Kraken · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kraken Spot REST Funding API

9 actions 9 updates phrasing extends openapi/kraken-funding-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 9

$.info
$.paths['/0/private/DepositMethods'].post
$.paths['/0/private/DepositAddresses'].post
$.paths['/0/private/DepositStatus'].post
$.paths['/0/private/WithdrawInfo'].post
$.paths['/0/private/Withdraw'].post
$.paths['/0/private/WithdrawStatus'].post
$.paths['/0/private/WithdrawCancel'].post
$.paths['/0/private/WalletTransfer'].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 Funding API
  version: 1.0.0
extends: openapi/kraken-funding-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: 8
- target: $.paths['/0/private/DepositMethods'].post
  update:
    x-apievangelist-phrasing:
      intent: List deposit methods for an asset
      effect: read
      questions:
      - What ways can I deposit a particular asset into my account?
      - Which networks can I use to fund my account with a given coin?
      instructions:
      - text: List the deposit methods for {asset}.
        slots:
          asset: requestBody.asset
      - text: Show how I can deposit {asset}.
        slots:
          asset: requestBody.asset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/DepositAddresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Get or generate a deposit address
      effect: write
      questions:
      - Where do I send crypto to deposit it into my account?
      - Can I generate a fresh deposit address instead of reusing an old one?
      instructions:
      - text: Get my {asset} deposit address for method {method}.
        slots:
          asset: requestBody.asset
          method: requestBody.method
      - text: Generate a new {asset} deposit address via {method}.
        slots:
          asset: requestBody.asset
          method: requestBody.method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/DepositStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check the status of recent deposits
      effect: read
      questions:
      - Has my recent deposit arrived yet?
      - Can I filter recent deposit statuses by asset?
      instructions:
      - text: Show the status of my recent deposits.
      - text: Check recent {asset} deposits made via {method}.
        slots:
          asset: requestBody.asset
          method: requestBody.method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/WithdrawInfo'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview withdrawal fee and limits
      effect: read
      questions:
      - What fee will I pay to withdraw an amount to a saved address?
      - Is there a limit on how much I can withdraw to a given address?
      instructions:
      - text: Show the fee and limit for withdrawing {amount} {asset} to {key}.
        slots:
          amount: requestBody.amount
          asset: requestBody.asset
          key: requestBody.key
      - text: Check withdrawal limits for {asset} to saved address {key} for {amount}.
        slots:
          asset: requestBody.asset
          key: requestBody.key
          amount: requestBody.amount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/Withdraw'].post
  update:
    x-apievangelist-phrasing:
      intent: Withdraw crypto or cash to a saved address
      effect: write
      questions:
      - How do I withdraw funds to an address I already set up?
      - Can I cap the fee I'm willing to pay on a withdrawal?
      instructions:
      - text: Withdraw {amount} {asset} to saved address {key}.
        slots:
          amount: requestBody.amount
          asset: requestBody.asset
          key: requestBody.key
      - text: Withdraw {amount} {asset} to {key} only if the fee is at most {max_fee}.
        slots:
          amount: requestBody.amount
          asset: requestBody.asset
          key: requestBody.key
          max_fee: requestBody.max_fee
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/WithdrawStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check the status of recent withdrawals
      effect: read
      questions:
      - Has my withdrawal been processed yet?
      - Can I see recent withdrawals for just one asset?
      instructions:
      - text: Show the status of my recent withdrawals.
      - text: Check recent {asset} withdrawals made via {method}.
        slots:
          asset: requestBody.asset
          method: requestBody.method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/WithdrawCancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending withdrawal
      effect: destructive
      questions:
      - Can I stop a withdrawal that hasn't gone out yet?
      - How do I cancel a pending withdrawal using its reference ID?
      instructions:
      - text: Cancel pending {asset} withdrawal {refid}.
        slots:
          asset: requestBody.asset
          refid: requestBody.refid
      - text: Request cancellation of withdrawal reference {refid} for {asset}.
        slots:
          refid: requestBody.refid
          asset: requestBody.asset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/WalletTransfer'].post
  update:
    x-apievangelist-phrasing:
      intent: Move funds from Spot to Futures wallet
      effect: write
      questions:
      - How do I fund my futures wallet from my spot balance?
      - Can I move an asset between my spot and futures wallets?
      instructions:
      - text: Transfer {amount} {asset} from {from} to {to}.
        slots:
          amount: requestBody.amount
          asset: requestBody.asset
          from: requestBody.from
          to: requestBody.to
      - text: Move {amount} {asset} from my Spot wallet ({from}) to Futures ({to}).
        slots:
          amount: requestBody.amount
          asset: requestBody.asset
          from: requestBody.from
          to: requestBody.to
      method: generated
      generated: '2026-10-01'