Kraken · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Kraken Trading API
15 actions
15 updates
phrasing
extends
openapi/kraken-trading-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.
What the actions change
x-apievangelist-phrasing
Targets 15
$.info
$.paths['/sendorder'].post
$.paths['/editorder'].post
$.paths['/cancelorder'].post
$.paths['/cancelallorders'].post
$.paths['/cancelallordersafter'].post
$.paths['/batchorder'].post
$.paths['/0/private/AddOrder'].post
$.paths['/0/private/AddOrderBatch'].post
$.paths['/0/private/EditOrder'].post
$.paths['/0/private/AmendOrder'].post
$.paths['/0/private/CancelOrder'].post
$.paths['/0/private/CancelAll'].post
$.paths['/0/private/CancelAllOrdersAfter'].post
$.paths['/0/private/CancelOrderBatch'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Kraken Trading API
version: 1.0.0
extends: openapi/kraken-trading-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: 14
- target: $.paths['/sendorder'].post
update:
x-apievangelist-phrasing:
intent: Place a futures order
effect: write
questions:
- How do I place a limit order on a futures contract?
- Can I send a reduce-only futures order?
- Which order types are supported for futures?
instructions:
- text: Place a {orderType} futures order to {side} {size} {symbol}.
slots:
orderType: requestBody.orderType
side: requestBody.side
size: requestBody.size
symbol: requestBody.symbol
- text: Buy {size} {symbol} futures with a limit at {limitPrice}.
slots:
size: requestBody.size
symbol: requestBody.symbol
limitPrice: requestBody.limitPrice
- text: Place a futures stop to {side} {size} {symbol} at {stopPrice}.
slots:
side: requestBody.side
size: requestBody.size
symbol: requestBody.symbol
stopPrice: requestBody.stopPrice
method: generated
generated: '2026-10-01'
- target: $.paths['/editorder'].post
update:
x-apievangelist-phrasing:
intent: Modify a resting futures order
effect: write
questions:
- Can I change the size or limit price of a futures order already on the book?
- How do I adjust the stop price on my futures order?
instructions:
- text: Change futures order {orderId} to size {size}.
slots:
orderId: requestBody.orderId
size: requestBody.size
- text: Move the limit price of futures order {orderId} to {limitPrice}.
slots:
orderId: requestBody.orderId
limitPrice: requestBody.limitPrice
method: generated
generated: '2026-10-01'
- target: $.paths['/cancelorder'].post
update:
x-apievangelist-phrasing:
intent: Cancel one futures order
effect: destructive
questions:
- How do I cancel a single futures order?
- Can I cancel a futures order using its order ID?
instructions:
- text: Cancel futures order {order_id}.
slots:
order_id: requestBody.order_id
- text: Pull my resting futures order {order_id} off the book.
slots:
order_id: requestBody.order_id
method: generated
generated: '2026-10-01'
- target: $.paths['/cancelallorders'].post
update:
x-apievangelist-phrasing:
intent: Cancel all futures orders
effect: destructive
questions:
- How do I cancel every open futures order at once?
- Can I cancel all my futures orders for just one contract?
instructions:
- text: Cancel all my open futures orders.
- text: Cancel every futures order on {symbol}.
slots:
symbol: requestBody.symbol
method: generated
generated: '2026-10-01'
- target: $.paths['/cancelallordersafter'].post
update:
x-apievangelist-phrasing:
intent: Arm a futures dead man's switch
effect: destructive
questions:
- How do I make sure my futures orders get cancelled if my bot disconnects?
- Can I set a timeout after which all futures orders are cancelled?
instructions:
- text: Cancel all my futures orders after {timeout} seconds unless I re-arm.
slots:
timeout: requestBody.timeout
- text: Set the futures dead man's switch to {timeout} seconds.
slots:
timeout: requestBody.timeout
method: generated
generated: '2026-10-01'
- target: $.paths['/batchorder'].post
update:
x-apievangelist-phrasing:
intent: Place, edit and cancel futures orders in a batch
effect: write
questions:
- Can I send several futures order changes in one request?
- Is it possible to place and cancel futures orders together in one call?
instructions:
- text: 'Submit this batch of futures order instructions: {batchOrder}.'
slots:
batchOrder: requestBody.batchOrder
- text: Run futures batch {batchOrder} of places, edits and cancels in one call.
slots:
batchOrder: requestBody.batchOrder
method: generated
generated: '2026-10-01'
- target: $.paths['/0/private/AddOrder'].post
update:
x-apievangelist-phrasing:
intent: Place a spot or margin order
effect: write
questions:
- How do I place a market or limit order on a spot pair?
- Can I place an iceberg order that only shows part of its volume?
- Can I validate a spot order without actually submitting it?
instructions:
- text: Place a {ordertype} order to {type} {volume} {pair}.
slots:
ordertype: requestBody.ordertype
type: requestBody.type
volume: requestBody.volume
pair: requestBody.pair
- text: Place a limit order to {type} {volume} {pair} at {price}.
slots:
type: requestBody.type
volume: requestBody.volume
pair: requestBody.pair
price: requestBody.price
- text: Open a {leverage}x margin {ordertype} order to {type} {volume} {pair}.
slots:
leverage: requestBody.leverage
ordertype: requestBody.ordertype
type: requestBody.type
volume: requestBody.volume
pair: requestBody.pair
method: generated
generated: '2026-10-01'
- target: $.paths['/0/private/AddOrderBatch'].post
update:
x-apievangelist-phrasing:
intent: Place up to 15 spot orders at once
effect: write
questions:
- Can I submit several orders on one spot pair in a single request?
- What is the maximum number of orders in a spot batch?
instructions:
- text: Place this batch of orders {orders} on {pair}.
slots:
orders: requestBody.orders
pair: requestBody.pair
- text: Validate batch {orders} for {pair} without placing it.
slots:
orders: requestBody.orders
pair: requestBody.pair
method: generated
generated: '2026-10-01'
- target: $.paths['/0/private/EditOrder'].post
update:
x-apievangelist-phrasing:
intent: Cancel and replace a spot order
effect: write
questions:
- Can I replace an order with a new volume or price, getting a new order ID?
- How do I cancel-and-replace a spot order?
instructions:
- text: Replace order {txid} on {pair} with volume {volume}.
slots:
txid: requestBody.txid
pair: requestBody.pair
volume: requestBody.volume
- text: Cancel and replace order {txid} on {pair} at new price {price}.
slots:
txid: requestBody.txid
pair: requestBody.pair
price: requestBody.price
method: generated
generated: '2026-10-01'
- target: $.paths['/0/private/AmendOrder'].post
update:
x-apievangelist-phrasing:
intent: Amend a spot order in place
effect: write
questions:
- Can I change an order's quantity without losing its order ID?
- How do I update the limit price of a resting order in place?
instructions:
- text: Amend order {txid} to quantity {order_qty} keeping the same ID.
slots:
txid: requestBody.txid
order_qty: requestBody.order_qty
- text: Amend the limit price of order {txid} in place to {limit_price}.
slots:
txid: requestBody.txid
limit_price: requestBody.limit_price
- text: Amend the trigger price of order {cl_ord_id} to {trigger_price}.
slots:
cl_ord_id: requestBody.cl_ord_id
trigger_price: requestBody.trigger_price
method: generated
generated: '2026-10-01'
- target: $.paths['/0/private/CancelOrder'].post
update:
x-apievangelist-phrasing:
intent: Cancel one spot order
effect: destructive
questions:
- How do I cancel a single open spot order?
- Can I cancel an order by its transaction ID?
instructions:
- text: Cancel order {txid}.
slots:
txid: requestBody.txid
- text: Cancel my open spot order {txid}.
slots:
txid: requestBody.txid
method: generated
generated: '2026-10-01'
- target: $.paths['/0/private/CancelAll'].post
update:
x-apievangelist-phrasing:
intent: Cancel all open spot orders
effect: destructive
questions:
- How do I cancel every open spot order on my API key?
- Is there a quick way to pull all my spot orders off the book?
instructions:
- text: Cancel all my open spot orders.
- text: Cancel every open order using two-factor code {otp}.
slots:
otp: requestBody.otp
method: generated
generated: '2026-10-01'
- target: $.paths['/0/private/CancelAllOrdersAfter'].post
update:
x-apievangelist-phrasing:
intent: Arm a spot dead man's switch
effect: destructive
questions:
- How do I auto-cancel my spot orders if my connection drops?
- Can I disable the dead man's switch by setting the timeout to zero?
instructions:
- text: Cancel all my spot orders after {timeout} seconds unless I call again.
slots:
timeout: requestBody.timeout
- text: Arm the spot dead man's switch for {timeout} seconds.
slots:
timeout: requestBody.timeout
method: generated
generated: '2026-10-01'
- target: $.paths['/0/private/CancelOrderBatch'].post
update:
x-apievangelist-phrasing:
intent: Cancel up to 50 spot orders at once
effect: destructive
questions:
- Can I cancel a list of specific orders in one call?
- How many spot orders can I cancel in a single batch?
instructions:
- text: 'Cancel these orders in one batch: {orders}.'
slots:
orders: requestBody.orders
- text: Batch-cancel spot orders {orders}.
slots:
orders: requestBody.orders
method: generated
generated: '2026-10-01'