Kraken · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kraken Spot REST Earn API

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

$.info
$.paths['/0/private/Earn/Allocate'].post
$.paths['/0/private/Earn/Deallocate'].post
$.paths['/0/private/Earn/AllocateStatus'].post
$.paths['/0/private/Earn/DeallocateStatus'].post
$.paths['/0/private/Earn/Strategies'].post
$.paths['/0/private/Earn/Allocations'].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 Earn API
  version: 1.0.0
extends: openapi/kraken-earn-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: 6
- target: $.paths['/0/private/Earn/Allocate'].post
  update:
    x-apievangelist-phrasing:
      intent: Put funds into an Earn strategy
      effect: write
      questions:
      - How do I start earning rewards by staking an asset?
      - Can I allocate a specific amount to an Earn strategy?
      instructions:
      - text: Allocate {amount} to Earn strategy {strategy_id}.
        slots:
          amount: requestBody.amount
          strategy_id: requestBody.strategy_id
      - text: Stake {amount} in strategy {strategy_id}.
        slots:
          amount: requestBody.amount
          strategy_id: requestBody.strategy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/Earn/Deallocate'].post
  update:
    x-apievangelist-phrasing:
      intent: Withdraw funds from an Earn strategy
      effect: write
      questions:
      - How do I unstake funds from an Earn strategy?
      - When do deallocated funds come back to my trading balance?
      instructions:
      - text: Deallocate {amount} from Earn strategy {strategy_id}.
        slots:
          amount: requestBody.amount
          strategy_id: requestBody.strategy_id
      - text: Unstake {amount} from strategy {strategy_id} back to my balance.
        slots:
          amount: requestBody.amount
          strategy_id: requestBody.strategy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/Earn/AllocateStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check status of a pending Earn allocation
      effect: read
      questions:
      - Has my last Earn allocation finished processing?
      - Is my staking request still pending?
      instructions:
      - text: Check whether my last allocation to strategy {strategy_id} is still in progress.
        slots:
          strategy_id: requestBody.strategy_id
      - text: Get the allocation status for Earn strategy {strategy_id}.
        slots:
          strategy_id: requestBody.strategy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/Earn/DeallocateStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check status of a pending Earn deallocation
      effect: read
      questions:
      - Has my unstaking request completed yet?
      - Is my last deallocation from an Earn strategy still pending?
      instructions:
      - text: Check whether my last deallocation from strategy {strategy_id} has completed.
        slots:
          strategy_id: requestBody.strategy_id
      - text: Get the deallocation status for Earn strategy {strategy_id}.
        slots:
          strategy_id: requestBody.strategy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/Earn/Strategies'].post
  update:
    x-apievangelist-phrasing:
      intent: Browse available Earn strategies
      effect: read
      questions:
      - Which staking and Earn options can I use, and what APRs do they offer?
      - Can I see only Earn strategies for one asset or lock type?
      instructions:
      - text: List the Earn strategies available to me.
      - text: Show Earn strategies for {asset}.
        slots:
          asset: requestBody.asset
      - text: List {lock_type} Earn strategies.
        slots:
          lock_type: requestBody.lock_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/0/private/Earn/Allocations'].post
  update:
    x-apievangelist-phrasing:
      intent: View my current Earn allocations and rewards
      effect: read
      questions:
      - How much do I currently have staked and what rewards have I earned?
      - Which Earn strategies am I allocated to right now?
      instructions:
      - text: Show my current Earn allocations and rewards.
      - text: List my Earn allocations using two-factor code {otp}.
        slots:
          otp: requestBody.otp
      method: generated
      generated: '2026-10-01'