Kraken · Schema

EarnStrategy

EarnStrategy schema from Kraken Spot REST API

CryptocurrencyExchangeTradingMarket DataSpot TradingFuturesDerivativesStakingEarnNFTWebSocketFIXCustodyOTCPrime BrokerageEmbedOAuthPublic APIs

Properties

Name Type Description
id string
asset string
lock_type object
apr_estimate object
user_min_allocation string
user_cap string
allocation_fee string
deallocation_fee string
auto_compound object
yield_source object
can_allocate boolean
can_deallocate boolean
View JSON Schema on GitHub

JSON Schema

spot-rest-earn-strategy-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-earn-strategy-schema.json",
  "title": "EarnStrategy",
  "description": "EarnStrategy schema from Kraken Spot REST API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "OQCLML-BW3P3-BUCMWZ"
    },
    "asset": {
      "type": "string",
      "example": "XBT"
    },
    "lock_type": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "example": "buy"
        },
        "bonding_period": {
          "type": "integer",
          "example": 1
        },
        "unbonding_period": {
          "type": "integer",
          "example": 1
        },
        "payout_frequency": {
          "type": "integer",
          "example": 1
        }
      },
      "example": {}
    },
    "apr_estimate": {
      "type": "object",
      "properties": {
        "low": {
          "type": "string",
          "example": "string"
        },
        "high": {
          "type": "string",
          "example": "string"
        }
      },
      "example": {}
    },
    "user_min_allocation": {
      "type": "string",
      "example": "string"
    },
    "user_cap": {
      "type": "string",
      "example": "string"
    },
    "allocation_fee": {
      "type": "string",
      "example": "string"
    },
    "deallocation_fee": {
      "type": "string",
      "example": "string"
    },
    "auto_compound": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "example": "buy"
        },
        "default": {
          "type": "boolean",
          "example": true
        }
      },
      "example": {}
    },
    "yield_source": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "example": "buy"
        }
      },
      "example": {}
    },
    "can_allocate": {
      "type": "boolean",
      "example": true
    },
    "can_deallocate": {
      "type": "boolean",
      "example": true
    }
  }
}