Kraken · Schema

OpenPositionsResponse

OpenPositionsResponse schema from Kraken Spot REST API

CryptocurrencyExchangeTradingMarket DataSpot TradingFuturesDerivativesStakingEarnNFTWebSocketFIXCustodyOTCPrime BrokerageEmbedOAuthPublic APIs
View JSON Schema on GitHub

JSON Schema

spot-rest-open-positions-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kraken/refs/heads/main/json-schema/spot-rest-open-positions-response-schema.json",
  "title": "OpenPositionsResponse",
  "description": "OpenPositionsResponse schema from Kraken Spot REST API",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "error": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Array of error strings; empty on success.",
          "example": []
        },
        "result": {
          "description": "Endpoint-specific result object.",
          "example": "string"
        }
      },
      "required": [
        "error"
      ]
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "properties": {
              "ordertxid": {
                "type": "string",
                "example": "OQCLML-BW3P3-BUCMWZ"
              },
              "posstatus": {
                "type": "string",
                "example": "string"
              },
              "pair": {
                "type": "string",
                "example": "XBTUSD"
              },
              "time": {
                "type": "number",
                "example": "2026-05-30T00:00:00Z"
              },
              "type": {
                "type": "string",
                "enum": [
                  "buy",
                  "sell"
                ],
                "example": "buy"
              },
              "ordertype": {
                "type": "string",
                "example": "limit"
              },
              "cost": {
                "type": "string",
                "example": "0.01"
              },
              "fee": {
                "type": "string",
                "example": "0.01"
              },
              "vol": {
                "type": "string",
                "example": "0.01"
              },
              "vol_closed": {
                "type": "string",
                "example": "0.01"
              },
              "margin": {
                "type": "string",
                "example": "0.01"
              },
              "value": {
                "type": "string",
                "example": "string"
              },
              "net": {
                "type": "string",
                "example": "string"
              },
              "terms": {
                "type": "string",
                "example": "string"
              },
              "rollovertm": {
                "type": "string",
                "example": "string"
              },
              "misc": {
                "type": "string",
                "example": "string"
              },
              "oflags": {
                "type": "string",
                "example": "string"
              }
            }
          },
          "example": {}
        }
      }
    }
  ]
}