Kraken Account API

Accounts, positions, orders, fills

OpenAPI Specification

kraken-account-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Kraken Futures REST Account API
  version: 3.0.0
  description: OpenAPI description of the Kraken Futures (formerly Crypto Facilities) REST API v3. Covers trading (send/edit/cancel orders, batch), market data (instruments, tickers, orderbook, history), account data (accounts, open positions, open orders, fills), transfers, account history, and charts. Generated by the API Evangelist pipeline from docs.kraken.com/api/docs/futures-api/.
  contact:
    name: Kraken API Support
    url: https://support.kraken.com/
  license:
    name: Kraken Terms of Service
    url: https://www.kraken.com/legal
  x-generated-from: documentation
  x-last-validated: '2026-05-30'
servers:
- url: https://futures.kraken.com/derivatives/api/v3
  description: Kraken Futures production REST endpoint
- url: https://demo-futures.kraken.com/derivatives/api/v3
  description: Kraken Futures demo / sandbox endpoint
- url: https://colo-london.vip.futures.kraken.com/derivatives/api/v3
  description: Kraken Futures colocation endpoint (London VIP)
tags:
- name: Account
  description: Accounts, positions, orders, fills
paths:
  /accounts:
    get:
      operationId: getAccounts
      summary: Kraken Get Accounts
      description: Returns balances and margin information for every Futures account / sub-account.
      tags:
      - Account
      security:
      - futures_signature: []
      responses:
        '200':
          description: Accounts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountsResponse'
              examples:
                getAccounts200Example:
                  summary: Default getAccounts 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    serverTime: '2026-05-30T00:00:00Z'
                    error: string
                    accounts: {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /openpositions:
    get:
      operationId: getOpenPositionsFutures
      summary: Kraken Get Open Positions (Futures)
      description: Returns currently open futures positions.
      tags:
      - Account
      security:
      - futures_signature: []
      responses:
        '200':
          description: Open positions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseEnvelope'
              examples:
                getOpenPositionsFutures200Example:
                  summary: Default getOpenPositionsFutures 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    serverTime: '2026-05-30T00:00:00Z'
                    error: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /openorders:
    get:
      operationId: getOpenOrdersFutures
      summary: Kraken Get Open Orders (Futures)
      description: Returns currently open orders.
      tags:
      - Account
      security:
      - futures_signature: []
      responses:
        '200':
          description: Open orders
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseEnvelope'
              examples:
                getOpenOrdersFutures200Example:
                  summary: Default getOpenOrdersFutures 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    serverTime: '2026-05-30T00:00:00Z'
                    error: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /fills:
    get:
      operationId: getFills
      summary: Kraken Get Fills
      description: Returns recent execution fills.
      tags:
      - Account
      security:
      - futures_signature: []
      parameters:
      - name: lastFillTime
        in: query
        required: false
        schema:
          type: string
          format: date-time
        example: '2026-05-30T00:00:00Z'
      responses:
        '200':
          description: Fills
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseEnvelope'
              examples:
                getFills200Example:
                  summary: Default getFills 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    serverTime: '2026-05-30T00:00:00Z'
                    error: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /notifications:
    get:
      operationId: getNotifications
      summary: Kraken Get Notifications
      description: Returns any maintenance or risk notifications affecting the account.
      tags:
      - Account
      security:
      - futures_signature: []
      responses:
        '200':
          description: Notifications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseEnvelope'
              examples:
                getNotifications200Example:
                  summary: Default getNotifications 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    serverTime: '2026-05-30T00:00:00Z'
                    error: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    AccountsResponse:
      allOf:
      - $ref: '#/components/schemas/BaseEnvelope'
      - type: object
        properties:
          accounts:
            type: object
            additionalProperties:
              $ref: '#/components/schemas/Account'
            example: {}
    Account:
      type: object
      properties:
        type:
          type: string
          enum:
          - cashAccount
          - marginAccount
          - multiCollateralMarginAccount
          example: cashAccount
        currency:
          type: string
          example: string
        balances:
          type: object
          additionalProperties:
            type: number
          example: {}
        auxiliary:
          type: object
          properties:
            af:
              type: number
              example: 0.01
            pnl:
              type: number
              example: 0.01
            pv:
              type: number
              example: 0.01
          example: {}
        marginRequirements:
          type: object
          properties:
            im:
              type: number
              example: 0.01
            mm:
              type: number
              example: 0.01
            lt:
              type: number
              example: 0.01
            tt:
              type: number
              example: 0.01
          example: '0.01'
        triggerEstimates:
          type: object
          properties:
            im:
              type: number
              example: 0.01
            mm:
              type: number
              example: 0.01
            lt:
              type: number
              example: 0.01
            tt:
              type: number
              example: 0.01
          example: {}
    BaseEnvelope:
      type: object
      properties:
        result:
          type: string
          enum:
          - success
          - error
          example: success
        serverTime:
          type: string
          format: date-time
          example: '2026-05-30T00:00:00Z'
        error:
          type: string
          example: string
  securitySchemes:
    futures_signature:
      type: apiKey
      in: header
      name: APIKey
      description: 'Kraken Futures signs requests with two headers: `APIKey` (public key) and `Authent` (base64 HMAC-SHA512 over `postData + nonce + endpointPath` using the SHA-256 hash of those values, then HMAC-SHA512 keyed by the base64-decoded secret). A `Nonce` header carries the incrementing nonce.'