Kraken · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kraken Futures REST Account API

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

$.info

$.paths['/accounts'].get

$.paths['/openpositions'].get

$.paths['/openorders'].get

$.paths['/fills'].get

$.paths['/notifications'].get

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 Futures REST Account API
  version: 1.0.0
extends: openapi/kraken-account-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: 5
- target: $.paths['/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: View balances and margin across futures accounts
      effect: read
      questions:
      - What are the balances and margin levels across all my Kraken futures accounts?
      - Can I see margin information for each futures sub-account in one response?
      instructions:
      - text: Show balances and margin for every one of my futures accounts.
      - text: Summarize available margin across my futures sub-accounts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/openpositions'].get
  update:
    x-apievangelist-phrasing:
      intent: List open futures positions
      effect: read
      questions:
      - Which futures positions do I currently have open?
      - How large is each of my open futures positions right now?
      instructions:
      - text: List my currently open futures positions.
      - text: Show the size and side of each futures position I hold.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/openorders'].get
  update:
    x-apievangelist-phrasing:
      intent: List open futures orders
      effect: read
      questions:
      - What futures orders are still resting on the book for my account?
      - Do I have any unfilled futures orders waiting right now?
      instructions:
      - text: List my open futures orders.
      - text: Show every futures order of mine that has not filled yet.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fills'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent futures execution fills
      effect: read
      questions:
      - Which of my futures orders were filled recently?
      - Can I get only fills that happened before a certain fill time?
      instructions:
      - text: Show my recent futures fills.
      - text: List my futures fills going back from {lastFillTime}.
        slots:
          lastFillTime: query.lastFillTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: Check maintenance and risk notifications
      effect: read
      questions:
      - Are there any maintenance or risk notices affecting my futures account?
      - What platform notifications should I be aware of before trading futures?
      instructions:
      - text: Check for maintenance or risk notifications on my futures account.
      - text: Show any current futures platform notices.
      method: generated
      generated: '2026-10-01'